Skip to content
Atuin

Self-Hosting

While we offer a hosted, encrypted and secure server at Atuin, we also provide a self-hosted version of the Atuin server.

  • You need to be able to run a binary or Docker container on a server.
  • You must have either a PostgreSQL, MySQL or SQLite database.

The server is distributed as a separate binary, atuin-server, pre-built and available on Github releases.

Terminal window
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/atuinsh/atuin/releases/latest/download/atuin-server-installer.sh | sh

You must configure the database path in your ~/.atuin/server.toml:

db_uri="postgres://user:password@hostname/database"

Then, start the server with:

Terminal window
atuin-server start

We strongly urge you enable TLS with Atuin. Without TLS, passwords are sent plaintext, which is wildly insecure.

For TLS/HTTPS support, we recommend using a reverse proxy such as nginx, Caddy, or Traefik in front of the Atuin server.

atuin-server supports some administration tools.

While open_registration is true, anyone who can reach the server can register. To keep a server private, leave it false and create accounts on the server instead:

Terminal window
atuin-server admin user create --email [email protected] alice

You can also delete users as well as change their passwords.

Terminal window
atuin-server admin user set-password alice
atuin-server admin user delete alice

See atuin-server admin.

The server’s config lives at ~/.atuin/server.toml, separate from the client’s config.

It looks something like this for PostgreSQL:

host = "0.0.0.0"
port = 8888
open_registration = true
db_uri="postgres://user:password@hostname/database"

You must configure the database as Atuin can’t proceed without one. You can do so either in server.toml or via the environment variable:

Using server.toml:

db_uri="postgres://user:password@hostname/database"
Parameter Description
db_uri A valid database URI, for saving history (required, no default)
db_password_file A file holding the database password, kept out of db_uri (default: none)
host The host to listen on (default: 127.0.0.1)
port The TCP port to listen on (default: 8888)
open_registration If true, accept new user registrations (default: false)
path A path to prepend to all routes of the server (default: empty)
trusted_proxies Reverse proxies whose client address header is trusted (default: empty)
trusted_proxy_header The header those proxies report the client address in (default: X-Forwarded-For)