Zum Hauptinhalt springen
Version: 9.1

Environment Variables

Environment variables for the auth-guest service​

NameIntroduction VersionTypeDescriptionDefault Value
OC_LOG_LEVEL
AUTH_GUEST_LOG_LEVEL
9.0.0stringThe log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'."error"
AUTH_GUEST_DEBUG_ADDR9.0.0stringBind address of the debug server, where metrics, health, config and debug endpoints will be exposed."127.0.0.1:9267"
AUTH_GUEST_DEBUG_TOKEN9.0.0stringToken to secure the metrics endpoint.""
AUTH_GUEST_DEBUG_PPROF9.0.0boolEnables pprof, which can be used for profiling."false"
AUTH_GUEST_DEBUG_ZPAGES9.0.0boolEnables zpages, which can be used for collecting and viewing in-memory traces."false"
AUTH_GUEST_EVENTS_DISABLED9.0.0boolDisables listening for events. Set this to true if the service should only handle HTTP requests."false"
OC_EVENTS_ENDPOINT9.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_CLUSTER9.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
9.0.0boolWhether to verify the server TLS certificates."false"
OC_EVENTS_TLS_ROOT_CA_CERTIFICATE9.0.0stringThe root CA certificate used to validate the server's TLS certificate. If provided AUTH_GUEST_EVENTS_TLS_INSECURE will be seen as false.""
OC_EVENTS_ENABLE_TLS9.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_USERNAME9.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_PASSWORD9.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_REVA_GATEWAY9.0.0stringCS3 gateway used to look up user metadata"eu.opencloud.api.gateway"
AUTH_GUEST_GRPC_ADDR9.0.0stringThe bind address of the GRPC service."127.0.0.1:9268"
OC_GRPC_PROTOCOL
AUTH_GUEST_GRPC_PROTOCOL
9.0.0stringThe transport protocol of the GRPC service."tcp"
AUTH_GUEST_HTTP_DISABLED9.0.0boolDisables the HTTP service. Set this to true if the service should only handle events."false"
AUTH_GUEST_HTTP_ADDR9.0.0stringThe bind address of the HTTP service."127.0.0.1:9266"
AUTH_GUEST_HTTP_ROOT9.0.0stringSubdirectory that serves as the root for this HTTP service."/graph"
OC_CORS_ALLOW_ORIGINS
AUTH_GUEST_CORS_ALLOW_ORIGINS
9.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."[*]"
OC_CORS_ALLOW_METHODS
AUTH_GUEST_CORS_ALLOW_METHODS
9.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."[GET POST PUT PATCH DELETE]"
OC_CORS_ALLOW_HEADERS
AUTH_GUEST_CORS_ALLOW_HEADERS
9.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 Content-Type Accept X-Requested-With X-Request-Id Ocs-Apirequest]"
OC_CORS_ALLOW_CREDENTIALS
AUTH_GUEST_CORS_ALLOW_CREDENTIALS
9.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."true"
OC_HTTP_TLS_ENABLED1.0.0boolActivates TLS for the http based services using the server certifcate and key configured via OC_HTTP_TLS_CERTIFICATE and OC_HTTP_TLS_KEY. If OC_HTTP_TLS_CERTIFICATE is not set a temporary server certificate is generated - to be used with PROXY_INSECURE_BACKEND=true."false"
OC_HTTP_TLS_CERTIFICATE1.0.0stringPath/File name of the TLS server certificate (in PEM format) for the http services.""
OC_HTTP_TLS_KEY1.0.0stringPath/File name for the TLS certificate key (in PEM format) for the server certificate to use for the http services.""
AUTH_GUEST_TOKENS_STORAGE_ROOT9.0.0stringThe directory where the guest share tokens are stored. If not defined, the root directory derives from $OC_BASE_DATA_PATH/auth-guest."/var/lib/opencloud/auth-guest"
OC_JWT_SECRET
AUTH_GUEST_JWT_SECRET
9.0.0stringThe secret to mint and validate jwt tokens.""
AUTH_GUEST_JWT_COOKIE_NAME9.0.0stringThe name of the session cookie set when a guest token is redeemed."__Host-oc_guest_session"
AUTH_GUEST_JWT_TTL9.0.0DurationThe lifetime of a redeemed guest session token."24h0m0s"
AUTH_GUEST_NONCE_COOKIE_BASE_NAME9.0.0stringThe base name of the cookie that binds a nonce to the browser that requested the renewal. A short hash of the share id is appended per share, so the actual cookie is e.g. __Host-oc_guest_nonce_<hash>."__Host-oc_guest_nonce"
AUTH_GUEST_PIN_AND_NONCE_TTL9.0.0DurationThe lifetime of the one-time PIN and of the nonce that binds it to the browser. After it expires the PIN has to be renewed again. See the Environment Variable Types description for more details."30m0s"
AUTH_GUEST_BACKOFF_MAX_ATTEMPTS9.0.0intThe maximum number of failed attempts before the PIN is invalidated."5"
AUTH_GUEST_BACKOFF_BASE9.0.0DurationThe base duration for the exponential backoff between failed attempts. See the Environment Variable Types description for more details."1s"
AUTH_GUEST_BACKOFF_CAP9.0.0DurationThe maximum duration for the exponential backoff between failed attempts. See the Environment Variable Types description for more details."30s"
AUTH_GUEST_QUOTA_DAILY_CAP9.0.0intThe maximum number of renewals without a valid session for the same share within the window."50"
AUTH_GUEST_QUOTA_COOLDOWN9.0.0DurationThe minimum time between two renewals without a valid session for the same share. See the Environment Variable Types description for more details."1m0s"
AUTH_GUEST_QUOTA_WINDOW9.0.0DurationThe window over which the quota for renewals without a valid session is counted. See the Environment Variable Types description for more details."24h0m0s"
AUTH_GUEST_SESSION_QUOTA_DAILY_CAP9.0.0intThe maximum number of renewals authorized by a valid session for the same share within the window. Each of these renewals issues a new PIN."5"
AUTH_GUEST_SESSION_QUOTA_COOLDOWN9.0.0DurationThe minimum time between two renewals authorized by a valid session for the same share. See the Environment Variable Types description for more details."5m0s"
AUTH_GUEST_SESSION_QUOTA_WINDOW9.0.0DurationThe window over which the quota for renewals authorized by a valid session is counted. See the Environment Variable Types description for more details."24h0m0s"
OC_SERVICE_ACCOUNT_ID
AUTH_GUEST_SERVICE_ACCOUNT_ID
9.0.0stringThe ID of the service account the service should use. See the 'auth-service' service description for more details.""
OC_SERVICE_ACCOUNT_SECRET
AUTH_GUEST_SERVICE_ACCOUNT_SECRET
9.0.0stringThe service account secret.""
AUTH_GUEST_NUM_CONSUMERS9.0.0intThe amount of concurrent event consumers to start. Event consumers are used for processing events. Multiple consumers increase parallelisation, but will also increase CPU and memory demands."1"