summaryrefslogtreecommitdiff
path: root/docs/DEPLOY.md
diff options
context:
space:
mode:
authorAnders Betts <anders.betts@gmail.com>2026-09-17 22:30:33 +0200
committerAnders Betts <anders.betts@gmail.com>2026-09-17 22:30:33 +0200
commit804b31cc0c8415ebc79ccddf534dd09c5e6484a0 (patch)
tree4e5222126e358d0ea34a63b2fab45102e8c03c24 /docs/DEPLOY.md
parent91f2af4f5ce2f295c5d0a8bfd22b8c3bcc5f6966 (diff)
downloadbokf-804b31cc0c8415ebc79ccddf534dd09c5e6484a0.tar.gz
bokf-804b31cc0c8415ebc79ccddf534dd09c5e6484a0.zip
bokftui: remember server/user, BOKFD_TOKEN auto-login, sudo credential launcherv0.1.4
Diffstat (limited to 'docs/DEPLOY.md')
-rw-r--r--docs/DEPLOY.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/DEPLOY.md b/docs/DEPLOY.md
index 74f3953..5281fb6 100644
--- a/docs/DEPLOY.md
+++ b/docs/DEPLOY.md
@@ -116,6 +116,31 @@ The clients honor `BOKFD_SOCKET`; a host-installed client can also point at
`var/run/bokfd.sock`, but that file is owned by uid 10001, so the host user
must be in that group (or use `sudo`).
+The TUI remembers the server and user (never the password) in
+`$XDG_CONFIG_HOME/bokf/tui.conf` (`~/.config/bokf/tui.conf`), written after
+a successful login. Precedence: `--socket`/`--user`, then `BOKFD_SOCKET`/
+`BOKFD_USER`, then that file.
+
+For a credential read from a root-only file, unlocked with `sudo`, create an
+admin-scoped token on the host and store it on the client machine:
+
+```sh
+docker compose exec -e BOKFD_PASSWORD='<pw>' bokfd \
+ bokfctl --user admin --org 1 token.create \
+ '{"label":"tui-laptop","scopes":["read","write","admin"]}'
+
+# on the client machine:
+sudo install -d -m 700 /etc/bokf
+sudo sh -c 'umask 077; printf "%s\n" "bokf_..." > /etc/bokf/tui-token'
+install -m 755 scripts/bokftui-sudo ~/bin/bokftui-sudo
+bokftui-sudo
+```
+
+`bokftui-sudo` runs `sudo -v`, reads `/etc/bokf/tui-token` (falling back to
+`/etc/bokf/tui-password`), exports the credential and execs `bokftui` as
+your user; with `BOKFD_TOKEN` set the TUI logs in without showing the login
+screen. Revoke the token with `token.revoke` when a machine goes away.
+
## TLS and external users
Put the ACME DNS credentials in the host's `.env` once (they are never