Datalore 2024.5 Help

Enable SSO for Docker deployment

You can use JetBrains Hub (further in the article referred to as Hub) for user authentication and user management in Datalore. Hub supports most popular auth modules.

This procedure explains how to enable Hub for Datalore On-Premises installed using Docker.

Run Hub

  1. Add the following volumes to your docker-compose.yaml file:

    volumes: hub-data: { } hub-conf: { } hub-logs: { } hub-backups: { }

  2. Add the following service to your docker-compose.yaml file:

    services: ... hub: image: jetbrains/hub:2024.3.47197 ports: - "8082:8080" networks: - datalore-backend-network volumes: - "hub-data:/opt/hub/data" - "hub-conf:/opt/hub/conf" - "hub-logs:/opt/hub/logs" - "hub-backups:/opt/hub/backups"

  3. Run docker compose up hub to run Hub only (we assume that Datalore is not running at the moment).

  4. Check the docker output (use the docker compose logs hub command if running in the detached mode). It should contain a line like this:

    JetBrains Hub 2024.3 Configuration Wizard will listen inside container on {0.0.0.0:8080}/ after start and can be accessed by URL [http://<put-your-docker-HOST-name-here>:<put-host-port-mapped-to-container-port-8080-here>/?wizard_token=pPXTShp4NXceXqGYzeAq].

    Copy the wizard_token value to the clipboard.

  5. Go to http://127.0.0.1:8082/ and insert the token from the previous step into the Token field.

  6. Click the Log in button.

  7. Click the Set Up link.

  8. Generate a URL (referred to as HUB_ROOT_URL later) to access Hub from Datalore. Consider the following:

    • The URL must be accessible from both the machine you run Docker Compose on and the browser (by the end users of your Datalore installation).

    • The URL must point to the / path of your Hub installation, i.e. http://127.0.0.1:8080/ inside the container where Hub is running. If you haven't remapped any ports, it's also http://127.0.0.1:8082/ on the machine where Docker compose in running.

    • How you serve such a URL depends on the specifics of your infrastructure configuration. For example, if the machine you run Docker compose on is accessible from the Internet, you may just use its IP address: http://IP_ADDRESS:8082/.

  9. In Base URL, enter HUB_ROOT_URL. Do not change the Application Listen Port setting.

  10. Click the Next button.

  11. Configure the admin account by setting the admin password.

  12. Click the Next button.

  13. Click the Finish button and wait for Hub to start.

Configure Hub

Go to HUB_ROOT_URL and log into Hub via admin account.

Configure the Datalore service

  1. Create one more URL (referred to as DATALORE_ROOT_URL later) to access Datalore. Consider the following:

    • The URL must be accessible from the browser (by the end users of your Datalore installation).

    • The URL must point to the / path of your Datalore installation, i.e. http://127.0.0.1:8080/ inside the container where Datalore will be launched.

    • How you serve such a URL depends on the specifics of your infrastructure configuration. For example, if the machine you run Docker compose on is accessible from the Internet, you can just use its IP address.

  2. Go to Services (${HUB_ROOT_URL}/hub/services) and click the New service button. Use the name datalore and enter DATALORE_ROOT_URL in Home URL.

  3. Copy the ID field value and save it somewhere: it is used when configuring Datalore ($HUB_DATALORE_SERVICE_ID property).

  4. Click the Change... button next to the Secret label.

  5. Copy the generated secret and save it somewhere: it will be used when configuring Datalore ($HUB_DATALORE_SERVICE_SECRET property).

  6. Click the Change secret button.

  7. Enter DATALORE_ROOT_URL in the Base URLs field.

  8. Enter the line /api/hub/openid/login in the Redirect URIs field.

  9. Click the Trust Service button in the upper right corner.

  10. Click the Save button.

Create a Hub token

  1. Go to Users (${HUB_ROOT_URL}/hub/users).

  2. Click your admin username.

  3. Switch to the Account Security tab.

  4. Click the New token... button.

  5. Add Hub and Datalore into Scope. You can use any Name. Click the Create button. Copy the token (with the perm: prefix) and save it somewhere. It will be used when configuring Datalore ($HUB_PERM_TOKEN property).

(Optional) Force email verification

Datalore uses user emails from Hub; so it is recommended to force email verification in Hub. Users with unverified emails will not be able to use Datalore.

  1. Configure the SMTP server:

    • Go to SMTP (${HUB_ROOT_URL}/hub/smtp-settings).

    • Click the Configure SMTP server... button.

    • Configure your SMTP server parameters.

    • Click the Save button.

    • Click the Enable notifications button.

    • (Optional) To make sure your configuration is working, click the Send Test message button.

  2. Enable email verification:

    • Go to Auth Modules (${HUB_ROOT_URL}/hub/authmodules).

    • Open the Common settings page.

    • Enable the Email verification option.

    • Click the Save button.

  3. Set and verify an admin user email:

    • Go to Users (${HUB_ROOT_URL}/hub/users).

    • Click your admin username.

    • Set an email in the Email field.

    • Click the Save button.

    • Click the Send verification email link.

    • Find the verification email in your inbox and click the Verify email address button.

(Optional) Enable auth modules

  1. Go to Auth Modules (${HUB_ROOT_URL}/hub/authmodules).

  2. Add or remove auth modules (for example, Google auth, GitHub auth, LDAP, and so on). Find more details here.

Configure the Datalore service

Edit the docker-compose.yaml file. Define the following environment values under

services: datalore: environment:

HUB_PUBLIC_BASE_URL

Base public (accessible via browser) URL of your Hub installation (${HUB_ROOT_URL}/hub from the Install Hub section, for example, https://hub.your.domain/hub).

HUB_INTERNAL_BASE_URL

URL that Datalore uses internally to access Hub. By default, set it to "http://hub:8080/hub".

HUB_DATALORE_SERVICE_ID

ID of the Datalore service in Hub (see Configure the Datalore service).

HUB_DATALORE_SERVICE_SECRET

Token of the Datalore service in Hub (see Configure the Datalore service).

HUB_PERM_TOKEN

Token for accessing Datalore and Hub scopes (see Create a Hub token).

HUB_FORCE_EMAIL_VERIFICATION

Used to specify whether email verification is required from the Datalore user. Set to false here if you didn't configure an SMTP server.

Example

services: datalore: environment: ... HUB_PUBLIC_BASE_URL: "http://127.0.0.1:8082/hub" HUB_INTERNAL_BASE_URL: "http://hub:8080/hub" HUB_DATALORE_SERVICE_ID: "9030674b-2679-495a-b606-c554384f42a3" HUB_DATALORE_SERVICE_SECRET: "sHCpaPQfPWco" HUB_PERM_TOKEN: "perm:YWRtaW4=.NDUtMA==.MBJEauHYuzg9nSXS6d1FkJ93zZcZvT" HUB_FORCE_EMAIL_VERIFICATION: "false"
Last modified: 27 November 2024
Enable SSO for Kubernetes deploymentUpgrade Hub