Zum Hauptinhalt springen

Environment Variables

2025-05-22-16-21-09

Deprecation Notice

Deprecation InfoDeprecation VersionRemoval VersionDeprecation Replacement
next
Environment variables for the storage-users service
NameIntroduction VersionTypeDescriptionDefault Value
STORAGE_USERS_SERVICE_NAME1.0.0stringService name to use. Change this when starting an additional storage provider with a custom configuration to prevent it from colliding with the default 'storage-users' service.storage-users
OC_TRACING_ENABLED
STORAGE_USERS_TRACING_ENABLED
1.0.0boolActivates tracing.false
OC_TRACING_TYPE
STORAGE_USERS_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_USERS_TRACING_ENDPOINT
1.0.0stringThe endpoint of the tracing agent.
OC_TRACING_COLLECTOR
STORAGE_USERS_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_USERS_LOG_LEVEL
1.0.0stringThe log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'.
OC_LOG_PRETTY
STORAGE_USERS_LOG_PRETTY
1.0.0boolActivates pretty log output.false
OC_LOG_COLOR
STORAGE_USERS_LOG_COLOR
1.0.0boolActivates colorized log output.false
OC_LOG_FILE
STORAGE_USERS_LOG_FILE
1.0.0stringThe path to the log file. Activates logging to this file if set.
STORAGE_USERS_DEBUG_ADDR1.0.0stringBind address of the debug server, where metrics, health, config and debug endpoints will be exposed.127.0.0.1:9159
STORAGE_USERS_DEBUG_TOKEN1.0.0stringToken to secure the metrics endpoint.
STORAGE_USERS_DEBUG_PPROF1.0.0boolEnables pprof, which can be used for profiling.false
STORAGE_USERS_DEBUG_ZPAGES1.0.0boolEnables zpages, which can be used for collecting and viewing in-memory traces.false
STORAGE_USERS_GRPC_ADDR1.0.0stringThe bind address of the GRPC service.127.0.0.1:9157
OC_GRPC_PROTOCOL
STORAGE_USERS_GRPC_PROTOCOL
1.0.0stringThe transport protocol of the GPRC service.tcp
STORAGE_USERS_HTTP_ADDR1.0.0stringThe bind address of the HTTP service.127.0.0.1:9158
STORAGE_USERS_HTTP_PROTOCOL1.0.0stringThe transport protocol of the HTTP service.tcp
OC_CORS_ALLOW_ORIGINS
STORAGE_USERS_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
STORAGE_USERS_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.[POST HEAD PATCH OPTIONS GET DELETE]
OC_CORS_ALLOW_HEADERS
STORAGE_USERS_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.[Authorization Origin X-Requested-With X-Request-Id X-HTTP-Method-Override Content-Type Upload-Length Upload-Offset Tus-Resumable Upload-Metadata Upload-Defer-Length Upload-Concat Upload-Incomplete Upload-Draft-Interop-Version]
OC_CORS_ALLOW_CREDENTIALS
STORAGE_USERS_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_CORS_EXPOSE_HEADERS
STORAGE_USERS_CORS_EXPOSE_HEADERS
1.0.0[]stringA list of exposed CORS headers. See following chapter for more details: Access-Control-Expose-Headers at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers. See the Environment Variable Types description for more details.[Upload-Offset Location Upload-Length Tus-Version Tus-Resumable Tus-Max-Size Tus-Extension Upload-Metadata Upload-Defer-Length Upload-Concat Upload-Incomplete Upload-Draft-Interop-Version]
OC_CORS_MAX_AGE
STORAGE_USERS_CORS_MAX_AGE
1.0.0uintThe max cache duration of preflight headers. See following chapter for more details: Access-Control-Max-Age at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age. See the Environment Variable Types description for more details.86400
OC_JWT_SECRET
STORAGE_USERS_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.
STORAGE_USERS_SKIP_USER_GROUPS_IN_TOKEN1.0.0boolDisables the loading of user's group memberships from the reva access token.false
STORAGE_USERS_GRACEFUL_SHUTDOWN_TIMEOUT1.0.0intThe number of seconds to wait for the 'storage-users' service to shutdown cleanly before exiting with an error that gets logged. Note: This setting is only applicable when running the 'storage-users' service as a standalone service. See the text description for more details.30
STORAGE_USERS_DRIVER1.0.0stringThe storage driver which should be used by the service. Defaults to 'decomposed', Supported values are: 'decomposed', 'decomposeds3' and 'owncloudsql'. For backwards compatibility reasons it's also possible to use the 'ocis' and 's3ng' driver and configure them using the 'decomposed'/'decomposeds3' options. The 'decomposed' driver stores all data (blob and meta data) in an POSIX compliant volume. The 'decomposeds3' driver stores metadata in a POSIX compliant volume and uploads blobs to the s3 bucket.posix
OC_DECOMPOSEDFS_PROPAGATOR
STORAGE_USERS_DECOMPOSED_PROPAGATOR
1.0.0stringThe propagator used for decomposedfs. At the moment, only 'sync' is fully supported, 'async' is available as an experimental option.sync
STORAGE_USERS_ASYNC_PROPAGATOR_PROPAGATION_DELAY1.0.0DurationThe delay between a change made to a tree and the propagation start on treesize and treetime. Multiple propagations are computed to a single one. See the Environment Variable Types description for more details.0s
STORAGE_USERS_DECOMPOSED_ROOT1.0.0stringThe directory where the filesystem storage will store blobs and metadata. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage/users./home/chaser/.opencloud/storage/users
STORAGE_USERS_DECOMPOSED_USER_LAYOUT1.0.0stringTemplate string for the user storage layout in the user directory.{{.Id.OpaqueId}}
STORAGE_USERS_PERMISSION_ENDPOINT
STORAGE_USERS_DECOMPOSED_PERMISSIONS_ENDPOINT
1.0.0stringEndpoint of the permissions service. The endpoints can differ for 'decomposed' and 'decomposeds3'.eu.opencloud.api.settings
STORAGE_USERS_DECOMPOSED_PERSONAL_SPACE_ALIAS_TEMPLATE1.0.0stringTemplate string to construct personal space aliases.{{.SpaceType}}/{{.User.Username | lower}}
STORAGE_USERS_DECOMPOSED_PERSONAL_SPACE_PATH_TEMPLATE1.0.0stringTemplate string to construct the paths of the personal space roots.
STORAGE_USERS_DECOMPOSED_GENERAL_SPACE_ALIAS_TEMPLATE1.0.0stringTemplate string to construct general space aliases.{{.SpaceType}}/{{.SpaceName | replace " " "-" | lower}}
STORAGE_USERS_DECOMPOSED_GENERAL_SPACE_PATH_TEMPLATE1.0.0stringTemplate string to construct the paths of the projects space roots.
STORAGE_USERS_DECOMPOSED_SHARE_FOLDER1.0.0stringName of the folder jailing all shares./Shares
STORAGE_USERS_DECOMPOSED_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 will be used.20
STORAGE_USERS_DECOMPOSED_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 will be used.30
OC_MAX_CONCURRENCY
STORAGE_USERS_DECOMPOSED_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.5
OC_ASYNC_UPLOADS1.0.0boolEnable asynchronous file uploads.true
OC_SPACES_MAX_QUOTA
STORAGE_USERS_DECOMPOSED_MAX_QUOTA
1.0.0uint64Set a global max quota for spaces in bytes. A value of 0 equals unlimited. If not using the global OC_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA in the frontend service.0
OC_DISABLE_VERSIONING1.0.0boolDisables versioning of files. When set to true, new uploads with the same filename will overwrite existing files instead of creating a new version.false
OC_DECOMPOSEDFS_PROPAGATOR
STORAGE_USERS_DECOMPOSEDS3_PROPAGATOR
1.0.0stringThe propagator used for decomposedfs. At the moment, only 'sync' is fully supported, 'async' is available as an experimental option.sync
STORAGE_USERS_ASYNC_PROPAGATOR_PROPAGATION_DELAY1.0.0DurationThe delay between a change made to a tree and the propagation start on treesize and treetime. Multiple propagations are computed to a single one. See the Environment Variable Types description for more details.0s
STORAGE_USERS_DECOMPOSEDS3_ROOT1.0.0stringThe directory where the filesystem storage will store metadata for blobs. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage/users./home/chaser/.opencloud/storage/users
STORAGE_USERS_DECOMPOSEDS3_USER_LAYOUT1.0.0stringTemplate string for the user storage layout in the user directory.{{.Id.OpaqueId}}
STORAGE_USERS_PERMISSION_ENDPOINT
STORAGE_USERS_DECOMPOSEDS3_PERMISSIONS_ENDPOINT
1.0.0stringEndpoint of the permissions service. The endpoints can differ for 'decomposed' and 'decomposeds3'.eu.opencloud.api.settings
STORAGE_USERS_DECOMPOSEDS3_REGION1.0.0stringRegion of the S3 bucket.default
STORAGE_USERS_DECOMPOSEDS3_ACCESS_KEY1.0.0stringAccess key for the S3 bucket.
STORAGE_USERS_DECOMPOSEDS3_SECRET_KEY1.0.0stringSecret key for the S3 bucket.
STORAGE_USERS_DECOMPOSEDS3_ENDPOINT1.0.0stringEndpoint for the S3 bucket.
STORAGE_USERS_DECOMPOSEDS3_BUCKET1.0.0stringName of the S3 bucket.
STORAGE_USERS_DECOMPOSEDS3_PUT_OBJECT_DISABLE_CONTENT_SHA2561.0.0boolDisable sending content sha256 when copying objects to S3.false
STORAGE_USERS_DECOMPOSEDS3_PUT_OBJECT_DISABLE_MULTIPART1.0.0boolDisable multipart uploads when copying objects to S3true
STORAGE_USERS_DECOMPOSEDS3_PUT_OBJECT_SEND_CONTENT_MD51.0.0boolSend a Content-MD5 header when copying objects to S3.true
STORAGE_USERS_DECOMPOSEDS3_PUT_OBJECT_CONCURRENT_STREAM_PARTS1.0.0boolAlways precreate parts when copying objects to S3.true
STORAGE_USERS_DECOMPOSEDS3_PUT_OBJECT_NUM_THREADS1.0.0uintNumber of concurrent uploads to use when copying objects to S3.4
STORAGE_USERS_DECOMPOSEDS3_PUT_OBJECT_PART_SIZE1.0.0uint64Part size for concurrent uploads to S3. If no value or 0 is set, the library's default value of 16MB is used. The value range is min 5MB and max 5GB.0
STORAGE_USERS_DECOMPOSEDS3_PERSONAL_SPACE_ALIAS_TEMPLATE1.0.0stringTemplate string to construct personal space aliases.{{.SpaceType}}/{{.User.Username | lower}}
STORAGE_USERS_DECOMPOSEDS3_PERSONAL_SPACE_PATH_TEMPLATE1.0.0stringTemplate string to construct the paths of the personal space roots.
STORAGE_USERS_DECOMPOSEDS3_GENERAL_SPACE_ALIAS_TEMPLATE1.0.0stringTemplate string to construct general space aliases.{{.SpaceType}}/{{.SpaceName | replace " " "-" | lower}}
STORAGE_USERS_DECOMPOSEDS3_GENERAL_SPACE_PATH_TEMPLATE1.0.0stringTemplate string to construct the paths of the projects space roots.
STORAGE_USERS_DECOMPOSEDS3_SHARE_FOLDER1.0.0stringName of the folder jailing all shares./Shares
STORAGE_USERS_DECOMPOSEDS3_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_USERS_DECOMPOSEDS3_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
OC_MAX_CONCURRENCY
STORAGE_USERS_DECOMPOSEDS3_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 of 100 will be used.5
OC_ASYNC_UPLOADS1.0.0boolEnable asynchronous file uploads.true
OC_DISABLE_VERSIONING1.0.0boolDisables versioning of files. When set to true, new uploads with the same filename will overwrite existing files instead of creating a new version.false
STORAGE_USERS_OWNCLOUDSQL_DATADIR1.0.0stringThe directory where the filesystem storage will store SQL migration data. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage/owncloud./home/chaser/.opencloud/storage/owncloud
STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER1.0.0stringName of the folder jailing all shares./Shares
STORAGE_USERS_OWNCLOUDSQL_LAYOUT1.0.0stringPath layout to use to navigate into a users folder in an owncloud data directory{{.Username}}
STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR1.0.0stringThe directory where the filesystem will store uploads temporarily. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage/uploadinfo./home/chaser/.opencloud/storage/uploadinfo
STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME1.0.0stringUsername for the database.owncloud
STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD1.0.0stringPassword for the database.owncloud
STORAGE_USERS_OWNCLOUDSQL_DB_HOST1.0.0stringHostname or IP of the database server.
STORAGE_USERS_OWNCLOUDSQL_DB_PORT1.0.0intPort that the database server is listening on.3306
STORAGE_USERS_OWNCLOUDSQL_DB_NAME1.0.0stringName of the database to be used.owncloud
STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT1.0.0stringEndpoint of the users provider.eu.opencloud.api.users
STORAGE_USERS_POSIX_ROOT1.0.0stringThe directory where the filesystem storage will store its data. If not defined, the root directory derives from $OC_BASE_DATA_PATH/storage/users./home/chaser/.opencloud/storage/users
OC_DECOMPOSEDFS_PROPAGATOR
STORAGE_USERS_POSIX_PROPAGATOR
2.0.0stringThe propagator used for the posix driver. At the moment, only 'sync' is fully supported, 'async' is available as an experimental option.
STORAGE_USERS_ASYNC_PROPAGATOR_PROPAGATION_DELAY1.0.0DurationThe delay between a change made to a tree and the propagation start on treesize and treetime. Multiple propagations are computed to a single one. See the Environment Variable Types description for more details.0s
STORAGE_USERS_POSIX_PERSONAL_SPACE_ALIAS_TEMPLATE1.0.0stringTemplate string to construct personal space aliases.{{.SpaceType}}/{{.User.Username | lower}}
STORAGE_USERS_POSIX_PERSONAL_SPACE_PATH_TEMPLATE1.0.0stringTemplate string to construct the paths of the personal space roots.users/{{.User.Id.OpaqueId}}
STORAGE_USERS_POSIX_GENERAL_SPACE_ALIAS_TEMPLATE1.0.0stringTemplate string to construct general space aliases.{{.SpaceType}}/{{.SpaceName | replace " " "-" | lower}}
STORAGE_USERS_POSIX_GENERAL_SPACE_PATH_TEMPLATE1.0.0stringTemplate string to construct the paths of the projects space roots.projects/{{.SpaceId}}
STORAGE_USERS_PERMISSION_ENDPOINT
STORAGE_USERS_POSIX_PERMISSIONS_ENDPOINT
1.0.0stringEndpoint of the permissions service. The endpoints can differ for 'decomposed', 'posix' and 'decomposeds3'.eu.opencloud.api.settings
OC_ASYNC_UPLOADS1.0.0boolEnable asynchronous file uploads.true
STORAGE_USERS_POSIX_SCAN_DEBOUNCE_DELAY1.0.0DurationThe time in milliseconds to wait before scanning the filesystem for changes after a change has been detected.1s
OC_SPACES_MAX_QUOTA
STORAGE_USERS_POSIX_MAX_QUOTA
2.0.0uint64Set a global max quota for spaces in bytes. A value of 0 equals unlimited. If not using the global OC_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA in the frontend service.0
STORAGE_USERS_POSIX_MAX_ACQUIRE_LOCK_CYCLES2.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 will be used.0
STORAGE_USERS_POSIX_LOCK_CYCLE_DURATION_FACTOR2.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 will be used.0
OC_MAX_CONCURRENCY
STORAGE_USERS_POSIX_MAX_CONCURRENCY
2.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.0
OC_DISABLE_VERSIONING2.0.0boolDisables versioning of files. When set to true, new uploads with the same filename will overwrite existing files instead of creating a new version.false
STORAGE_USERS_POSIX_USE_SPACE_GROUPS1.0.0boolUse space groups to manage permissions on spaces.false
STORAGE_USERS_POSIX_ENABLE_FS_REVISIONS1.0.0boolAllow for generating revisions from changes done to the local storage. Note: This doubles the number of bytes stored on disk because a copy of the current revision is stored to be turned into a revision later.false
STORAGE_USERS_POSIX_WATCH_FS2.0.0boolEnable the filesystem watcher to detect changes to the filesystem. This is used to detect changes to the filesystem and update the metadata accordingly.false
STORAGE_USERS_POSIX_WATCH_TYPE1.0.0stringType of the watcher to use for getting notified about changes to the filesystem. Currently available options are 'inotifywait' (default), 'cephfs', 'gpfswatchfolder' and 'gpfsfileauditlogging'.
STORAGE_USERS_POSIX_WATCH_PATH1.0.0stringPath to the watch directory/file. Only applies to the 'gpfsfileauditlogging' and 'inotifywait' watcher, in which case it is the path of the file audit log file/base directory to watch.
STORAGE_USERS_POSIX_WATCH_NOTIFICATION_BROKERS,STORAGE_USERS_POSIX_WATCH_FOLDER_KAFKA_BROKERS1.0.0stringComma-separated list of kafka brokers to read the watchfolder events from.
STORAGE_USERS_POSIX_WATCH_ROOTnextstringPath to the watch root directory. Event paths will be considered relative to this path. Only applies to the 'gpswatchfolder' and 'cephfs' watchers.
STORAGE_USERS_POSIX_INOTIFY_STATS_FREQUENCYnextDurationFrequency to log inotify stats.5m0s
STORAGE_USERS_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:9158/data
STORAGE_USERS_DATA_GATEWAY_URL1.0.0stringURL of the data gateway serverhttps://localhost:9200/data
STORAGE_USERS_TRANSFER_EXPIRES1.0.0int64The time after which the token for upload postprocessing expires86400
OC_EVENTS_ENDPOINT
STORAGE_USERS_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
STORAGE_USERS_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
STORAGE_USERS_EVENTS_TLS_INSECURE
1.0.0boolWhether to verify the server TLS certificates.false
OC_EVENTS_TLS_ROOT_CA_CERTIFICATE
STORAGE_USERS_EVENTS_TLS_ROOT_CA_CERTIFICATE
1.0.0stringThe root CA certificate used to validate the server's TLS certificate. If provided STORAGE_USERS_EVENTS_TLS_INSECURE will be seen as false.
OC_EVENTS_ENABLE_TLS
STORAGE_USERS_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
STORAGE_USERS_EVENTS_NUM_CONSUMERS1.0.0intThe amount of concurrent event consumers to start. Event consumers are used for post-processing files. Multiple consumers increase parallelisation, but will also increase CPU and memory demands. The setting has no effect when the OC_ASYNC_UPLOADS is set to false. The default and minimum value is 1.0
OC_EVENTS_AUTH_USERNAME
STORAGE_USERS_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
STORAGE_USERS_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_CACHE_STORE
STORAGE_USERS_FILEMETADATA_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_USERS_FILEMETADATA_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-users
OC_CACHE_TTL
STORAGE_USERS_FILEMETADATA_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_USERS_FILEMETADATA_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_USERS_FILEMETADATA_CACHE_AUTH_USERNAME
1.0.0stringThe username to authenticate with the cache store. Only applies when store type 'nats-js-kv' is configured.
OC_CACHE_AUTH_PASSWORD
STORAGE_USERS_FILEMETADATA_CACHE_AUTH_PASSWORD
1.0.0stringThe password to authenticate with the cache store. Only applies when store type 'nats-js-kv' is configured.
OC_CACHE_STORE
STORAGE_USERS_ID_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.nats-js-kv
OC_CACHE_STORE_NODES
STORAGE_USERS_ID_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.ids-storage-users
OC_CACHE_TTL
STORAGE_USERS_ID_CACHE_TTL
1.0.0DurationDefault time to live for user info in the user info cache. Only applied when access tokens have no expiration. Defaults to 300s which is derived from the underlaying package though not explicitly set as default. See the Environment Variable Types description for more details.24m0s
OC_CACHE_DISABLE_PERSISTENCE
STORAGE_USERS_ID_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_USERS_ID_CACHE_AUTH_USERNAME
1.0.0stringThe username to authenticate with the cache store. Only applies when store type 'nats-js-kv' is configured.
OC_CACHE_AUTH_PASSWORD
STORAGE_USERS_ID_CACHE_AUTH_PASSWORD
1.0.0stringThe password to authenticate with the cache store. Only applies when store type 'nats-js-kv' is configured.
STORAGE_USERS_MOUNT_ID1.0.0stringMount ID of this storage.
STORAGE_USERS_EXPOSE_DATA_SERVER1.0.0boolExposes the data server directly to users and bypasses the data gateway. Ensure that the data server address is reachable by users.false
STORAGE_USERS_READ_ONLY1.0.0boolSet this storage to be read-only.false
STORAGE_USERS_UPLOAD_EXPIRATION1.0.0int64Duration in seconds after which uploads will expire. Note that when setting this to a low number, uploads could be cancelled before they are finished and return a 403 to the user.86400
OC_ADMIN_USER_ID
STORAGE_USERS_PURGE_TRASH_BIN_USER_ID
1.0.0stringID of the user who collects all necessary information for deletion. Consider that the UUID can be encoded in some LDAP deployment configurations like in .ldif files. These need to be decoded beforehand.
STORAGE_USERS_PURGE_TRASH_BIN_PERSONAL_DELETE_BEFORE1.0.0DurationSpecifies the period of time in which items that have been in the personal trash-bin for longer than this value should be deleted. A value of 0 means no automatic deletion. See the Environment Variable Types description for more details.720h0m0s
STORAGE_USERS_PURGE_TRASH_BIN_PROJECT_DELETE_BEFORE1.0.0DurationSpecifies the period of time in which items that have been in the project trash-bin for longer than this value should be deleted. A value of 0 means no automatic deletion. See the Environment Variable Types description for more details.720h0m0s
OC_SERVICE_ACCOUNT_ID
STORAGE_USERS_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
STORAGE_USERS_SERVICE_ACCOUNT_SECRET
1.0.0stringThe service account secret.
OC_GATEWAY_GRPC_ADDR
STORAGE_USERS_GATEWAY_GRPC_ADDR
1.0.0stringThe bind address of the gateway GRPC address.127.0.0.1:9142
OC_MACHINE_AUTH_API_KEY
STORAGE_USERS_MACHINE_AUTH_API_KEY
1.0.0stringMachine auth API key used to validate internal requests necessary for the access to resources from other services.
STORAGE_USERS_CLI_MAX_ATTEMPTS_RENAME_FILE1.0.0intThe maximum number of attempts to rename a file when a user restores a file to an existing destination with the same name. The minimum value is 100.0