detached 80b88e8

docs(auth): clarify token secret sources

commit
80b88e84e6c9e7b9820c3d77250d83c5e281a847
author
bnema · · 2026-01-30 21:00 UTC
parent
b91832c
signature
unsigned
2 files · +7 -2
M docs/config/auth.md +1 -1
@@ -54,7 +54,7 @@ See [Secret Providers](./secrets.md) for setup details.
5454
5555 ## Environment Variable
5656
57-`GORDON_AUTH_TOKEN_SECRET` overrides `token_secret` in the config.
57+`GORDON_AUTH_TOKEN_SECRET` overrides `token_secret` in the config. If you don’t set the env var, `token_secret` is loaded from the configured secrets backend (including `pass`).
5858
5959 ```bash
6060 export GORDON_AUTH_TOKEN_SECRET="your-32-character-secret-here"
@@ -54,7 +54,7 @@ See [Secret Providers](./secrets.md) for setup details.
54 54
55 ## Environment Variable55 ## Environment Variable
56 56
57-`GORDON_AUTH_TOKEN_SECRET` overrides `token_secret` in the config.57+`GORDON_AUTH_TOKEN_SECRET` overrides `token_secret` in the config. If you don’t set the env var, `token_secret` is loaded from the configured secrets backend (including `pass`).
58 58
59 ```bash59 ```bash
60 export GORDON_AUTH_TOKEN_SECRET="your-32-character-secret-here"60 export GORDON_AUTH_TOKEN_SECRET="your-32-character-secret-here"
M docs/getting-started.md +6 -1
@@ -29,7 +29,7 @@ Config is created at `~/.config/gordon/gordon.toml`.
2929
3030 ## 3. Set Up Authentication
3131
32-Gordon requires a `token_secret` for JWT authentication. We recommend using `pass` to store secrets securely.
32+Gordon requires a `token_secret` for JWT authentication. You can store it in `pass` or provide it via the `GORDON_AUTH_TOKEN_SECRET` environment variable. We recommend using `pass` to store secrets securely.
3333
3434 > **Local development?** If you just want to try Gordon locally, you can disable auth temporarily:
3535 > ```toml
@@ -53,6 +53,11 @@ pass init <your-gpg-key-id>
5353 openssl rand -base64 32 | pass insert -m gordon/auth/token_secret
5454 ```
5555
56+**Or set it via environment variable:**
57+```bash
58+export GORDON_AUTH_TOKEN_SECRET="your-32-character-secret-here"
59+```
60+
5661 **Update your config** (`~/.config/gordon/gordon.toml`):
5762 ```toml
5863 [auth]
@@ -29,7 +29,7 @@ Config is created at `~/.config/gordon/gordon.toml`.
29 29
30 ## 3. Set Up Authentication30 ## 3. Set Up Authentication
31 31
32-Gordon requires a `token_secret` for JWT authentication. We recommend using `pass` to store secrets securely.32+Gordon requires a `token_secret` for JWT authentication. You can store it in `pass` or provide it via the `GORDON_AUTH_TOKEN_SECRET` environment variable. We recommend using `pass` to store secrets securely.
33 33
34 > **Local development?** If you just want to try Gordon locally, you can disable auth temporarily:34 > **Local development?** If you just want to try Gordon locally, you can disable auth temporarily:
35 > ```toml35 > ```toml
@@ -53,6 +53,11 @@ pass init <your-gpg-key-id>
53 openssl rand -base64 32 | pass insert -m gordon/auth/token_secret53 openssl rand -base64 32 | pass insert -m gordon/auth/token_secret
54 ```54 ```
55 55
56+**Or set it via environment variable:**
57+```bash
58+export GORDON_AUTH_TOKEN_SECRET="your-32-character-secret-here"
59+```
60+
56 **Update your config** (`~/.config/gordon/gordon.toml`):61 **Update your config** (`~/.config/gordon/gordon.toml`):
57 ```toml62 ```toml
58 [auth]63 [auth]

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 7

Tags 106

↑↓ moveenter openesc close