Install Datalore On-Premises in Docker containers using Docker Compose

Step 1. Get the docker-compose file

1. Download and open the docker-compose.yaml file from the datalore-configs repository on GitHub.

2. Replace the values of DB_PASSWORD and POSTGRES_PASSWORD properties with the same string value. This string will serve as your database password, so keep it secret.

Step 2. (Optional) Configure a custom domain

1. By default, Datalore is only accessible at 127.0.0.1. To use a custom domain, add the desired URL without a trailing slash as the DATALORE_PUBLIC_URL parameter in the docker-compose.yaml file.

   For example, if you want to use https://datalore.yourcompany.com, add the following block:

   services: datalore: ... environment: ... # Make sure the URL doesn't have a trailing slash DATALORE_PUBLIC_URL: "https://datalore.yourcompany.com"

2. If you have not already, configure DNS for this domain.

Step 3. (Optional) Use an external postgres database

Datalore requires a PostgreSQL database (version 15 or higher). By default, a single-instance PostgreSQL database is included in Datalore’s Docker Compose configuration file.

To use an external database:

1. In the docker-compose.yaml file, add the following variables under environment:

   environment: ... DB_USER: "<database_user>" DB_URL: "jdbc:postgresql://[database_host]:[database_port]/[database_name]"

2. Remove the postgresql block:

   postgresql: image: jetbrains/datalore-postgres:2024.4 expose: [ "5432" ] networks: - datalore-backend-network volumes: - "postgresql-data:/var/lib/postgresql/data" environment: POSTGRES_PASSWORD: "changeme"

3. Remove the following line from the volumes section:

   postgresql-data: { }

Step 4. (Optional) Enable an email allowlist

You can enable an allowlist for new user registration so that only users with email addresses included in the allowlist can register. To do that:

1. In the docker-compose.yaml file, add the following parameter:

   environment: EMAIL_ALLOWLIST_ENABLED: "true"

The Email allowlist tab will be available in the Admin panel.

Step 5. (Optional, Hub-only) Enable user filtration based on Hub group membership

By default, all Hub users can register in Datalore unless you disable registration in the Admin panel.

To grant Datalore access only to members of a specific Hub group:

1. In the docker-compose.yaml file, add the following parameter:

   environment: HUB_ALLOWLIST_GROUP: 'group_name'

Step 6. (Optional) Configure notebook code import limit

You can configure the limit of notebook code import by setting your own value in bytes. To do that:

1. In the docker-compose.yaml file, add the following parameter:

   environment: VFS_MAX_IMPORT_SOURCE_LENGTH: '<length_in_bytes>'

Step 7. Start Datalore

1. Run the following command and wait for Datalore to start up:

   docker compose up

2. Go to http://127.0.0.1:8080/ or the custom URL you configured in Step 2 and register the first user. This user will automatically receive the Super Admin role.

3. Add your license. To do that, click your avatar at the top right, select Admin panel | License and enter your license key.

   

Required configuration steps

1. Configure agents: Customize how your agents work to manage your computational resources.

2. Enable GPU machines: Enable GPU machines in your installation.

3. Manage users: Create and manage users and viewers.

4. Configure plans: Customize resource usage among your Datalore users.

Optional configuration steps

• Set up JetBrains Hub: Integrate an authentication service.

• Customize or update environment: Build custom images tailored for your needs.

• Enable gift codes: Activate the service for generating and processing gift codes.

• Enable the email service: Activate email notifications.

• Enable audit logging: Turn on extended activity logging for Datalore users.