Skip to main content
Version: rolling

Environment Variables

Environment variables for the sharing service

NameIntroduction VersionTypeDescriptionDefault Value
OC_LOG_LEVEL
SHARING_LOG_LEVEL
1.0.0stringThe log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'."error"
SHARING_DEBUG_ADDR1.0.0stringBind address of the debug server, where metrics, health, config and debug endpoints will be exposed."127.0.0.1:9151"
SHARING_DEBUG_TOKEN1.0.0stringToken to secure the metrics endpoint.""
SHARING_DEBUG_PPROF1.0.0boolEnables pprof, which can be used for profiling."false"
SHARING_DEBUG_ZPAGES1.0.0boolEnables zpages, which can be used for collecting and viewing in-memory traces."false"
SHARING_GRPC_ADDR1.0.0stringThe bind address of the GRPC service."127.0.0.1:9150"
OC_GRPC_PROTOCOL
SHARING_GRPC_PROTOCOL
1.0.0stringThe transport protocol of the GRPC service."tcp"
OC_JWT_SECRET
SHARING_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.""
OC_EVENTS_ENDPOINT
SHARING_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
SHARING_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
SHARING_EVENTS_TLS_INSECURE
1.0.0boolWhether to verify the server TLS certificates."false"
OC_EVENTS_TLS_ROOT_CA_CERTIFICATE
SHARING_EVENTS_TLS_ROOT_CA_CERTIFICATE
1.0.0stringThe root CA certificate used to validate the server's TLS certificate. If provided SHARING_EVENTS_TLS_INSECURE will be seen as false.""
OC_EVENTS_ENABLE_TLS
SHARING_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
SHARING_EVENTS_AUTH_USERNAME
1.0.0stringUsername for the events broker.""
OC_EVENTS_AUTH_PASSWORD
SHARING_EVENTS_AUTH_PASSWORD
1.0.0stringPassword for the events broker.""
OC_SERVICE_ACCOUNT_ID
SHARING_SERVICE_ACCOUNT
7.0.0stringThe ID of the service account the service should use. See the 'auth-service' service description for more details.""
OC_SERVICE_ACCOUNT_SECRET
SHARING_SERVICE_ACCOUNT_SECRET
7.0.0stringThe service account secret.""
SHARING_SKIP_USER_GROUPS_IN_TOKEN1.0.0boolDisables the loading of user's group memberships from the reva access token."false"
SHARING_USER_DRIVER1.0.0stringDriver to be used to persist shares. Supported values are 'jsoncs3', 'json', 'cs3' (deprecated) and 'owncloudsql'."jsoncs3"
SHARING_USER_JSONCS3_PROVIDER_ADDR1.0.0stringGRPC address of the STORAGE-SYSTEM service."eu.opencloud.api.storage-system"
OC_SYSTEM_USER_ID
SHARING_USER_JSONCS3_SYSTEM_USER_ID
1.0.0stringID of the OpenCloud STORAGE-SYSTEM system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format.""
OC_SYSTEM_USER_IDP
SHARING_USER_JSONCS3_SYSTEM_USER_IDP
1.0.0stringIDP of the OpenCloud STORAGE-SYSTEM system user."internal"
OC_SYSTEM_USER_API_KEY
SHARING_USER_JSONCS3_SYSTEM_USER_API_KEY
1.0.0stringAPI key for the STORAGE-SYSTEM system user.""
SHARING_USER_JSONCS3_CACHE_TTL1.0.0intTTL for the internal caches in seconds."0"
OC_MAX_CONCURRENCY
SHARING_USER_JSONCS3_MAX_CONCURRENCY
1.0.0intMaximum number of concurrent go-routines. Higher values can potentially get work done faster but will also cause more load on the system. Values of 0 or below will be ignored and the default value will be used."1"
SHARING_USER_JSON_FILE1.0.0stringPath to the JSON file where shares will be persisted. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage."/var/lib/opencloud/storage/shares.json"
SHARING_USER_CS3_PROVIDER_ADDR1.0.0stringGRPC address of the STORAGE-SYSTEM service."eu.opencloud.api.storage-system"
OC_SYSTEM_USER_ID
SHARING_USER_CS3_SYSTEM_USER_ID
1.0.0stringID of the OpenCloud STORAGE-SYSTEM system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format.""
OC_SYSTEM_USER_IDP
SHARING_USER_CS3_SYSTEM_USER_IDP
1.0.0stringIDP of the OpenCloud STORAGE-SYSTEM system user."internal"
OC_SYSTEM_USER_API_KEY
SHARING_USER_CS3_SYSTEM_USER_API_KEY
1.0.0stringAPI key for the STORAGE-SYSTEM system user.""
SHARING_USER_OWNCLOUDSQL_DB_USERNAME1.0.0stringUsername for the database."owncloud"
SHARING_USER_OWNCLOUDSQL_DB_PASSWORD1.0.0stringPassword for the database.""
SHARING_USER_OWNCLOUDSQL_DB_HOST1.0.0stringHostname or IP of the database server."mysql"
SHARING_USER_OWNCLOUDSQL_DB_PORT1.0.0intPort that the database server is listening on."3306"
SHARING_USER_OWNCLOUDSQL_DB_NAME1.0.0stringName of the database to be used."owncloud"
SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID1.0.0stringMount ID of the ownCloudSQL users storage for mapping ownCloud 10 shares.""
SHARING_PUBLIC_DRIVER1.0.0stringDriver to be used to persist public shares. Supported values are 'jsoncs3', 'json' and 'cs3' (deprecated)."jsoncs3"
SHARING_PUBLIC_JSON_FILE1.0.0stringPath to the JSON file where public share meta-data will be stored. This JSON file contains the information about public shares that have been created. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage."/var/lib/opencloud/storage/publicshares.json"
SHARING_PUBLIC_JSONCS3_PROVIDER_ADDR1.0.0stringGRPC address of the STORAGE-SYSTEM service."eu.opencloud.api.storage-system"
OC_SYSTEM_USER_ID
SHARING_PUBLIC_JSONCS3_SYSTEM_USER_ID
1.0.0stringID of the OpenCloud STORAGE-SYSTEM system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format.""
OC_SYSTEM_USER_IDP
SHARING_PUBLIC_JSONCS3_SYSTEM_USER_IDP
1.0.0stringIDP of the OpenCloud STORAGE-SYSTEM system user."internal"
OC_SYSTEM_USER_API_KEY
SHARING_PUBLIC_JSONCS3_SYSTEM_USER_API_KEY
1.0.0stringAPI key for the STORAGE-SYSTEM system user.""
SHARING_PUBLIC_CS3_PROVIDER_ADDR1.0.0stringGRPC address of the STORAGE-SYSTEM service."eu.opencloud.api.storage-system"
OC_SYSTEM_USER_ID
SHARING_PUBLIC_CS3_SYSTEM_USER_ID
1.0.0stringID of the OpenCloud STORAGE-SYSTEM system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format.""
OC_SYSTEM_USER_IDP
SHARING_PUBLIC_CS3_SYSTEM_USER_IDP
1.0.0stringIDP of the OpenCloud STORAGE-SYSTEM system user."internal"
OC_SYSTEM_USER_API_KEY
SHARING_PUBLIC_CS3_SYSTEM_USER_API_KEY
1.0.0stringAPI key for the STORAGE-SYSTEM system user.""
OC_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD
SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD
1.0.0boolSet this to true if you want to enforce passwords on Uploader, Editor or Contributor shares. If not using the global OC_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD, you must define the FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD (deprecated) in the frontend service."false"
OC_SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD
SHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD
1.0.0boolSet this to true if you want to enforce passwords on all public shares."true"
OC_PASSWORD_POLICY_DISABLED
SHARING_PASSWORD_POLICY_DISABLED
1.0.0boolDisable the password policy. Defaults to false if not set."false"
OC_PASSWORD_POLICY_MIN_CHARACTERS
SHARING_PASSWORD_POLICY_MIN_CHARACTERS
1.0.0intDefine the minimum password length. Defaults to 8 if not set."8"
OC_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS
SHARING_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS
1.0.0intDefine the minimum number of uppercase letters. Defaults to 1 if not set."1"
OC_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS
SHARING_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS
1.0.0intDefine the minimum number of lowercase letters. Defaults to 1 if not set."1"
OC_PASSWORD_POLICY_MIN_DIGITS
SHARING_PASSWORD_POLICY_MIN_DIGITS
1.0.0intDefine the minimum number of digits. Defaults to 1 if not set."1"
OC_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS
SHARING_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS
1.0.0intDefine the minimum number of characters from the special characters list to be present. Defaults to 1 if not set."1"
OC_PASSWORD_POLICY_BANNED_PASSWORDS_LIST
SHARING_PASSWORD_POLICY_BANNED_PASSWORDS_LIST
1.0.0stringPath to the 'banned passwords list' file. This only impacts public link password validation. See the documentation for more details.""