Environment Variables
Environment variables for the sharing service
| Name | Introduction Version | Type | Description | Default Value |
|---|---|---|---|---|
OC_TRACING_ENABLEDSHARING_TRACING_ENABLED | 1.0.0 | bool | Activates tracing. | false |
OC_TRACING_TYPESHARING_TRACING_TYPE | 1.0.0 | string | The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now. | |
OC_TRACING_ENDPOINTSHARING_TRACING_ENDPOINT | 1.0.0 | string | The endpoint of the tracing agent. | |
OC_TRACING_COLLECTORSHARING_TRACING_COLLECTOR | 1.0.0 | string | The 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_LEVELSHARING_LOG_LEVEL | 1.0.0 | string | The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'. | |
OC_LOG_PRETTYSHARING_LOG_PRETTY | 1.0.0 | bool | Activates pretty log output. | false |
OC_LOG_COLORSHARING_LOG_COLOR | 1.0.0 | bool | Activates colorized log output. | false |
OC_LOG_FILESHARING_LOG_FILE | 1.0.0 | string | The path to the log file. Activates logging to this file if set. | |
SHARING_DEBUG_ADDR | 1.0.0 | string | Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. | 127.0.0.1:9151 |
SHARING_DEBUG_TOKEN | 1.0.0 | string | Token to secure the metrics endpoint. | |
SHARING_DEBUG_PPROF | 1.0.0 | bool | Enables pprof, which can be used for profiling. | false |
SHARING_DEBUG_ZPAGES | 1.0.0 | bool | Enables zpages, which can be used for collecting and viewing in-memory traces. | false |
SHARING_GRPC_ADDR | 1.0.0 | string | The bind address of the GRPC service. | 127.0.0.1:9150 |
OC_GRPC_PROTOCOLSHARING_GRPC_PROTOCOL | 1.0.0 | string | The transport protocol of the GRPC service. | tcp |
OC_JWT_SECRETSHARING_JWT_SECRET | 1.0.0 | string | The secret to mint and validate jwt tokens. | |
OC_REVA_GATEWAY | 1.0.0 | string | The CS3 gateway endpoint. | eu.opencloud.api.gateway |
OC_GRPC_CLIENT_TLS_MODE | 1.0.0 | string | TLS 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_CACERT | 1.0.0 | string | Path/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_ENDPOINTSHARING_EVENTS_ENDPOINT | 1.0.0 | string | The 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_CLUSTERSHARING_EVENTS_CLUSTER | 1.0.0 | string | The 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_INSECURESHARING_EVENTS_TLS_INSECURE | 1.0.0 | bool | Whether to verify the server TLS certificates. | false |
OC_EVENTS_TLS_ROOT_CA_CERTIFICATESHARING_EVENTS_TLS_ROOT_CA_CERTIFICATE | 1.0.0 | string | The 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_TLSSHARING_EVENTS_ENABLE_TLS | 1.0.0 | bool | Enable 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_USERNAMESHARING_EVENTS_AUTH_USERNAME | 1.0.0 | string | Username for the events broker. | |
OC_EVENTS_AUTH_PASSWORDSHARING_EVENTS_AUTH_PASSWORD | 1.0.0 | string | Password for the events broker. | |
SHARING_SKIP_USER_GROUPS_IN_TOKEN | 1.0.0 | bool | Disables the loading of user's group memberships from the reva access token. | false |
SHARING_USER_DRIVER | 1.0.0 | string | Driver to be used to persist shares. Supported values are 'jsoncs3', 'json', 'cs3' (deprecated) and 'owncloudsql'. | jsoncs3 |
SHARING_USER_JSONCS3_PROVIDER_ADDR | 1.0.0 | string | GRPC address of the STORAGE-SYSTEM service. | eu.opencloud.api.storage-system |
OC_SYSTEM_USER_IDSHARING_USER_JSONCS3_SYSTEM_USER_ID | 1.0.0 | string | ID 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_IDPSHARING_USER_JSONCS3_SYSTEM_USER_IDP | 1.0.0 | string | IDP of the OpenCloud STORAGE-SYSTEM system user. | internal |
OC_SYSTEM_USER_API_KEYSHARING_USER_JSONCS3_SYSTEM_USER_API_KEY | 1.0.0 | string | API key for the STORAGE-SYSTEM system user. | |
SHARING_USER_JSONCS3_CACHE_TTL | 1.0.0 | int | TTL for the internal caches in seconds. | 0 |
OC_MAX_CONCURRENCYSHARING_USER_JSONCS3_MAX_CONCURRENCY | 1.0.0 | int | Maximum 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_FILE | 1.0.0 | string | Path to the JSON file where shares will be persisted. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage. | /home/chaser/.opencloud/storage/shares.json |
SHARING_USER_CS3_PROVIDER_ADDR | 1.0.0 | string | GRPC address of the STORAGE-SYSTEM service. | eu.opencloud.api.storage-system |
OC_SYSTEM_USER_IDSHARING_USER_CS3_SYSTEM_USER_ID | 1.0.0 | string | ID 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_IDPSHARING_USER_CS3_SYSTEM_USER_IDP | 1.0.0 | string | IDP of the OpenCloud STORAGE-SYSTEM system user. | internal |
OC_SYSTEM_USER_API_KEYSHARING_USER_CS3_SYSTEM_USER_API_KEY | 1.0.0 | string | API key for the STORAGE-SYSTEM system user. | |
SHARING_USER_OWNCLOUDSQL_DB_USERNAME | 1.0.0 | string | Username for the database. | owncloud |
SHARING_USER_OWNCLOUDSQL_DB_PASSWORD | 1.0.0 | string | Password for the database. | |
SHARING_USER_OWNCLOUDSQL_DB_HOST | 1.0.0 | string | Hostname or IP of the database server. | mysql |
SHARING_USER_OWNCLOUDSQL_DB_PORT | 1.0.0 | int | Port that the database server is listening on. | 3306 |
SHARING_USER_OWNCLOUDSQL_DB_NAME | 1.0.0 | string | Name of the database to be used. | owncloud |
SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID | 1.0.0 | string | Mount ID of the ownCloudSQL users storage for mapping ownCloud 10 shares. | |
SHARING_PUBLIC_DRIVER | 1.0.0 | string | Driver to be used to persist public shares. Supported values are 'jsoncs3', 'json' and 'cs3' (deprecated). | jsoncs3 |
SHARING_PUBLIC_JSON_FILE | 1.0.0 | string | Path 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. | /home/chaser/.opencloud/storage/publicshares.json |
SHARING_PUBLIC_JSONCS3_PROVIDER_ADDR | 1.0.0 | string | GRPC address of the STORAGE-SYSTEM service. | eu.opencloud.api.storage-system |
OC_SYSTEM_USER_IDSHARING_PUBLIC_JSONCS3_SYSTEM_USER_ID | 1.0.0 | string | ID 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_IDPSHARING_PUBLIC_JSONCS3_SYSTEM_USER_IDP | 1.0.0 | string | IDP of the OpenCloud STORAGE-SYSTEM system user. | internal |
OC_SYSTEM_USER_API_KEYSHARING_PUBLIC_JSONCS3_SYSTEM_USER_API_KEY | 1.0.0 | string | API key for the STORAGE-SYSTEM system user. | |
SHARING_PUBLIC_CS3_PROVIDER_ADDR | 1.0.0 | string | GRPC address of the STORAGE-SYSTEM service. | eu.opencloud.api.storage-system |
OC_SYSTEM_USER_IDSHARING_PUBLIC_CS3_SYSTEM_USER_ID | 1.0.0 | string | ID 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_IDPSHARING_PUBLIC_CS3_SYSTEM_USER_IDP | 1.0.0 | string | IDP of the OpenCloud STORAGE-SYSTEM system user. | internal |
OC_SYSTEM_USER_API_KEYSHARING_PUBLIC_CS3_SYSTEM_USER_API_KEY | 1.0.0 | string | API key for the STORAGE-SYSTEM system user. | |
OC_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORDSHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD | 1.0.0 | bool | Set 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_PASSWORDSHARING_PUBLIC_SHARE_MUST_HAVE_PASSWORD | 1.0.0 | bool | Set this to true if you want to enforce passwords on all public shares. | true |
OC_PASSWORD_POLICY_DISABLEDSHARING_PASSWORD_POLICY_DISABLED | 1.0.0 | bool | Disable the password policy. Defaults to false if not set. | false |
OC_PASSWORD_POLICY_MIN_CHARACTERSSHARING_PASSWORD_POLICY_MIN_CHARACTERS | 1.0.0 | int | Define the minimum password length. Defaults to 8 if not set. | 8 |
OC_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERSSHARING_PASSWORD_POLICY_MIN_LOWERCASE_CHARACTERS | 1.0.0 | int | Define the minimum number of uppercase letters. Defaults to 1 if not set. | 1 |
OC_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERSSHARING_PASSWORD_POLICY_MIN_UPPERCASE_CHARACTERS | 1.0.0 | int | Define the minimum number of lowercase letters. Defaults to 1 if not set. | 1 |
OC_PASSWORD_POLICY_MIN_DIGITSSHARING_PASSWORD_POLICY_MIN_DIGITS | 1.0.0 | int | Define the minimum number of digits. Defaults to 1 if not set. | 1 |
OC_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERSSHARING_PASSWORD_POLICY_MIN_SPECIAL_CHARACTERS | 1.0.0 | int | Define 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_LISTSHARING_PASSWORD_POLICY_BANNED_PASSWORDS_LIST | 1.0.0 | string | Path to the 'banned passwords list' file. This only impacts public link password validation. See the documentation for more details. |