Skip to content

Commit d94f219

Browse files
gasperrreinkrul
gasperr
and
reinkrul
authored
Configuration documentation update (#373)
* Configuration documentation update * Update docs/CONFIGURATION.md --------- Co-authored-by: reinkrul <info@reinkrul.nl>
1 parent 78c8f1b commit d94f219

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

‎docs/CONFIGURATION.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Configuration is loaded in the following order (later sources override earlier o
1515

1616
## Configuration Options
1717

18-
Environment variables use the prefix `KNPT_` followed by the configuration path in uppercase with underscores:
18+
Environment variables use the prefix `KNPT_` followed by the configuration path in uppercase with underscores (if you enable NUTS node as embedded service within your Knooppunt, those variables are prefixed with `NUTS_`):
1919

2020
| Environment Variable | YAML Path | Description |
2121
|-------------------------------------------|--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -27,7 +27,8 @@ Environment variables use the prefix `KNPT_` followed by the configuration path
2727
| `KNPT_HTTP_INTERNAL_ADDRESS` | `http.internal.address` | TCP address for the internal HTTP interface.<br/>Defaults to `:8081`. |
2828
| `KNPT_HTTP_INTERNAL_URL` | `http.internal.url` | (Optional) Internal base URL. If not specified, defaults to `http://<hostname>:<port>`. |
2929
| **Authentication / Nuts** | | |
30-
| `KNPT_NUTS_ENABLED` | `nuts.enabled` | Enable embedded Nuts node.<br/>Defaults to `true`. |
30+
| `KNPT_NUTS_ENABLED` | `nuts.enabled` | Enable embedded Nuts node.<br/>Defaults to `false`. |
31+
| `NUTS_*` | config/nuts.yml file | Nuts specific configuration variables are either prefixed with NUTS_ or are present in config/nuts.yml file |
3132
| **Addressing / mCSD** | | |
3233
| `KNPT_MCSDADMIN_FHIRBASEURL` | `mcsdadmin.fhirbaseurl` | (Optional) FHIR base URL of the local mCSD Administration Directory, if managed through the mCSD Web Application. |
3334
| `KNPT_MCSD_QUERY_FHIRBASEURL` | `mcsd.query.fhirbaseurl` | FHIR base URL of the local mCSD Query Directory to synchronize to. |
@@ -40,8 +41,8 @@ Environment variables use the prefix `KNPT_` followed by the configuration path
4041
| **Consent / Mitz** | | |
4142
| `KNPT_MITZ_MITZBASE` | `mitz.mitzbase` | Base URL of the MITZ endpoint |
4243
| `KNPT_MITZ_NOTIFYENDPOINT` | `mitz.notifyendpoint` | Endpoint that will be used in `Subscription.channel.endpoint` when subscribing to Mitz (unless one is provided in the Subscription request to the knooppunt) |
43-
| `KNPT_MITZ_GATEWAYSYSTEM` | `mitz.gatewaysystem` | (Optional) URL where MITZ will send consent notifications (your callback endpoint) |
44-
| `KNPT_MITZ_SOURCESYSTEM` | `mitz.sourcesystem` | (Optional) gateway system OID (added as FHIR extension) |
44+
| `KNPT_MITZ_GATEWAYSYSTEM` | `mitz.gatewaysystem` | gateway system OID to be used in a MITZ subscription (your gateway system OID) |
45+
| `KNPT_MITZ_SOURCESYSTEM` | `mitz.sourcesystem` | source system OID to be used in a MITZ subscription (your source system OID) |
4546
| `KNPT_MITZ_TLSCERTFILE` | `mitz.tlscertfile` | Path to client certificate (.p12/.pfx or .pem) |
4647
| `KNPT_MITZ_TLSKEYFILE` | `mitz.tlskeyfile` | Path to private key (only for .pem certs) |
4748
| `KNPT_MITZ_TLSKEYPASSWORD` | `mitz.tlskeypassword` | Password for .p12/.pfx |

0 commit comments

Comments
 (0)