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:
""
open_registration
Section titled “open_registration”- Type: boolean
- Default:
false
max_record_size
Section titled “max_record_size”- Type: string
- Default:
"1GiB"
register_webhook_url
Section titled “register_webhook_url”- Type: string
register_webhook_username
Section titled “register_webhook_username”- Type: string
- Default:
""
metrics.enable
Section titled “metrics.enable”- Type: boolean
- Default:
false
metrics.host
Section titled “metrics.host”- Type: string
- Default:
"127.0.0.1"
metrics.port
Section titled “metrics.port”- Type: integer
- Default:
9001
trusted_proxies
Section titled “trusted_proxies”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:
[]
trusted_proxy_header
Section titled “trusted_proxy_header”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"
fake_version
Section titled “fake_version”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
db_uri
Section titled “db_uri”A postgres:// or sqlite:// connection URL.
- Type: string
db_password_file
Section titled “db_password_file”A file holding the password for db_uri.
- Type: string