Skip to content

This page shows you how to install the two parts of Sluice: the server with its web UI, and the sluice CLI. Both are the same binary. The server needs Postgres. The CLI needs only the URL of a server and an API token.

You want Use
Sluice on your computer or on one host Docker Compose. It starts Sluice and Postgres.
Sluice with a Postgres database that you already have Docker.
Sluice in a Kubernetes cluster Helm.
The CLI for a terminal, a CI job or a coding agent The install script.

The releases are on GitHub. The images are ghcr.io/alternayte/sluice and ghcr.io/alternayte/sluice-uv. The sluice-uv image also has bash, uv, Python 3.12 and bun, so script tasks run on the process executor inside the server.

You need Docker with the Compose plugin and a free port 8080. You need no checkout of the repository.

  1. Download the compose file into an empty directory:

    Terminal window
    mkdir sluice/ && cd sluice/
    curl -fsSLO https://raw.githubusercontent.com/alternayte/sluice/main/deploy/compose/compose.yml
  2. Write the two required values to a .env file next to it. Keep this file: Sluice needs the same master key at each start to read the secrets that it stores.

    Terminal window
    printf 'SLUICE_BOOTSTRAP_ADMIN_PASSWORD=%s\n' 'change-me-now-1' > .env
    printf 'SLUICE_MASTER_KEYS=k1:%s\n' "$(openssl rand -base64 32)" >> .env
  3. Start Sluice and Postgres:

    Terminal window
    docker compose up -d
  4. Check that the server is ready. The answer shows "status":"ok".

    Terminal window
    curl -s http://localhost:8080/readyz
  5. Open http://localhost:8080. Sign in as admin@local.test with the password of step 2.

The compose file uses the image ghcr.io/alternayte/sluice-uv:latest. To pin a release, add a line such as SLUICE_IMAGE=ghcr.io/alternayte/sluice-uv:0.5.1 to .env. Deploy with Docker Compose lists the other variables and shows how to upgrade.

The server needs a Postgres database. The first migration runs CREATE EXTENSION IF NOT EXISTS citext, so the database user needs the right to create this extension.

Terminal window
docker run -d --name sluice -p 8080:8080 \
-e SLUICE_DATABASE_URL='postgres://sluice:secret@db.example.com:5432/sluice?sslmode=require' \
-e SLUICE_PUBLIC_URL=http://localhost:8080 \
-e SLUICE_BOOTSTRAP_ADMIN_EMAIL=admin@example.com \
-e SLUICE_BOOTSTRAP_ADMIN_PASSWORD='change-me-now-1' \
-e SLUICE_MASTER_KEYS="k1:$(openssl rand -base64 32)" \
ghcr.io/alternayte/sluice-uv:0.5.1

Keep the value of SLUICE_MASTER_KEYS. The server applies the migrations at start. Environment variables lists every setting.

The chart is in the OCI registry of GitHub. It needs a Postgres database and three Secrets: the database URL, the master keys and the first admin.

Terminal window
helm install sluice oci://ghcr.io/alternayte/charts/sluice --version 0.5.1 \
--namespace sluice-system -f values.yaml

Deploy on Kubernetes with Helm shows the Secrets, the values file and the ingress.

Run the install script. It downloads the latest release for your system, checks it against the published checksum, and puts sluice in /usr/local/bin:

Terminal window
curl -fsSL https://raw.githubusercontent.com/alternayte/sluice/main/install.sh | sh

The script asks for your password when /usr/local/bin needs sudo. Without sudo it uses ~/.local/bin. Two variables change what it does:

Variable Effect
SLUICE_VERSION Installs this release, for example 0.5.1.
SLUICE_BIN_DIR Puts the binary in this directory.
Terminal window
curl -fsSL https://raw.githubusercontent.com/alternayte/sluice/main/install.sh | SLUICE_VERSION=0.5.1 SLUICE_BIN_DIR="$HOME/bin" sh

Check the installation, then point the CLI at a server with an API token. Create the token on Settings → API tokens.

Terminal window
sluice version
export SLUICE_URL=http://localhost:8080
export SLUICE_TOKEN=slu_paste-your-token-here
sluice flows list