Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Environment variables

bouncer (the CLI)

VariableMeaning
BOUNCER_URLThe Bouncer server's address. --server overrides it. Without either, the first line of ~/.config/bouncer/server is used
BOUNCER_KEY_FILEThe file holding the requester key. --key-file overrides it
BOUNCER_KEYThe requester key itself, used when no key file is given. A file is safer
BOUNCER_CA_FILEA PEM file of extra CA certificates, trusted for both Bouncer and OpenBao
HTTPS_PROXY, ALL_PROXY, NO_PROXYProxy for HTTPS calls and hosts that bypass it. Lower-case names work too. HTTP_PROXY is never used
XDG_CONFIG_HOMEWhen set, overrides the configuration folder on Linux and Windows. Without it, Linux uses ~/.config; on Windows, the defaults are %LOCALAPPDATA%\bouncer\server and %LOCALAPPDATA%\bouncer\key
SSL_CERT_FILEWhere the system's CA certificates are, if not in the usual places
BOUNCER_UPDATE_FEEDThe update feed for bouncer self-update (Linux)

bouncer exec removes BOUNCER_KEY from the child environment. It passes BOUNCER_KEY_FILE on, and the child can still read the key file. Trust the command you run.

bouncer-mcp

VariableMeaning
BOUNCER_URLRequired. The Bouncer server's address: https://, or http:// to this machine only. Unlike bouncer, it does not read ~/.config/bouncer/server
BOUNCER_KEY_FILERequired. The agent's key file. The key itself is never read from the environment
BOUNCER_CA_FILEExtra CA certificates, as for bouncer
HTTPS_PROXY, ALL_PROXY, NO_PROXYProxy settings as for bouncer, including lower-case names

bouncer-admin

VariableMeaning
BOUNCER_ADMIN_SOCKETThe admin socket. --socket overrides it. Default /run/bouncer/admin.sock
NO_COLORSet to stop device pair forcing white-on-black colours for the QR code

bouncer-server

VariableMeaning
DATABASE_URLThe PostgreSQL connection URL. Never logged. The compose kit leaves the password out of it and supplies it separately
PGPASSWORDThe database password, when DATABASE_URL has none. The compose kit's entrypoint sets it from the password file
BOUNCER_ADMIN_SOCKETWhere to create the admin socket. --admin-socket overrides it
RUST_LOGLog filter, including full EnvFilter directives. Default info; levels include error, warn and debug
BOUNCER_TEST_FCM_ENDPOINT, BOUNCER_TEST_FCM_TOKEN_URITests only. Point push at a fake on this machine. Never set them on a real server

The container entrypoint

The entrypoint uses these defaults unless a value is supplied. compose.yaml sets some of them; change its values through .env where noted.

VariableDefaultMeaning
BOUNCER_CONFIG/etc/bouncer/bouncer.yamlThe config file inside the container
BOUNCER_LISTEN127.0.0.1:8080The address the server listens on. From BOUNCER_PORT in .env
BOUNCER_DB_PASSWORD_FILE/run/secrets/bouncer-db-passwordThe database password file
BOUNCER_WAIT_FOR_OPENBAOemptyIgnored from 0.5.6, and the entrypoint logs that it is. It used to hold the server back until OpenBao was unsealed; the server now starts anyway and answers 503 until OpenBao is ready (When Bouncer is unavailable)

The compose .env file

deploy/compose/.env holds settings, never secrets: docker compose config prints them.

VariableDefaultMeaning
BOUNCER_PORT8080The port on 127.0.0.1
BOUNCER_CONFIG_DIR/etc/bouncer/configThe folder holding bouncer.yaml, mounted read-only at /etc/bouncer
BOUNCER_SECRETS_DIR/etc/bouncer/secretsThe folder holding the secret files
BOUNCER_IMAGElocalhost/bouncer-server:localThe server image
BOUNCER_VERSION, BOUNCER_REVISIONlocal, unknownLabels for a local build
BUILD_JOBSemptyParallel compile jobs, for a small machine
BOUNCER_WAIT_FOR_OPENBAOemptySee above
RUST_LOGinfoThe server's log level
COMPOSE_FILEcompose.yamlAdd compose.push.yaml, compose.push2.yaml or compose.ssh.yaml, separated by :

This manual covers Bouncer 0.5.7. Built from source commit cdd3b5958d5be0b33e865b1b56b770f6bccffaf7 (workspace version 0.5.7+34).