Zum Hauptinhalt springen

Environment Variables

Environment variables for the storage-system service

NameIntroduction VersionTypeDescriptionDefault Value
OC_TRACING_ENABLED
STORAGE_SYSTEM_TRACING_ENABLED		1.0.0boolActivates tracing.false
OC_TRACING_TYPE
STORAGE_SYSTEM_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
STORAGE_SYSTEM_TRACING_ENDPOINT		1.0.0stringThe endpoint of the tracing agent.
OC_TRACING_COLLECTOR
STORAGE_SYSTEM_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
STORAGE_SYSTEM_LOG_LEVEL		1.0.0stringThe log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'.
OC_LOG_PRETTY
STORAGE_SYSTEM_LOG_PRETTY		1.0.0boolActivates pretty log output.false
OC_LOG_COLOR
STORAGE_SYSTEM_LOG_COLOR		1.0.0boolActivates colorized log output.false
OC_LOG_FILE
STORAGE_SYSTEM_LOG_FILE		1.0.0stringThe path to the log file. Activates logging to this file if set.
STORAGE_SYSTEM_DEBUG_ADDR1.0.0stringBind address of the debug server, where metrics, health, config and debug endpoints will be exposed.127.0.0.1:9217
STORAGE_SYSTEM_DEBUG_TOKEN1.0.0stringToken to secure the metrics endpoint
STORAGE_SYSTEM_DEBUG_PPROF1.0.0boolEnables pprof, which can be used for profilingfalse
STORAGE_SYSTEM_DEBUG_ZPAGES1.0.0boolEnables zpages, which can be used for collecting and viewing in-memory traces.false
STORAGE_SYSTEM_GRPC_ADDR1.0.0stringThe bind address of the GRPC service.127.0.0.1:9215
OC_GRPC_PROTOCOL
STORAGE_SYSTEM_GRPC_PROTOCOL		1.0.0stringThe transport protocol of the GPRC service.tcp
STORAGE_SYSTEM_HTTP_ADDR1.0.0stringThe bind address of the HTTP service.127.0.0.1:9216
STORAGE_SYSTEM_HTTP_PROTOCOL1.0.0stringThe transport protocol of the HTTP service.tcp
OC_JWT_SECRET
STORAGE_SYSTEM_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_SYSTEM_USER_ID1.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_API_KEY1.0.0stringAPI key for the STORAGE-SYSTEM system user.
STORAGE_SYSTEM_SKIP_USER_GROUPS_IN_TOKEN1.0.0boolDisables the loading of user's group memberships from the reva access token.false
OC_CACHE_STORE
STORAGE_SYSTEM_CACHE_STORE		1.0.0stringThe type of the cache store. Supported values are: 'memory', 'redis-sentinel', 'nats-js-kv', 'noop'. See the text description for details.memory
OC_CACHE_STORE_NODES
STORAGE_SYSTEM_CACHE_STORE_NODES		1.0.0[]stringA list of nodes to access the configured store. This has no effect when 'memory' store is configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details.[127.0.0.1:9233]
OC_CACHE_DATABASE1.0.0stringThe database name the configured store should use.storage-system
OC_CACHE_TTL
STORAGE_SYSTEM_CACHE_TTL		1.0.0DurationDefault time to live for user info in the user info cache. Only applied when access tokens has no expiration. See the Environment Variable Types description for more details.24m0s
OC_CACHE_DISABLE_PERSISTENCE
STORAGE_SYSTEM_CACHE_DISABLE_PERSISTENCE		1.0.0boolDisables persistence of the cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false.false
OC_CACHE_AUTH_USERNAME
STORAGE_SYSTEM_CACHE_AUTH_USERNAME		1.0.0stringUsername for the configured store. Only applies when store type 'nats-js-kv' is configured.
OC_CACHE_AUTH_PASSWORD
STORAGE_SYSTEM_CACHE_AUTH_PASSWORD		1.0.0stringPassword for the configured store. Only applies when store type 'nats-js-kv' is configured.
STORAGE_SYSTEM_DRIVER1.0.0stringThe driver which should be used by the service. The only supported driver is 'decomposed'. For backwards compatibility reasons it's also possible to use the 'ocis' driver and configure it using the 'decomposed' options.decomposed
STORAGE_SYSTEM_OC_ROOT1.0.0stringPath for the directory where the STORAGE-SYSTEM service stores it's persistent data. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage./home/chaser/.opencloud/storage/metadata
STORAGE_SYSTEM_OC_MAX_ACQUIRE_LOCK_CYCLES1.0.0intWhen trying to lock files, OpenCloud will try this amount of times to acquire the lock before failing. After each try it will wait for an increasing amount of time. Values of 0 or below will be ignored and the default value of 20 will be used.20
STORAGE_SYSTEM_OC_LOCK_CYCLE_DURATION_FACTOR1.0.0intWhen trying to lock files, OpenCloud will multiply the cycle with this factor and use it as a millisecond timeout. Values of 0 or below will be ignored and the default value of 30 will be used.30
STORAGE_SYSTEM_DATA_SERVER_URL1.0.0stringURL of the data server, needs to be reachable by other services using this service.http://localhost:9216/data