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

Ports and files

Ports

PortWhereWhat
443Your HTTPS front endWhat apps and requesters connect to (instance.url)
8080127.0.0.1 on the serverThe Bouncer server's plain HTTP listener. Change with BOUNCER_PORT
8200OpenBaoOpenBao's API. The deploy/openbao kit listens on 127.0.0.1:8200 and puts HTTPS in front, on 8443 in its README
nonePostgreSQL has no network; the server uses its Unix socket
noneThe admin API is a Unix socket only

Outbound from the server: OpenBao, and Firebase (Google, port 443) if push is on.

On the server's machine

These modes are set by the install instructions. The requester key's mode is checked by code; the other modes are deployment requirements.

PathMode and ownerWhat
~/bouncerThe repository checkout. Nothing secret
/opt/bouncer/releases/<full commit>With ship.sh: that commit's deploy/ folder only. Nothing secret
~/bouncer/deploy/compose/.env (or /opt/bouncer/releases/<full commit>/deploy/compose/.env)Compose settings. Nothing secret
/etc/bouncer/config/bouncer.yaml0644The config file
/etc/bouncer/config/openbao-ca.pem0644OpenBao's CA, if needed
/etc/bouncer/secrets/0700, user 10001The secret files
/etc/bouncer/secrets/bouncer-role-id0400, user 10001OpenBao AppRole role_id
/etc/bouncer/secrets/bouncer-secret-id0400, user 10001OpenBao AppRole secret_id
/etc/bouncer/secrets/bouncer-db-password0400, user 10001The database password
/etc/bouncer/secrets/bouncer-ssh-role-id0400, user 10001SSH signer AppRole role_id, if SSH is on (compose.ssh.yaml)
/etc/bouncer/secrets/bouncer-ssh-secret-id0400, user 10001SSH signer AppRole secret_id, if SSH is on
/etc/bouncer/secrets/fcm-service-account-2.json0400, user 10001Second Firebase key while moving projects (compose.push2.yaml)
/etc/bouncer/secrets/fcm-service-account.json0400, user 10001Firebase key, if push is on
/var/backups/bouncer/0700Daily backups from the timer
/usr/local/libexec/bouncer-backup0755backup.sh, installed for the timer
/etc/systemd/system/bouncer-logical-backup.{service,timer}0644The backup timer

Inside the server container

PathWhat
/etc/bouncer/The config folder, read-only
/run/secrets/<name>The secret files, read-only
/run/bouncer/admin.sockThe admin socket, mode 0600, on the bouncer-run volume
/run/postgresql/PostgreSQL's socket, read-only, on the pg-socket volume

The container's root filesystem is read-only, it has no Linux capabilities, and it runs as user 10001.

Docker volumes

VolumeWhat
bouncer_pgdataPostgreSQL's data. docker compose down -v deletes it
bouncer_pg-socketPostgreSQL's socket, a small in-memory volume
bouncer_bouncer-runThe admin socket

On a requester's machine

PathModeWhat
~/.local/bin/bouncer, ~/.local/bin/bouncer-mcp0755The binaries (or /usr/local/bin, or /usr/bin from a package)
~/.config/bouncer/0700Settings folder
~/.config/bouncer/serverThe server's address
~/.config/bouncer/key0600The requester key
%LOCALAPPDATA%\bouncer\server, %LOCALAPPDATA%\bouncer\keyprivate to the Windows accountWindows CLI settings and encrypted key

The role kit

PathWhat
deploy/openbao-role-kit/resourcesYour list of secrets. Keep it, in your own repository; the emergency stop needs it
deploy/openbao-role-kit/kit.envYour kit settings, if you changed any
deploy/openbao-role-kit/rendered/Policies the kit rendered

All three are ignored by Git in the Bouncer repository.

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