-
Notifications
You must be signed in to change notification settings - Fork 6
Configuration Parameters v0.4.1
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.trust.certificates
Description: PEM encoded file with one or more trusted root certificate to validate the GECCO FHIR servers server-certificate when connecting via https.
Recommendation: Use docker secret file to configure.
Example: /run/secrets/hospital_ca.pem
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.certificate
Description: PEM encoded file with client-certificate, if GECCO FHIR server requires mutual TLS authentication.
Recommendation: Use docker secret file to configure.
Example: /run/secrets/gecco_server_client_certificate.pem
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.private.key
Description: Private key corresponding to the GECCO FHIR server client-certificate as PEM encoded file. Use DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_PRIVATE_KEY_PASSWORD or DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_PRIVATE_KEY_PASSWORD_FILE if private key is encrypted.
Recommendation: Use docker secret file to configure.
Example: /run/secrets/gecco_server_private_key.pem
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.private.key.password
Description: Password to decrypt the GECCO FHIR server client-certificate encrypted private key.
Recommendation: Use docker secret file to configure, using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_PRIVATE_KEY_PASSWORD_FILE.
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.private.key.password
Description: Alternative for setting DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_PRIVATE_KEY_PASSWORD via docker secret file.
Example: /run/secrets/gecco_server_private_key.pem.password
Caution! Editors like nano will add a LF
(hex 0A
) character at the end of the last line. Make sure that the password file does not end with the LF
character. For example by starting nano with nano -L file.password
. If you want to check that the file does not end with an LF
(hex 0A
) character, use xxd file.password
to look at a hexdump.
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.base.url
Description: The base address of the FHIR repository containing GECCO data.
Example: http://foo.bar/fhir
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.basicauth.username
Description: Basic authentication username, set if the server containing the FHIR GECCO data requests authentication using basic auth.
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.basicauth.password
Description: Basic authentication password, set if the server containing the FHIR GECCO data requests authentication using basic auth.
Recommendation: Use docker secret file to configure, using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_BASICAUTH_PASSWORD_FILE.
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.basicauth.password
Description: Alternative for setting DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_BASICAUTH_PASSWORD via docker secret file.
Example: /run/secrets/gecco_server_basicauth.password
Caution! Editors like nano will add a LF
(hex 0A
) character at the end of the last line. Make sure that the password file does not end with the LF
character. For example by starting nano with nano -L file.password
. If you want to check that the file does not end with an LF
(hex 0A
) character, use xxd file.password
to look at a hexdump.
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.bearer.token
Description: TODO
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.timeout.connect
Description: TODO
Default value: 10000
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.timeout.socket
Description: TODO
Default value: 10000
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.timeout.connection.request
Description: TODO
Default value: 10000
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.client
Description: TODO
Default value: de.netzwerk_universitaetsmedizin.codex.processes.data_transfer.client.fhir.FhirBridgeClient
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.client.hapi.verbose
Description: TODO
Default value: false
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.proxy.url
Description: TODO
Example: http://local.proxy.de:8080
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.proxy.username
Description: TODO
Example: proxy_username
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.proxy_password
Description: TODO
Recommendation: Use docker secret file to configure, using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_PROXY_PASSWORD_FILE.
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.proxy.password
Description: Alternative for setting DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_GECCO_SERVER_PROXY_PASSWORD via docker secret file.
Example: /run/secrets/gecco_server_proxy.password
Caution! Editors like nano will add a LF
(hex 0A
) character at the end of the last line. Make sure that the password file does not end with the LF
character. For example by starting nano with nano -L file.password
. If you want to check that the file does not end with an LF
(hex 0A
) character, use xxd file.password
to look at a hexdump.
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.use.chained.parameter.not.logical.reference
Description: TODO
Default value: true
Property: de.netzwerk.universitaetsmedizin.codex.gecco.server.search.bundle.override
Description: TODO
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.crr.public.key
Description: Location of the CRR public-key e.g. crr_public-key-pre-prod.pem as 4096 Bit RSA PEM encoded file. Please ask the management for the central repository for the correct public key regarding the test and production environments!
Recommendation: Use docker secret file to configure.
Example: /run/secrets/crr_public-key-pre-prod.pem
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.crr.private.key
Description: location of the CRR private-key as 4096 Bit RSA PEM encoded, not encrypted file.
Recommendation: Use docker secret file to configure.
Example: /run/secrets/crr_private-key-pre-prod.pem
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.fttp.trust.certificates
Description: PEM encoded file with one or more trusted root certificate to validate the fTTP servers server-certificate, e.g. file containing the T-TeleSec GlobalRoot Class 2
certificate.
Recommendation: Use (or reuse) docker secret file to configure.
Example: /run/secrets/ssl_root_ca_certificate_file.pem
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.fttp.certificate
Description: PEM encoded file with client-certificate used to authenticate against the fTTP.
Recommendation: Use docker secret file to configure.
Example: /run/secrets/fttp_client_certificate.pem
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.fttp.private.key
Description: Private key corresponding to the client-certificate used to authenticate against the fTTP as PEM encoded file. Use DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_PRIVATE_KEY_PASSWORD or DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_PRIVATE_KEY_PASSWORD_FILE if private key is encrypted.
Recommendation: Use docker secret file to configure.
Example: /run/secrets/fttp_client_certificate_private_key.pem
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.fttp.private.key.password
Description: Password to decrypt the DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_PRIVATE_KEY.
Recommendation: Use docker secret file to configure, using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_PRIVATE_KEY_PASSWORD_FILE.
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.fttp.private.key.password
Description: Alternative for setting DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_PRIVATE_KEY_PASSWORD via docker secret file.
Example: /run/secrets/fttp_client_certificate_private_key.pem.password
Caution! Editors like nano will add a LF
(hex 0A
) character at the end of the last line. Make sure that the password file does not end with the LF
character. For example by starting nano with nano -L file.password
. If you want to check that the file does not end with an LF
(hex 0A
) character, use xxd file.password
to look at a hexdump.
Property: de.netzwerk.universitaetsmedizin.codex.fttp.timeout.connect
Description: TODO
Default value: 10000
Property: de.netzwerk.universitaetsmedizin.codex.fttp.timeout.socket
Description: TODO
Default value: 10000
Property: de.netzwerk.universitaetsmedizin.codex.fttp.timeout.connection.request
Description: TODO
Default value: 10000
Property: de.netzwerk.universitaetsmedizin.codex.fttp.basicauth.username
Description: If the second factor of your fTTP authentication method is not based on an IP address filter, your organizations basic auth username.
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.fttp.basicauth.password
Description: If the second factor of your fTTP authentication method is not based on an IP address filter, your organizations basic auth password.
Recommendation: Use docker secret file to configure, using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_BASICAUTH_PASSWORD_FILE.
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.fttp.basicauth.password
Description: Alternative for setting DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_BASICAUTH_PASSWORD via docker secret file.
Example: TODO
Property: de.netzwerk.universitaetsmedizin.codex.fttp.server.base.url
Description: fTTP Server address base that corresponds to your authentication method provided by fTTP.
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.fttp.api.key
Description: Your organizations API key provided by the fTTP. The fTTP API key can currently not be defined via docker secret file and needs to be defined directly via the environment variable.
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.fttp.study
Description: TODO
Default value: num
Property: de.netzwerk.universitaetsmedizin.codex.fttp.target
Description: Your organizations pseudonym source identifier provided by the fTTP.
Example: dic_heidelberg
Default value: codex
Property: de.netzwerk.universitaetsmedizin.codex.fttp.client.hapi.verbose
Description: TODO
Default value: false
Property: de.netzwerk.universitaetsmedizin.codex.fttp.proxy.url
Description: TODO
Example: http://local.proxy.de:8080
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.fttp.proxy.username
Description: TODO
Example: proxy_username
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.fttp.proxy.password
Description: TODO
Recommendation: Use docker secret file to configure, using DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_PROXY_PASSWORD_FILE.
Default: optional parameter, not set by default
Property: de.netzwerk.universitaetsmedizin.codex.fttp.proxy.password
Description: Alternative for setting DE_NETZWERK_UNIVERSITAETSMEDIZIN_CODEX_FTTP_PROXY_PASSWORD via docker secret file.
Example: /run/secrets/fttp_proxy.password
Caution! Editors like nano will add a LF
(hex 0A
) character at the end of the last line. Make sure that the password file does not end with the LF
character. For example by starting nano with nano -L file.password
. If you want to check that the file does not end with an LF
(hex 0A
) character, use xxd file.password
to look at a hexdump.