Skip to main content
Version: rolling

Environment Variables

Environment variables for the ocm service

NameIntroduction VersionTypeDescriptionDefault Value
OC_LOG_LEVEL
OCM_LOG_LEVEL
1.0.0stringThe log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'."error"
OCM_DEBUG_ADDR1.0.0stringBind address of the debug server, where metrics, health, config and debug endpoints will be exposed."127.0.0.1:9281"
OCM_DEBUG_TOKEN1.0.0stringToken to secure the metrics endpoint.""
OCM_DEBUG_PPROF1.0.0boolEnables pprof, which can be used for profiling."false"
OCM_DEBUG_ZPAGES1.0.0boolEnables zpages, which can be used for collecting and viewing in-memory traces."false"
OCM_HTTP_ADDR1.0.0stringThe bind address of the HTTP service."127.0.0.1:9280"
OCM_HTTP_PROTOCOL1.0.0stringThe transport protocol of the HTTP service."tcp"
OCM_HTTP_PREFIX1.0.0stringThe path prefix where OCM can be accessed (defaults to /).""
OC_CORS_ALLOW_ORIGINS
OCM_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
OCM_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."[OPTIONS HEAD GET PUT POST DELETE MKCOL PROPFIND PROPPATCH MOVE COPY REPORT SEARCH]"
OC_CORS_ALLOW_HEADERS
OCM_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."[Origin Accept Content-Type Depth Authorization Ocs-Apirequest If-None-Match If-Match Destination Overwrite X-Request-Id X-Requested-With Tus-Resumable Tus-Checksum-Algorithm Upload-Concat Upload-Length Upload-Metadata Upload-Defer-Length Upload-Expires Upload-Checksum Upload-Offset X-HTTP-Method-Override Cache-Control]"
OC_CORS_ALLOW_CREDENTIALS
OCM_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"
OCM_GRPC_ADDR1.0.0stringThe bind address of the GRPC service."127.0.0.1:9282"
OC_GRPC_PROTOCOL
OCM_GRPC_PROTOCOL
1.0.0stringThe transport protocol of the GRPC service.""
OC_SERVICE_ACCOUNT_ID
OCM_SERVICE_ACCOUNT_ID
1.0.0stringThe ID of the service account the service should use. See the 'auth-service' service description for more details.""
OC_SERVICE_ACCOUNT_SECRET
OCM_SERVICE_ACCOUNT_SECRET
1.0.0stringThe service account secret.""
OC_EVENTS_ENDPOINT
OCM_EVENTS_ENDPOINT
1.0.0stringThe address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture."127.0.0.1:9233"
OC_EVENTS_CLUSTER
OCM_EVENTS_CLUSTER
1.0.0stringThe clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system."opencloud-cluster"
OC_INSECURE
OC_EVENTS_TLS_INSECURE
OCM_EVENTS_TLS_INSECURE
1.0.0boolWhether to verify the server TLS certificates."false"
OC_EVENTS_TLS_ROOT_CA_CERTIFICATE
OCM_EVENTS_TLS_ROOT_CA_CERTIFICATE
1.0.0stringThe root CA certificate used to validate the server's TLS certificate. If provided OCM_EVENTS_TLS_INSECURE will be seen as false.""
OC_EVENTS_ENABLE_TLS
OCM_EVENTS_ENABLE_TLS
1.0.0boolEnable TLS for the connection to the events broker. The events broker is the OpenCloud service which receives and delivers events between the services."false"
OC_EVENTS_AUTH_USERNAME
OCM_EVENTS_AUTH_USERNAME
1.0.0stringThe username to authenticate with the events broker. The events broker is the OpenCloud service which receives and delivers events between the services.""
OC_EVENTS_AUTH_PASSWORD
OCM_EVENTS_AUTH_PASSWORD
1.0.0stringThe password to authenticate with the events broker. The events broker is the OpenCloud service which receives and delivers events between the services.""
OC_JWT_SECRET
OCM_JWT_SECRET
1.0.0stringThe secret to mint and validate jwt tokens.""
OC_REVA_GATEWAY1.0.0stringThe CS3 gateway endpoint."eu.opencloud.api.gateway"
OC_GRPC_CLIENT_TLS_MODE1.0.0stringTLS mode for grpc connection to the go-micro based grpc services. Possible values are 'off', 'insecure' and 'on'. 'off': disables transport security for the clients. 'insecure' allows using transport security, but disables certificate verification (to be used with the autogenerated self-signed certificates). 'on' enables transport security, including server certificate verification.""
OC_GRPC_CLIENT_TLS_CACERT1.0.0stringPath/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the go-micro based grpc services.""
OCM_OCMD_PREFIX1.0.0stringURL path prefix for the OCMD service. Note that the string must not start with '/'."ocm"
OCM_OCMD_EXPOSE_RECIPIENT_DISPLAY_NAME1.0.0boolExpose the display name of OCM share recipients."false"
OCM_SCIENCEMESH_PREFIX1.0.0stringURL path prefix for the ScienceMesh service. Note that the string must not start with '/'."sciencemesh"
OCM_MESH_DIRECTORY_URL1.0.0stringURL of the mesh directory service.""
OCM_DIRECTORY_SERVICE_URLS3.5.0stringSpace delimited URLs of the directory services.""
OCM_INVITE_ACCEPT_DIALOG3.5.0string/open-cloud-mesh/accept-invite;The frontend URL where to land when receiving an invitation"/open-cloud-mesh/accept-invite"
OC_INSECURE
OCM_CLIENT_INSECURE
6.0.0boolDev-only. Disable TLS verification for the OCM discovery client (directory fetch and provider discovery). Does not affect OCM invite manager, storage provider, or share provider. Do not set in production."false"
OCM_OCM_INVITE_MANAGER_DRIVER1.0.0stringDriver to be used to persist OCM invites. Supported value is only 'json'."json"
OCM_OCM_INVITE_MANAGER_JSON_FILE1.0.0stringPath to the JSON file where OCM invite data will be stored. This file is maintained by the instance and must not be changed manually. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage/ocm."/var/lib/opencloud/storage/ocm/ocminvites.json"
OCM_OCM_INVITE_MANAGER_TOKEN_EXPIRATION1.0.0DurationExpiry duration for invite tokens."24h0m0s"
OCM_OCM_INVITE_MANAGER_TIMEOUT1.0.0DurationTimeout specifies a time limit for requests made to OCM endpoints."30s"
OCM_OCM_INVITE_MANAGER_INSECURE1.0.0boolDisable TLS certificate validation for the OCM connections. Do not set this in production environments."false"
SHARING_OCM_PROVIDER_AUTHORIZER_DRIVER1.0.0stringDriver to be used to persist ocm invites. Supported value is only 'json'."json"
OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE1.0.0stringPath to the JSON file where ocm invite data will be stored. Defaults to $OC_CONFIG_DIR/ocmproviders.json."/etc/opencloud/ocmproviders.json"
OCM_OCM_SHARE_PROVIDER_DRIVER1.0.0stringDriver to be used for the OCM share provider. Supported value is only 'json'."json"
OCM_OCM_SHAREPROVIDER_JSON_FILE1.0.0stringPath to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage."/var/lib/opencloud/storage/ocm/ocmshares.json"
OCM_OCM_SHARE_PROVIDER_INSECURE1.0.0boolDisable TLS certificate validation for the OCM connections. Do not set this in production environments."false"
OCM_WEBAPP_TEMPLATE1.0.0stringTemplate for the webapp url.""
OCM_OCM_CORE_DRIVER1.0.0stringDriver to be used for the OCM core. Supported value is only 'json'."json"
OCM_OCM_CORE_JSON_FILE1.0.0stringPath to the JSON file where OCM share data will be stored. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage."/var/lib/opencloud/storage/ocm/ocmshares.json"
OCM_OCM_STORAGE_PROVIDER_INSECURE1.0.0boolDisable TLS certificate validation for the OCM connections. Do not set this in production environments."false"
OCM_OCM_STORAGE_PROVIDER_STORAGE_ROOT1.0.0stringDirectory where the ocm storage provider persists its data like tus upload info files."/var/lib/opencloud/storage/ocm"
OCM_OCM_STORAGE_DATA_SERVER_URL1.0.0stringURL of the data server, needs to be reachable by the data gateway provided by the frontend service or the user if directly exposed."http://localhost:9280/data"