document configuration variables in README.md
All checks were successful
Build Container / Build Container (push) Successful in 1m32s
All checks were successful
Build Container / Build Container (push) Successful in 1m32s
This commit is contained in:
parent
f72f830b36
commit
5a550e4594
2 changed files with 20 additions and 1 deletions
19
README.md
19
README.md
|
|
@ -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:
|
||||||
|
|
|
||||||
|
|
@ -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(
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue