Skip to content
Atuin

server.toml

The settings atuin-server reads from server.toml, which it looks for where Atuin looks for config.toml. Each can also be set through an ATUIN_ environment variable, such as ATUIN_PORT, or ATUIN_METRICS__PORT for one in a table.

#:schema https://docs.atuin.sh/schemas/server.schema.json
  • Type: string
  • Default: "127.0.0.1"
  • Type: integer
  • Default: 8888
  • Type: string
  • Default: ""
  • Type: boolean
  • Default: false
  • Type: string
  • Default: "1GiB"
  • Type: string
  • Type: string
  • Default: ""
  • Type: boolean
  • Default: false
  • Type: string
  • Default: "127.0.0.1"
  • Type: integer
  • Default: 9001

Networks of reverse proxies whose X-Forwarded-For header is trusted when reporting the client address. Requests from anywhere else are attributed to their TCP peer.

  • Type: list of string
  • Default: []

The header a trusted proxy reports the client address in, such as X-Forwarded-For or X-Real-IP.

  • Type: string
  • Default: "x-forwarded-for"

Advertise a version that is not what we are actually running Many clients compare their version with api.atuin.sh, and if they differ, notify the user that an update is available. Now that we take beta releases, we should be able to advertise a different version to avoid notifying users when the server runs something that is not a stable release.

  • Type: string

A postgres:// or sqlite:// connection URL.

  • Type: string

A file holding the password for db_uri.

  • Type: string