Zum Hauptinhalt springen

Environment Variables

Environment variables for the invitations service

NameIntroduction VersionTypeDescriptionDefault Value
OC_TRACING_ENABLED
INVITATIONS_TRACING_ENABLED
1.0.0boolActivates tracing.false
OC_TRACING_TYPE
INVITATIONS_TRACING_TYPE
1.0.0stringThe type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now.
OC_TRACING_ENDPOINT
INVITATIONS_TRACING_ENDPOINT
1.0.0stringThe endpoint of the tracing agent.
OC_TRACING_COLLECTOR
INVITATIONS_TRACING_COLLECTOR
1.0.0stringThe HTTP endpoint for sending spans directly to a collector, i.e. \http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset.
OC_LOG_LEVEL
INVITATIONS_LOG_LEVEL
1.0.0stringThe log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'.
OC_LOG_PRETTY
INVITATIONS_LOG_PRETTY
1.0.0boolActivates pretty log output.false
OC_LOG_COLOR
INVITATIONS_LOG_COLOR
1.0.0boolActivates colorized log output.false
OC_LOG_FILE
INVITATIONS_LOG_FILE
1.0.0stringThe path to the log file. Activates logging to this file if set.
INVITATIONS_DEBUG_ADDR1.0.0stringBind address of the debug server, where metrics, health, config and debug endpoints will be exposed.127.0.0.1:9269
INVITATIONS_DEBUG_TOKEN1.0.0stringToken to secure the metrics endpoint.
INVITATIONS_DEBUG_PPROF1.0.0boolEnables pprof, which can be used for profiling.false
INVITATIONS_DEBUG_ZPAGES1.0.0boolEnables zpages, which can be used for collecting and viewing in-memory traces.false
INVITATIONS_HTTP_ADDR1.0.0stringThe bind address of the HTTP service.127.0.0.1:9265
INVITATIONS_HTTP_ROOT1.0.0stringSubdirectory that serves as the root for this HTTP service./graph/v1.0
OC_CORS_ALLOW_ORIGINS
INVITATIONS_CORS_ALLOW_ORIGINS
1.0.0[]stringA list of allowed CORS origins. See following chapter for more details: Access-Control-Allow-Origin at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin. See the Environment Variable Types description for more details.[https://localhost:9200]
OC_CORS_ALLOW_METHODS
INVITATIONS_CORS_ALLOW_METHODS
1.0.0[]stringA list of allowed CORS methods. See following chapter for more details: Access-Control-Request-Method at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method. See the Environment Variable Types description for more details.[]
OC_CORS_ALLOW_HEADERS
INVITATIONS_CORS_ALLOW_HEADERS
1.0.0[]stringA list of allowed CORS headers. See following chapter for more details: Access-Control-Request-Headers at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers. See the Environment Variable Types description for more details.[]
OC_CORS_ALLOW_CREDENTIALS
INVITATIONS_CORS_ALLOW_CREDENTIALS
1.0.0boolAllow credentials for CORS.See following chapter for more details: Access-Control-Allow-Credentials at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials.false
OC_HTTP_TLS_ENABLED1.0.0boolActivates TLS for the http based services using the server certifcate and key configured via OC_HTTP_TLS_CERTIFICATE and OC_HTTP_TLS_KEY. If OC_HTTP_TLS_CERTIFICATE is not set a temporary server certificate is generated - to be used with PROXY_INSECURE_BACKEND=true.false
OC_HTTP_TLS_CERTIFICATE1.0.0stringPath/File name of the TLS server certificate (in PEM format) for the http services.
OC_HTTP_TLS_KEY1.0.0stringPath/File name for the TLS certificate key (in PEM format) for the server certificate to use for the http services.
OC_KEYCLOAK_BASE_PATH
INVITATIONS_KEYCLOAK_BASE_PATH
1.0.0stringThe URL to access keycloak.
OC_KEYCLOAK_CLIENT_ID
INVITATIONS_KEYCLOAK_CLIENT_ID
1.0.0stringThe client ID to authenticate with keycloak.
OC_KEYCLOAK_CLIENT_SECRET
INVITATIONS_KEYCLOAK_CLIENT_SECRET
1.0.0stringThe client secret to use in authentication.
OC_KEYCLOAK_CLIENT_REALM
INVITATIONS_KEYCLOAK_CLIENT_REALM
1.0.0stringThe realm the client is defined in.
OC_KEYCLOAK_USER_REALM
INVITATIONS_KEYCLOAK_USER_REALM
1.0.0stringThe realm users are defined.
OC_KEYCLOAK_INSECURE_SKIP_VERIFY
INVITATIONS_KEYCLOAK_INSECURE_SKIP_VERIFY
1.0.0boolDisable TLS certificate validation for Keycloak connections. Do not set this in production environments.false
OC_JWT_SECRET
INVITATIONS_JWT_SECRET
1.0.0stringThe secret to mint and validate jwt tokens.