Skip to main content

Local machine

This article provides step-by-step instructions for running Datagrok on your local machine using Docker Compose. The install script downloads the canonical compose file (docker/localhost.docker-compose.yaml), pulls the Datagrok services listed there, and brings them up under a single project — including in-cluster PostgreSQL, RabbitMQ, grok_pipe, grok_spawner, grok_connect, and the Jupyter Kernel Gateway.

The script installs the latest stable release. It reads which release that image was built from and takes the compose file from the same branch, because the compose file and the images it starts are versioned together — see configuration is versioned with the image.

Hardware requirements

Minimal hardware requirements: 40 GB of free disk space, 2 CPUs, 4 GB RAM.

For server-side scripting and the Jupyter Kernel Gateway, we recommend 60 GB of free disk space, 4 CPUs, 8 GB RAM.

Start Datagrok​

  1. Install and launch the latest Docker Desktop application for your operating system:

  2. Download the installation script based on your operating system:

    Right-click on this link and select "Save Link As..."

  3. Run the downloaded script to start the installation:

    Double-click the downloaded script to begin the installation.

Install a specific version​

DATAGROK_VERSION accepts any tag of datagrok/datagrok. It defaults to latest.

ValueInstalls
latestNewest stable release. Follows each release automatically.
1.27.7That exact release.
1.28.0-rcThat release candidate.
bleeding-edgeNewest build from master. Unreleased, for evaluation only.
set DATAGROK_VERSION=1.27.6
datagrok-install-local.cmd

Whichever tag you pick, the script asks the image which branch it was built from and takes the compose file from there, so the configuration always matches the images — including for moving tags like latest, where the tag name alone doesn't say which release it is. Run version to see what a tag currently resolves to:

DATAGROK_VERSION=latest bash datagrok-install-local.sh version
# latest -> 1.27.7 (release/1.27.7)

If the compose file already on disk belongs to a different release, the script refuses to start and tells you to delete it. That check is what prevents a newer compose file from being run against older images, which makes the server fail on startup.

Log in to Datagrok​

  1. Once the server is up and running, open your browser and go to http://localhost:8080.
  2. On the login page, use the following credentials to login:
    • Login or Email: admin
    • Password admin
note

If you see the message Datagrok server is unavailable, wait for approximately 1 minute for the server to start, and then reload the page.

Shut down Datagrok​

Use the following command from the directory where you downloaded the installation script:

datagrok-install-local.cmd stop

All the data is saved in the Docker volumes.