Environment Variables

Environment variables for the ocdav service

Name	Introduction Version	Type	Description	Default Value
OC_TRACING_ENABLED OCDAV_TRACING_ENABLED	1.0.0	bool	Activates tracing.	false
OC_TRACING_TYPE OCDAV_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_ENDPOINT OCDAV_TRACING_ENDPOINT	1.0.0	string	The endpoint of the tracing agent.
OC_TRACING_COLLECTOR OCDAV_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_LEVEL OCDAV_LOG_LEVEL	1.0.0	string	The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'.
OC_LOG_PRETTY OCDAV_LOG_PRETTY	1.0.0	bool	Activates pretty log output.	false
OC_LOG_COLOR OCDAV_LOG_COLOR	1.0.0	bool	Activates colorized log output.	false
OC_LOG_FILE OCDAV_LOG_FILE	1.0.0	string	The path to the log file. Activates logging to this file if set.
OCDAV_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:9163
OCDAV_DEBUG_TOKEN	1.0.0	string	Token to secure the metrics endpoint.
OCDAV_DEBUG_PPROF	1.0.0	bool	Enables pprof, which can be used for profiling.	false
OCDAV_DEBUG_ZPAGES	1.0.0	bool	Enables zpages, which can be used for collecting and viewing in-memory traces.	false
OCDAV_HTTP_ADDR	1.0.0	string	The bind address of the HTTP service.	127.0.0.1:9350
OCDAV_HTTP_PROTOCOL	1.0.0	string	The transport protocol of the HTTP service.	tcp
OCDAV_HTTP_PREFIX	1.0.0	string	A URL path prefix for the handler.
OC_CORS_ALLOW_ORIGINS OCDAV_CORS_ALLOW_ORIGINS	1.0.0	[]string	A 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 OCDAV_CORS_ALLOW_METHODS	1.0.0	[]string	A 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.	[OPTIONS HEAD GET PUT POST DELETE MKCOL PROPFIND PROPPATCH MOVE COPY REPORT SEARCH]
OC_CORS_ALLOW_HEADERS OCDAV_CORS_ALLOW_HEADERS	1.0.0	[]string	A 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.	[Origin Accept Content-Type Depth Authorization Ocs-Apirequest If-None-Match If-Match Destination Overwrite X-Request-Id X-Requested-With Tus-Resumable Tus-Checksum-Algorithm Upload-Concat Upload-Length Upload-Metadata Upload-Defer-Length Upload-Expires Upload-Checksum Upload-Offset X-HTTP-Method-Override Cache-Control]
OC_CORS_ALLOW_CREDENTIALS OCDAV_CORS_ALLOW_CREDENTIALS	1.0.0	bool	Allow 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_JWT_SECRET OCDAV_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.
OCDAV_SKIP_USER_GROUPS_IN_TOKEN	1.0.0	bool	Disables the loading of user's group memberships from the reva access token.	false
OCDAV_WEBDAV_NAMESPACE	1.0.0	string	Jail requests to /dav/webdav into this CS3 namespace. Supports template layouting with CS3 User properties.	/users/{{.Id.OpaqueId}}
OCDAV_FILES_NAMESPACE	1.0.0	string	Jail requests to /dav/files/{username} into this CS3 namespace. Supports template layouting with CS3 User properties.	/users/{{.Id.OpaqueId}}
OCDAV_SHARES_NAMESPACE	1.0.0	string	The human readable path for the share jail. Relative to a users personal space root. Upcased intentionally.	/Shares
OCDAV_OCM_NAMESPACE	1.0.0	string	The human readable path prefix for the ocm shares.	/public
OC_URL OCDAV_PUBLIC_URL	1.0.0	string	URL where OpenCloud is reachable for users.	https://localhost:9200
OC_INSECURE OCDAV_INSECURE	1.0.0	bool	Allow insecure connections to the GATEWAY service.	false
OCDAV_GATEWAY_REQUEST_TIMEOUT	1.0.0	int64	Request timeout in seconds for requests from the oCDAV service to the GATEWAY service.	84300
OC_MACHINE_AUTH_API_KEY OCDAV_MACHINE_AUTH_API_KEY	1.0.0	string	Machine auth API key used to validate internal requests necessary for the access to resources from other services.
OC_EDITION OCDAV_EDITION	1.0.0	string	Edition of OpenCloud. Used for branding purposes.
OCDAV_ALLOW_PROPFIND_DEPTH_INFINITY	1.0.0	bool	Allow the use of depth infinity in PROPFINDS. When enabled, a propfind will traverse through all subfolders. If many subfolders are expected, depth infinity can cause heavy server load and/or delayed response times.	false