Configure Juxl with Juxl Hub Auth

We assume the following

  • Multiple user use Jupyter Lab with Juxl

  • Jupyter Lab is running within a Jupyter Hub context

  • Juxl Hub Auth is deployed at https://my.juxlHubAuth.com:3333

For this setting, the recommended approach is to:

  • configure Juxl using the overrides.json

  • use the JUPYTERHUB_API_TOKEN environment variable for authentication

  • use https:// connection

Using the overrides.json ensures that Juxl is configured without interfering with the user settings. This is especially relevant if for example the user home directoy is mounted by an external service. By using the JUPYTERHUB_API_TOKEN as the authentication method, we authenticate against Juxl Hub Auth using the JUPYTERHUB_API_TOKEN of the current user. See Why Juxl Hub Auth ? for more information about security. Finally by explicitly using the https:// protocol to communicate with Juxl Hub Auth, we use a enrypted connection to tranmit xApi statements to Juxl Hub Auth.

Content of overrides.json:

{
  "@juxl/juxl-extension:juxl": {
    "agent": "pseudo-anonymous",
    "lrs": {
      "url": "https://my.juxlHubAuth.com:3333",
      "authentication": {
        "python-environment":"JUPYTERHUB_API_TOKEN"
      }
    }
  }
}