document configuration variables in README.md
All checks were successful
Build Container / Build Container (push) Successful in 1m32s

This commit is contained in:
lilly 2026-05-15 08:39:59 +02:00
commit 5a550e4594
Signed by: lilly
SSH key fingerprint: SHA256:y9T5GFw2A20WVklhetIxG1+kcg/Ce0shnQmbu1LQ37g
2 changed files with 20 additions and 1 deletions

View file

@ -10,6 +10,25 @@ Project structure:
└── app # Web UI └── app # Web UI
``` ```
## Configuration
The final application can be configured either via CLI arguments or via environment variables.
If both are given, the CLI flag takes precedence.
THe following table lists all available configuration parameters:
| CLI Flag | Environment Variable | Required? | Default Value |
| -------- | -------------------- | :-------: | ------------- |
| `--openid-issuer` | `DOORIS_OPENID_ISSUER` | Yes | *None* |
| `--openid-scope` | `DOORIS_OPENID_SCOPE` | No | `openid profile` |
| `--openid-client-id` | `DOORIS_OPENID_CLIENT_ID` | Yes | *None* |
| `--openid-client-secret` | `DOORIS_OPENID_CLIENT_SECRET` | Yes | *None* |
| `--base-url` | `DOORIS_BASE_URL` | Yes | *None* |
| `--serve-static` | `DOORIS_SERVE_STATIC` | No | *None* |
| `--ccujack-url` | `DOORIS_CCUJACK_URL` | No | `https://hmdooris-ccu.ccchh.net:2122` |
| `--ccujack-user` | `DOORIS_CCUJACK_USER` | Yes | *None* |
| `--ccujack-password` | `DOORIS_CCUJACK_PASSWORD` | Yes | *None* |
## API Development ## API Development
Most things should automatically be set up with the included [direnv script](./.envrc.dist) but if you don't use that, take the following steps: Most things should automatically be set up with the included [direnv script](./.envrc.dist) but if you don't use that, take the following steps:

View file

@ -19,7 +19,7 @@ def main():
) )
argp.add_argument( argp.add_argument(
"--openid-scope", "--openid-scope",
default=os.environ.get("DOORIS_OPENID_SCOPE", "openid profile ccchh-roles"), default=os.environ.get("DOORIS_OPENID_SCOPE", "openid profile"),
help="The Keycloak OpenID isser to use for authentication", help="The Keycloak OpenID isser to use for authentication",
) )
argp.add_argument( argp.add_argument(