Configuration
Everything is optional. For local development, copy .env.example to .env.
| Variable | Default | Description |
|---|---|---|
ORIGIN | none | Public URL of the app. Set it in production, forms fail without it behind a reverse proxy. |
PORT | 3000 | Port the server listens on. |
HOST | 0.0.0.0 | Address the server binds to. |
DB_FILE_NAME | data/db.sqlite | Path to the SQLite database. |
PUID / PGID | 10001 | Docker only. The uid/gid the server runs as. The data volume is chowned to match on startup. |
DISK_STATS_PATH | /System/Volumes/Data on macOS, / elsewhere | Filesystem the disk gauge reports on. |
WEATHER_LAT | none | Latitude for the weather. A location picked in Settings takes precedence. |
WEATHER_LON | none | Longitude for the weather. Must be set together with WEATHER_LAT. |
WEATHER_LOCATION_NAME | Home | Label shown for the location set through the variables above. |
WEATHER_UNITS | celsius | celsius or fahrenheit. |
OIDC_ISSUER | none | Issuer URL of your OpenID Connect provider. Setting it turns sign-in on. |
OIDC_CLIENT_ID | none | Client ID. Required with OIDC_ISSUER. |
OIDC_CLIENT_SECRET | none | Client secret. Required with OIDC_ISSUER. |
OIDC_ALLOWED_EMAILS | none | Comma-separated emails allowed to sign in. Unset lets in anyone the provider signs in. |
This guide lives in the project repo: edit it there, and this page follows within a day.