Environment Variables
Environment variables for the gateway service
| Name | Introduction Version | Type | Description | Default Value |
|---|---|---|---|---|
OC_TRACING_ENABLEDGATEWAY_TRACING_ENABLED | 1.0.0 | bool | Activates tracing. | false |
OC_TRACING_TYPEGATEWAY_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_ENDPOINTGATEWAY_TRACING_ENDPOINT | 1.0.0 | string | The endpoint of the tracing agent. | |
OC_TRACING_COLLECTORGATEWAY_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_LEVELGATEWAY_LOG_LEVEL | 1.0.0 | string | The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'. | |
OC_LOG_PRETTYGATEWAY_LOG_PRETTY | 1.0.0 | bool | Activates pretty log output. | false |
OC_LOG_COLORGATEWAY_LOG_COLOR | 1.0.0 | bool | Activates colorized log output. | false |
OC_LOG_FILEGATEWAY_LOG_FILE | 1.0.0 | string | The path to the log file. Activates logging to this file if set. | |
GATEWAY_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:9143 |
GATEWAY_DEBUG_TOKEN | 1.0.0 | string | Token to secure the metrics endpoint. | |
GATEWAY_DEBUG_PPROF | 1.0.0 | bool | Enables pprof, which can be used for profiling. | false |
GATEWAY_DEBUG_ZPAGES | 1.0.0 | bool | Enables zpages, which can be used for collecting and viewing in-memory traces. | false |
OC_GATEWAY_GRPC_ADDRGATEWAY_GRPC_ADDR | 1.0.0 | string | The bind address of the GRPC service. | 127.0.0.1:9142 |
OC_GRPC_PROTOCOLGATEWAY_GRPC_PROTOCOL | 1.0.0 | string | The transport protocol of the GRPC service. | tcp |
OC_JWT_SECRETGATEWAY_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. | |
GATEWAY_SKIP_USER_GROUPS_IN_TOKEN | 1.0.0 | bool | Disables the loading of user's group memberships from the reva access token. | false |
GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT | 1.0.0 | bool | Commit shares to storage grants. This grants access to shared resources for the share receiver directly on the storage. | true |
GATEWAY_SHARE_FOLDER_NAME | 1.0.0 | string | Name of the share folder in users' home space. | Shares |
GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN | 1.0.0 | bool | Disable creation of the home space on login. | true |
OC_TRANSFER_SECRET | 1.0.0 | string | The storage transfer secret. | |
GATEWAY_TRANSFER_EXPIRES | 1.0.0 | int | Expiry for the gateway tokens. | 86400 |
OC_CACHE_STOREGATEWAY_PROVIDER_CACHE_STORE | 1.0.0 | string | The type of the cache store. Supported values are: 'memory', 'redis-sentinel', 'nats-js-kv', 'noop'. See the text description for details. | noop |
OC_CACHE_STORE_NODESGATEWAY_PROVIDER_CACHE_STORE_NODES | 1.0.0 | []string | A 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_DATABASE | 1.0.0 | string | The database name the configured store should use. | cache-providers |
OC_CACHE_TTLGATEWAY_PROVIDER_CACHE_TTL | 1.0.0 | Duration | Default time to live for user info in the cache. Only applied when access tokens has no expiration. See the Environment Variable Types description for more details. | 5m0s |
OC_CACHE_DISABLE_PERSISTENCEGATEWAY_PROVIDER_CACHE_DISABLE_PERSISTENCE | 1.0.0 | bool | Disables persistence of the provider cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false. | false |
OC_CACHE_AUTH_USERNAMEGATEWAY_PROVIDER_CACHE_AUTH_USERNAME | 1.0.0 | string | The username to use for authentication. Only applies when store type 'nats-js-kv' is configured. | |
OC_CACHE_AUTH_PASSWORDGATEWAY_PROVIDER_CACHE_AUTH_PASSWORD | 1.0.0 | string | The password to use for authentication. Only applies when store type 'nats-js-kv' is configured. | |
OC_CACHE_STOREGATEWAY_CREATE_HOME_CACHE_STORE | 1.0.0 | string | The 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_NODESGATEWAY_CREATE_HOME_CACHE_STORE_NODES | 1.0.0 | []string | A 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_DATABASE | 1.0.0 | string | The database name the configured store should use. | cache-createhome |
OC_CACHE_TTLGATEWAY_CREATE_HOME_CACHE_TTL | 1.0.0 | Duration | Default time to live for user info in the cache. Only applied when access tokens has no expiration. See the Environment Variable Types description for more details. | 5m0s |
OC_CACHE_DISABLE_PERSISTENCEGATEWAY_CREATE_HOME_CACHE_DISABLE_PERSISTENCE | 1.0.0 | bool | Disables persistence of the create home cache. Only applies when store type 'nats-js-kv' is configured. Defaults to false. | false |
OC_CACHE_AUTH_USERNAMEGATEWAY_CREATE_HOME_CACHE_AUTH_USERNAME | 1.0.0 | string | The username to use for authentication. Only applies when store type 'nats-js-kv' is configured. | |
OC_CACHE_AUTH_PASSWORDGATEWAY_CREATE_HOME_CACHE_AUTH_PASSWORD | 1.0.0 | string | The password to use for authentication. Only applies when store type 'nats-js-kv' is configured. | |
OC_URLGATEWAY_FRONTEND_PUBLIC_URL | 1.0.0 | string | The public facing URL of the OpenCloud frontend. | https://localhost:9200 |
GATEWAY_USERS_ENDPOINT | 1.0.0 | string | The endpoint of the users service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | eu.opencloud.api.users |
GATEWAY_GROUPS_ENDPOINT | 1.0.0 | string | The endpoint of the groups service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | eu.opencloud.api.groups |
GATEWAY_PERMISSIONS_ENDPOINT | 1.0.0 | string | The endpoint of the permissions service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | eu.opencloud.api.settings |
GATEWAY_SHARING_ENDPOINT | 1.0.0 | string | The endpoint of the shares service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | eu.opencloud.api.sharing |
GATEWAY_AUTH_APP_ENDPOINT | 1.0.0 | string | The endpoint of the auth-app service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | eu.opencloud.api.auth-app |
GATEWAY_AUTH_BASIC_ENDPOINT | 1.0.0 | string | The endpoint of the auth-basic service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | eu.opencloud.api.auth-basic |
GATEWAY_AUTH_BEARER_ENDPOINT | 1.0.0 | string | The endpoint of the auth-bearer service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | |
GATEWAY_AUTH_MACHINE_ENDPOINT | 1.0.0 | string | The endpoint of the auth-machine service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | eu.opencloud.api.auth-machine |
GATEWAY_AUTH_SERVICE_ENDPOINT | 1.0.0 | string | The endpoint of the auth-service service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | eu.opencloud.api.auth-service |
GATEWAY_STORAGE_PUBLIC_LINK_ENDPOINT | 1.0.0 | string | The endpoint of the storage-publiclink service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | eu.opencloud.api.storage-publiclink |
GATEWAY_STORAGE_USERS_ENDPOINT | 1.0.0 | string | The endpoint of the storage-users service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | eu.opencloud.api.storage-users |
GATEWAY_STORAGE_SHARES_ENDPOINT | 1.0.0 | string | The endpoint of the storage-shares service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | eu.opencloud.api.storage-shares |
GATEWAY_APP_REGISTRY_ENDPOINT | 1.0.0 | string | The endpoint of the app-registry service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | eu.opencloud.api.app-registry |
GATEWAY_OCM_ENDPOINT | 1.0.0 | string | The endpoint of the ocm service. Can take a service name or a gRPC URI with the dns, kubernetes or unix protocol. | eu.opencloud.api.ocm |
GATEWAY_STORAGE_REGISTRY_DRIVER | 1.0.0 | string | The driver name of the storage registry to use. | spaces |
GATEWAY_STORAGE_REGISTRY_RULES | 1.0.0 | []string | The rules for the storage registry. See the Environment Variable Types description for more details. | [] |
GATEWAY_STORAGE_REGISTRY_CONFIG_JSON | 1.0.0 | string | Additional configuration for the storage registry in json format. | |
GATEWAY_STORAGE_USERS_MOUNT_ID | 1.0.0 | string | Mount ID of this storage. Admins can set the ID for the storage in this config option manually which is then used to reference the storage. Any reasonable long string is possible, preferably this would be an UUIDv4 format. |