Docker
A supplied docker image lets you deploy a server as a container. The “LATEST TAGGED RELEASE” can be found on the releases page.
CONFIG="$HOME/.config/atuin"mkdir "$CONFIG"chown 1000:1000 "$CONFIG"docker run -d -v "$CONFIG:/config" ghcr.io/atuinsh/atuin:<LATEST TAGGED RELEASE> startDocker Compose
Section titled “Docker Compose”You can also host your own Atuin server with the prebuilt docker image using the supplied docker-compose file.
Create a docker-compose.yml:
services: atuin: restart: always image: ghcr.io/atuinsh/atuin:<LATEST TAGGED RELEASE> command: start volumes: - './config:/config' ports: - 8888:8888 environment: ATUIN_HOST: '0.0.0.0' ATUIN_OPEN_REGISTRATION: 'true' ATUIN_DB_URI: postgres://${ATUIN_DB_USERNAME}:${ATUIN_DB_PASSWORD}@db/${ATUIN_DB_NAME} RUST_LOG: info,atuin_server=debug depends_on: - db db: image: postgres:18 restart: unless-stopped volumes: # Don't remove permanent storage for index database files! - './database:/var/lib/postgresql/' environment: POSTGRES_USER: ${ATUIN_DB_USERNAME} POSTGRES_PASSWORD: ${ATUIN_DB_PASSWORD} POSTGRES_DB: ${ATUIN_DB_NAME} TZ: Europe/London PGTZ: Europe/LondonThe ATUIN_* variables under environment override the same keys in
./config/server.toml. An empty one counts as unset.
Create a .env file next to docker-compose.yml with contents like this:
ATUIN_DB_NAME=atuinATUIN_DB_USERNAME=atuin# Choose your own secure password. Stick to [A-Za-z0-9.~_-]ATUIN_DB_PASSWORD=really-insecureStart the services using docker compose:
mkdir configchown 1000:1000 configdocker compose up -dUsing systemd to manage your Atuin server
Section titled “Using systemd to manage your Atuin server”The following systemd unit file can be used to manage your docker-compose managed service:
[Unit]Description=Docker Compose Atuin ServiceRequires=docker.serviceAfter=docker.service
[Service]# Where the docker-compose file is locatedWorkingDirectory=/srv/atuin-serverExecStart=/usr/bin/docker compose upExecStop=/usr/bin/docker compose downTimeoutStartSec=0Restart=on-failureStartLimitBurst=3
[Install]WantedBy=multi-user.targetStart and enable the service with:
systemctl enable --now atuinCheck if it’s running with:
systemctl status atuinCreating backups of the Postgres database
Section titled “Creating backups of the Postgres database”You can add another service to your docker-compose.yml file to have it run daily backups. It should look like this:
backup: restart: unless-stopped container_name: atuin_db_dumper image: prodrigestivill/postgres-backup-local env_file: - .env environment: POSTGRES_HOST: db POSTGRES_DB: ${ATUIN_DB_NAME} POSTGRES_USER: ${ATUIN_DB_USERNAME} POSTGRES_PASSWORD: ${ATUIN_DB_PASSWORD} SCHEDULE: '@daily' BACKUP_DIR: /db_dumps TZ: Europe/London volumes: - ./db_dumps:/db_dumps depends_on: - dbThis will create daily backups of your database for that additional layer of comfort.