Skip to content

Commit df1f12f

Browse files
committed
docs(readme): env vars more readable
1 parent c82577d commit df1f12f

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -125,22 +125,22 @@ docker compose up -d --force-recreate --build
125125
See the [docker-compose.yml](docker-compose.yml) for how it's wired up in containers.
126126

127127
## Environment Variables
128-
- ADMIN_USER: admin username (default `admin`)
129-
- ADMIN_PW: required; admin password (validated for complexity)
130-
- SESSION_SECRET: required in production (random in dev if omitted)
131-
- JWT_SECRET: required; HMAC secret for access tokens
132-
- JWT_REFRESH_SECRET: required; HMAC secret for refresh tokens
133-
- JWT_ACCESS_TTL: optional, default `1h` (supports `30m`, `3600`, etc.)
134-
- JWT_REFRESH_TTL: optional, default `24h`
135-
- PORT: server port (default `3000`)
136-
- ALLOWED_ORIGINS: CSV of allowed origins for CORS
137-
- TRUST_PROXY: set `true` if running behind a reverse proxy
138-
- LOG_LEVEL: winston log level (default `info`)
139-
- DATA_DIR: Actual data directory (default `/app/.actual-cache`); stores `auth.db`
140-
- ACTUAL_SERVER_URL: Actual server URL (e.g., `http://localhost:5006`)
141-
- ACTUAL_PASSWORD: Actual server password
142-
- ACTUAL_SYNC_ID: Budget sync ID
143-
- N8N_CLIENT_ID / N8N_CLIENT_SECRET / N8N_OAUTH2_CALLBACK_URL: enable OAuth2 endpoints when all are present
128+
- `ADMIN_USER`: admin username (default `admin`)
129+
- `ADMIN_PW`: required; admin password (validated for complexity)
130+
- `SESSION_SECRET`: required in production (random in dev if omitted)
131+
- `JWT_SECRET`: required; HMAC secret for access tokens
132+
- `JWT_REFRESH_SECRET`: required; HMAC secret for refresh tokens
133+
- `JWT_ACCESS_TTL`: optional, default `1h` (supports `30m`, `3600`, etc.)
134+
- `JWT_REFRESH_TTL`: optional, default `24h`
135+
- `PORT`: server port (default `3000`)
136+
- `ALLOWED_ORIGINS`: CSV of allowed origins for CORS
137+
- `TRUST_PROXY`: set `true` if running behind a reverse proxy
138+
- `LOG_LEVEL`: winston log level (default `info`)
139+
- `DATA_DIR`: Actual data directory (default `/app/.actual-cache`); stores `auth.db`
140+
- `ACTUAL_SERVER_URL`: Actual server URL (e.g., `http://localhost:5006`)
141+
- `ACTUAL_PASSWORD`: Actual server password
142+
- `ACTUAL_SYNC_ID`: Budget sync ID
143+
- `N8N_CLIENT_ID` / `N8N_CLIENT_SECRET` / `N8N_OAUTH2_CALLBACK_URL`: enable OAuth2 endpoints when all are present
144144

145145
## API Docs & Validation
146146
- OpenAPI source: [src/docs/openapi.yml](src/docs/openapi.yml)

0 commit comments

Comments
 (0)