Userlog Service Configuration

Table of Contents

Introduction
Prerequisites
Storing
Configuring Events
Retrieving
Subscribing
Posting
- Authentication
- Deprovisioning
Deleting
Translations
- Translation Rules
Configuration
- Environment Variables
- YAML Example

Introduction

The Infinite Scale userlog service is a mediator between the eventhistory service and clients who want to be informed about user-related events. It provides an API to retrieve those.

Prerequisites

Running the userlog service without running the eventhistory service is not possible.

Storing

The userlog service persists information via the configured store in USERLOG_STORE. Possible stores are:

Store Type Description

Store Type	Description
`memory`	Basic in-memory store and the default.
`ocmem`	Advanced in-memory store allowing max size.
`redis`	Stores data in a configured Redis cluster.
`redis-sentinel`	Stores data in a configured Redis Sentinel cluster.
`etcd`	Stores data in a configured etcd cluster.
`nats-js`	Stores data using the key-value-store feature of NATS JetStream.
`noop`	Stores nothing. Useful for testing. Not recommended in production environments.

memory

Basic in-memory store and the default.

ocmem

Advanced in-memory store allowing max size.

redis

Stores data in a configured Redis cluster.

redis-sentinel

Stores data in a configured Redis Sentinel cluster.

etcd

Stores data in a configured etcd cluster.

nats-js

Stores data using the key-value-store feature of NATS JetStream.

noop

Stores nothing. Useful for testing. Not recommended in production environments.

Note that in-memory stores are by nature not reboot-persistent.
Though usually not necessary, a database name and a database table can be configured for event stores if the event store supports this. Generally not applicable for stores of type in-memory. These settings are blank by default which means that the standard settings of the configured store apply.
The userlog service can be scaled if not using in-memory stores and the stores are configured identically over all instances.
When using redis-sentinel, the Redis master to use is configured via USERLOG_STORE_NODES in the form of <sentinel-host>:<sentinel-port>/<redis-master> like 10.10.0.200:26379/mymaster.

Configuring Events

Currently, the configuration which user-related events are of interest is hard-coded and cannot be changed.

Retrieving

The userlog service provides an API to retrieve configured events. For now, this API is mostly following the ownCloud Server notification GET API.

Subscribing

The userlog service provides an /sse (Server-Sent Events) endpoint to be informed by the server when an event happens. See What is Server-Sent Events for a simple introduction and examples to server-sent events. The sse endpoint will respect language changes of the user without needing to reconnect. Note that SSE have the limitation of six open connections per browser which can be reached if one has opened various tabs of the Web UI pointing to the same Infinite Scale instance.

Posting

The userlog service is able to store global messages that will be displayed in the Web UI to all users. If a user deletes the message in the Web UI, it reappears on reload. Global messages use the endpoint /ocs/v2.php/apps/notifications/api/v1/notifications/global and are activated by sending a POST request. Note that sending another POST request of the same type overwrites the previous one. For the time being, only the type deprovision is supported.

Authentication

POST and DELETE endpoints provide notifications to all users. Therefore only certain users can configure them. Two authentication methods for this endpoint are provided:

Users with the admin role can always access these endpoints.
Additionally, a static secret via the USERLOG_GLOBAL_NOTIFICATIONS_SECRET can be defined to enable access for users knowing this secret, which has to be sent with the header containing the request.

Deprovisioning

Deprovision messages announce a deprovision text including a deprovision date of the instance to all users. With this message, users get informed that the instance will be shut down and deprovisioned and no further access to their data is possible past the given date. This implies that users must download their data before the given date. The text shown to users refers to this information. Note that the task to deprovision the instance does not depend on the message. The text of the message can be translated according to the translation settings, see section Translations. The endpoint only expects a deprovision_date parameter in the POST request body as the final text is assembled automatically. The string hast to be in RFC3339 format, however, this format can be changed by using deprovision_date_format. See the go time formating for more details.

Also see the GRAPH_LDAP_SCHOOL_TERMINATION_MIN_GRACE_DAYS environment variable for an additional configuration parameter.

Deleting

To delete events for an user, use a DELETE request to:
https://<your-ocis-instance>/ocs/v2.php/apps/notifications/api/v1/notification
containing the IDs to delete.
Sending a DELETE request to the global endpoint:
https://<your-ocis-instance>/ocs/v2.php/apps/notifications/api/v1/notifications/global
to remove a global message is a restricted action, see the Authentication section for more details.

Translations

The userlog service has embedded translations sourced via transifex to provide a basic set of translated languages. These embedded translations are available for all deployment scenarios. In addition, the service supports custom translations, though it is currently not possible to just add custom translations to embedded ones. If custom translations are configured, the embedded ones are not used. To configure custom translations, the USERLOG_TRANSLATION_PATH environment variable needs to point to a base folder that will contain the translation files. This path must be available from all instances of the userlog service, a shared storage is recommended. Translation files must be of type .po or .mo. For each language, the filename needs to be userlog.po (or userlog.mo) and stored in a folder structure defining the language code. In general the path/name pattern for a translation file needs to be:

{USERLOG_TRANSLATION_PATH}/{language-code}/LC_MESSAGES/userlog.po

The language code pattern is composed of language[_territory] where language is the base language and _territory is optional and defines a country.

For example, for the language de, one needs to place the corresponding translation files to

{USERLOG_TRANSLATION_PATH}/de/LC_MESSAGES/userlog.po

For the time being, the embedded ownCloud Web frontend only supports the main language code but does not handle any territory. When strings are available in the language code language_territory, the web frontend does not see it as it only requests language. In consequence, any translations made must exist in the requested language to avoid a fallback to the default.

Translation Rules

If a requested language code is not available, the service tries to fall back to the base language if available. For example, if the requested language-code de_DE is not available, the service tries to fall back to translations in the de folder.
If the base language de is also not available, the service falls back to the system’s default English (en), which is the source of the texts provided by the code.

Configuration

Environment Variables

The userlog service is configured via the following environment variables:

latest
4.0.1
3.0.0

Deprecation notes for the userlog service
Deprecation Info	Deprecation Version	Removal Version	Deprecation Replacement

Environment variables for the userlog service
Name	Type	Default Value	Description
`OCIS_TRACING_ENABLED` `USERLOG_TRACING_ENABLED`	bool	false	Activates tracing.
`OCIS_TRACING_TYPE` `USERLOG_TRACING_TYPE`	string		The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now.
`OCIS_TRACING_ENDPOINT` `USERLOG_TRACING_ENDPOINT`	string		The endpoint of the tracing agent.
`OCIS_TRACING_COLLECTOR` `USERLOG_TRACING_COLLECTOR`	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.
`OCIS_LOG_LEVEL` `USERLOG_LOG_LEVEL`	string		The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'.
`OCIS_LOG_PRETTY` `USERLOG_LOG_PRETTY`	bool	false	Activates pretty log output.
`OCIS_LOG_COLOR` `USERLOG_LOG_COLOR`	bool	false	Activates colorized log output.
`OCIS_LOG_FILE` `USERLOG_LOG_FILE`	string		The path to the log file. Activates logging to this file if set.
`USERLOG_DEBUG_ADDR`	string	127.0.0.1:9210	Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
`USERLOG_DEBUG_TOKEN`	string		Token to secure the metrics endpoint.
`USERLOG_DEBUG_PPROF`	bool	false	Enables pprof, which can be used for profiling.
`USERLOG_DEBUG_ZPAGES`	bool	false	Enables zpages, which can be used for collecting and viewing in-memory traces.
`USERLOG_HTTP_ADDR`	string	127.0.0.1:0	The bind address of the HTTP service.
`USERLOG_HTTP_ROOT`	string	/	Subdirectory that serves as the root for this HTTP service.
`OCIS_CORS_ALLOW_ORIGINS` `USERLOG_CORS_ALLOW_ORIGINS`	[]string	[*]	A comma-separated 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
`OCIS_CORS_ALLOW_METHODS` `USERLOG_CORS_ALLOW_METHODS`	[]string	[GET]	A comma-separated 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
`OCIS_CORS_ALLOW_HEADERS` `USERLOG_CORS_ALLOW_HEADERS`	[]string	[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id Ocs-Apirequest]	A blank or comma-separated 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.
`OCIS_CORS_ALLOW_CREDENTIALS` `USERLOG_CORS_ALLOW_CREDENTIALS`	bool	true	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.
`OCIS_HTTP_TLS_ENABLED`	bool	false	Activates TLS for the http based services using the server certifcate and key configured via OCIS_HTTP_TLS_CERTIFICATE and OCIS_HTTP_TLS_KEY. If OCIS_HTTP_TLS_CERTIFICATE is not set a temporary server certificate is generated - to be used with PROXY_INSECURE_BACKEND=true.
`OCIS_HTTP_TLS_CERTIFICATE`	string		Path/File name of the TLS server certificate (in PEM format) for the http services.
`OCIS_HTTP_TLS_KEY`	string		Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the http services.
`OCIS_JWT_SECRET` `USERLOG_JWT_SECRET`	string		The secret to mint and validate jwt tokens.
`OCIS_REVA_GATEWAY`	string	com.owncloud.api.gateway	CS3 gateway used to look up user metadata
`OCIS_TRANSLATION_PATH` `USERLOG_TRANSLATION_PATH`	string		(optional) Set this to a path with custom translations to overwrite the builtin translations. Note that file and folder naming rules apply, see the documentation for more details.
`OCIS_EVENTS_ENDPOINT` `USERLOG_EVENTS_ENDPOINT`	string	127.0.0.1:9233	The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture.
`OCIS_EVENTS_CLUSTER` `USERLOG_EVENTS_CLUSTER`	string	ocis-cluster	The 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.
`OCIS_INSECURE` `USERLOG_EVENTS_TLS_INSECURE`	bool	false	Whether to verify the server TLS certificates.
`OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE` `USERLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE`	string		The root CA certificate used to validate the server’s TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false.
`OCIS_EVENTS_ENABLE_TLS` `USERLOG_EVENTS_ENABLE_TLS`	bool	false	Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services..
`OCIS_PERSISTENT_STORE` `USERLOG_STORE`	string	memory	The type of the store. Supported values are: 'memory', 'ocmem', 'etcd', 'redis', 'redis-sentinel', 'nats-js', 'noop'. See the text description for details.
`OCIS_PERSISTENT_STORE_NODES` `USERLOG_STORE_NODES`	[]string	[]	A comma separated list of nodes to access the configured store. This has no effect when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store.
`USERLOG_STORE_DATABASE`	string	userlog	The database name the configured store should use.
`USERLOG_STORE_TABLE`	string	events	The database table the store should use.
`OCIS_PERSISTENT_STORE_TTL` `USERLOG_STORE_TTL`	Duration	336h0m0s	Time to live for events in the store. The duration can be set as number followed by a unit identifier like s, m or h. Defaults to '336h' (2 weeks).
`OCIS_PERSISTENT_STORE_SIZE` `USERLOG_STORE_SIZE`	int	0	The maximum quantity of items in the store. Only applies when store type 'ocmem' is configured. Defaults to 512.
`OCIS_DISABLE_SSE,USERLOG_DISABLE_SSE`	bool	false	Disables server-sent events (sse). When disabled, clients will no longer receive sse notifications.
`USERLOG_GLOBAL_NOTIFICATIONS_SECRET`	string		The secret to secure the global notifications endpoint. Only system admins and users knowing that secret can call the global notifications POST/DELETE endpoints.
`OCIS_SERVICE_ACCOUNT_ID` `USERLOG_SERVICE_ACCOUNT_ID`	string		The ID of the service account the service should use. See the 'auth-service' service description for more details.
`OCIS_SERVICE_ACCOUNT_SECRET` `USERLOG_SERVICE_ACCOUNT_SECRET`	string		The service account secret.

Deprecation notes for the userlog service
Deprecation Info	Deprecation Version	Removal Version	Deprecation Replacement

Environment variables for the userlog service
Name	Type	Default Value	Description
`OCIS_TRACING_ENABLED` `USERLOG_TRACING_ENABLED`	bool	false	Activates tracing.
`OCIS_TRACING_TYPE` `USERLOG_TRACING_TYPE`	string		The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now.
`OCIS_TRACING_ENDPOINT` `USERLOG_TRACING_ENDPOINT`	string		The endpoint of the tracing agent.
`OCIS_TRACING_COLLECTOR` `USERLOG_TRACING_COLLECTOR`	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.
`OCIS_LOG_LEVEL` `USERLOG_LOG_LEVEL`	string		The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'.
`OCIS_LOG_PRETTY` `USERLOG_LOG_PRETTY`	bool	false	Activates pretty log output.
`OCIS_LOG_COLOR` `USERLOG_LOG_COLOR`	bool	false	Activates colorized log output.
`OCIS_LOG_FILE` `USERLOG_LOG_FILE`	string		The path to the log file. Activates logging to this file if set.
`USERLOG_DEBUG_ADDR`	string	127.0.0.1:9210	Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
`USERLOG_DEBUG_TOKEN`	string		Token to secure the metrics endpoint.
`USERLOG_DEBUG_PPROF`	bool	false	Enables pprof, which can be used for profiling.
`USERLOG_DEBUG_ZPAGES`	bool	false	Enables zpages, which can be used for collecting and viewing in-memory traces.
`USERLOG_HTTP_ADDR`	string	127.0.0.1:0	The bind address of the HTTP service.
`USERLOG_HTTP_ROOT`	string	/	Subdirectory that serves as the root for this HTTP service.
`OCIS_CORS_ALLOW_ORIGINS` `USERLOG_CORS_ALLOW_ORIGINS`	[]string	[*]	A comma-separated 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
`OCIS_CORS_ALLOW_METHODS` `USERLOG_CORS_ALLOW_METHODS`	[]string	[GET]	A comma-separated 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
`OCIS_CORS_ALLOW_HEADERS` `USERLOG_CORS_ALLOW_HEADERS`	[]string	[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id Ocs-Apirequest]	A blank or comma-separated 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.
`OCIS_CORS_ALLOW_CREDENTIALS` `USERLOG_CORS_ALLOW_CREDENTIALS`	bool	true	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.
`OCIS_HTTP_TLS_ENABLED`	bool	false	Activates TLS for the http based services using the server certifcate and key configured via OCIS_HTTP_TLS_CERTIFICATE and OCIS_HTTP_TLS_KEY. If OCIS_HTTP_TLS_CERTIFICATE is not set a temporary server certificate is generated - to be used with PROXY_INSECURE_BACKEND=true.
`OCIS_HTTP_TLS_CERTIFICATE`	string		Path/File name of the TLS server certificate (in PEM format) for the http services.
`OCIS_HTTP_TLS_KEY`	string		Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the http services.
`OCIS_JWT_SECRET` `USERLOG_JWT_SECRET`	string		The secret to mint and validate jwt tokens.
`OCIS_MACHINE_AUTH_API_KEY` `USERLOG_MACHINE_AUTH_API_KEY`	string		Machine auth API key used to validate internal requests necessary to access resources from other services.
`OCIS_REVA_GATEWAY`	string	com.owncloud.api.gateway	CS3 gateway used to look up user metadata
`OCIS_TRANSLATION_PATH` `USERLOG_TRANSLATION_PATH`	string		(optional) Set this to a path with custom translations to overwrite the builtin translations. Note that file and folder naming rules apply, see the documentation for more details.
`OCIS_EVENTS_ENDPOINT` `USERLOG_EVENTS_ENDPOINT`	string	127.0.0.1:9233	The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture.
`OCIS_EVENTS_CLUSTER` `USERLOG_EVENTS_CLUSTER`	string	ocis-cluster	The 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.
`OCIS_INSECURE` `USERLOG_EVENTS_TLS_INSECURE`	bool	false	Whether to verify the server TLS certificates.
`OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE` `USERLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE`	string		The root CA certificate used to validate the server’s TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false.
`OCIS_EVENTS_ENABLE_TLS` `USERLOG_EVENTS_ENABLE_TLS`	bool	false	Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services..
`OCIS_PERSISTENT_STORE` `USERLOG_STORE`	string	memory	The type of the store. Supported values are: 'memory', 'ocmem', 'etcd', 'redis', 'redis-sentinel', 'nats-js', 'noop'. See the text description for details.
`OCIS_PERSISTENT_STORE_NODES` `USERLOG_STORE_NODES`	[]string	[]	A comma separated list of nodes to access the configured store. This has no effect when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store.
`USERLOG_STORE_DATABASE`	string	userlog	The database name the configured store should use.
`USERLOG_STORE_TABLE`	string	events	The database table the store should use.
`OCIS_PERSISTENT_STORE_TTL` `USERLOG_STORE_TTL`	Duration	336h0m0s	Time to live for events in the store. The duration can be set as number followed by a unit identifier like s, m or h. Defaults to '336h' (2 weeks).
`OCIS_PERSISTENT_STORE_SIZE` `USERLOG_STORE_SIZE`	int	0	The maximum quantity of items in the store. Only applies when store type 'ocmem' is configured. Defaults to 512.
`OCIS_DISABLE_SSE,USERLOG_DISABLE_SSE`	bool	false	Disables server-sent events (sse). When disabled, clients will no longer be able to connect to the sse endpoint.
`USERLOG_GLOBAL_NOTIFICATIONS_SECRET`	string		The secret to secure the global notifications endpoint. Only system admins and users knowing that secret can call the global notifications POST/DELETE endpoints.

Deprecation notes for the userlog service
Deprecation Info	Deprecation Version	Removal Version	Deprecation Replacement
REVA_GATEWAY changing name for consistency	3.0	4.0.0	OCIS_REVA_GATEWAY

Environment variables for the userlog service
Name	Type	Default Value	Description
`OCIS_TRACING_ENABLED` `USERLOG_TRACING_ENABLED`	bool	false	Activates tracing.
`OCIS_TRACING_TYPE` `USERLOG_TRACING_TYPE`	string		The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.
`OCIS_TRACING_ENDPOINT` `USERLOG_TRACING_ENDPOINT`	string		The endpoint of the tracing agent.
`OCIS_TRACING_COLLECTOR` `USERLOG_TRACING_COLLECTOR`	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.
`OCIS_LOG_LEVEL` `USERLOG_LOG_LEVEL`	string		The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".
`OCIS_LOG_PRETTY` `USERLOG_LOG_PRETTY`	bool	false	Activates pretty log output.
`OCIS_LOG_COLOR` `USERLOG_LOG_COLOR`	bool	false	Activates colorized log output.
`OCIS_LOG_FILE` `USERLOG_LOG_FILE`	string		The path to the log file. Activates logging to this file if set.
`USERLOG_DEBUG_ADDR`	string	127.0.0.1:9210	Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
`USERLOG_DEBUG_TOKEN`	string		Token to secure the metrics endpoint.
`USERLOG_DEBUG_PPROF`	bool	false	Enables pprof, which can be used for profiling.
`USERLOG_DEBUG_ZPAGES`	bool	false	Enables zpages, which can be used for collecting and viewing in-memory traces.
`USERLOG_HTTP_ADDR`	string	127.0.0.1:0	The bind address of the HTTP service.
`USERLOG_HTTP_ROOT`	string	/	Subdirectory that serves as the root for this HTTP service.
`OCIS_CORS_ALLOW_ORIGINS` `USERLOG_CORS_ALLOW_ORIGINS`	[]string	[*]	A comma-separated 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
`OCIS_CORS_ALLOW_METHODS` `USERLOG_CORS_ALLOW_METHODS`	[]string	[GET]	A comma-separated 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
`OCIS_CORS_ALLOW_HEADERS` `USERLOG_CORS_ALLOW_HEADERS`	[]string	[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id Ocs-Apirequest]	A comma-separated 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.
`OCIS_CORS_ALLOW_CREDENTIALS` `USERLOG_CORS_ALLOW_CREDENTIALS`	bool	true	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.
`OCIS_HTTP_TLS_ENABLED`	bool	false	Activates TLS for the http based services using the server certifcate and key configured via OCIS_HTTP_TLS_CERTIFICATE and OCIS_HTTP_TLS_KEY. If OCIS_HTTP_TLS_CERTIFICATE is not set a temporary server certificate is generated - to be used with PROXY_INSECURE_BACKEND=true.
`OCIS_HTTP_TLS_CERTIFICATE`	string		Path/File name of the TLS server certificate (in PEM format) for the http services.
`OCIS_HTTP_TLS_KEY`	string		Path/File name for the TLS certificate key (in PEM format) for the server certificate to use for the http services.
`OCIS_JWT_SECRET` `USERLOG_JWT_SECRET`	string		The secret to mint and validate jwt tokens.
`OCIS_MACHINE_AUTH_API_KEY` `USERLOG_MACHINE_AUTH_API_KEY`	string		Machine auth API key used to validate internal requests necessary to access resources from other services.
`OCIS_REVA_GATEWAY` `REVA_GATEWAY` Deprecation Note	string	127.0.0.1:9142	CS3 gateway used to look up user metadata
`OCIS_TRANSLATION_PATH` `USERLOG_TRANSLATION_PATH`	string		(optional) Set this to a path with custom translations to overwrite the builtin translations. Note that file and folder naming rules apply, see the documentation for more details.
`OCIS_EVENTS_ENDPOINT` `USERLOG_EVENTS_ENDPOINT`	string	127.0.0.1:9233	The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture.
`OCIS_EVENTS_CLUSTER` `USERLOG_EVENTS_CLUSTER`	string	ocis-cluster	The 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.
`OCIS_INSECURE` `USERLOG_EVENTS_TLS_INSECURE`	bool	false	Whether to verify the server TLS certificates.
`OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE` `USERLOG_EVENTS_TLS_ROOT_CA_CERTIFICATE`	string		The root CA certificate used to validate the server’s TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false.
`OCIS_EVENTS_ENABLE_TLS` `USERLOG_EVENTS_ENABLE_TLS`	bool	false	Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services..
`OCIS_PERSISTENT_STORE` `USERLOG_STORE`	string	memory	The type of the store. Supported values are: 'memory', 'ocmem', 'etcd', 'redis', 'redis-sentinel', 'nats-js', 'noop'. See the text description for details.
`OCIS_PERSISTENT_STORE_NODES` `USERLOG_STORE_NODES`	[]string	[]	A comma separated list of nodes to access the configured store. This has no effect when 'memory' or 'ocmem' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store.
`USERLOG_STORE_DATABASE`	string	userlog	The database name the configured store should use.
`USERLOG_STORE_TABLE`	string	events	The database table the store should use.
`OCIS_PERSISTENT_STORE_TTL` `USERLOG_STORE_TTL`	Duration	336h0m0s	Time to live for events in the store. The duration can be set as number followed by a unit identifier like s, m or h. Defaults to '336h' (2 weeks).
`OCIS_PERSISTENT_STORE_SIZE` `USERLOG_STORE_SIZE`	int	0	The maximum quantity of items in the store. Only applies when store type 'ocmem' is configured. Defaults to 512.

YAML Example

Note that the filename shown below has been chosen on purpose.
See the Configuration File Naming for details when setting up your own configuration.

latest
4.0.1
3.0.0

# Autogenerated
# Filename: userlog-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9210
  token: ""
  pprof: false
  zpages: false
http:
  addr: 127.0.0.1:0
  root: /
  cors:
    allow_origins:
    - '*'
    allow_methods:
    - GET
    allow_headers:
    - Authorization
    - Origin
    - Content-Type
    - Accept
    - X-Requested-With
    - X-Request-Id
    - Ocs-Apirequest
    allow_credentials: true
  tls:
    enabled: false
    cert: ""
    key: ""
grpc_client_tls: null
token_manager:
  jwt_secret: ""
reva_gateway: com.owncloud.api.gateway
translation_path: ""
events:
  endpoint: 127.0.0.1:9233
  cluster: ocis-cluster
  tls_insecure: false
  tls_root_ca_certificate: ""
  enable_tls: false
persistence:
  store: memory
  nodes: []
  database: userlog
  table: events
  ttl: 336h0m0s
  size: 0
disable_sse: false
global_notifications_secret: ""
service_account:
  service_account_id: ""
  service_account_secret: ""

# Autogenerated
# Filename: userlog-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9210
  token: ""
  pprof: false
  zpages: false
http:
  addr: 127.0.0.1:0
  root: /
  cors:
    allow_origins:
    - '*'
    allow_methods:
    - GET
    allow_headers:
    - Authorization
    - Origin
    - Content-Type
    - Accept
    - X-Requested-With
    - X-Request-Id
    - Ocs-Apirequest
    allow_credentials: true
  tls:
    enabled: false
    cert: ""
    key: ""
grpc_client_tls: null
token_manager:
  jwt_secret: ""
machine_auth_api_key: ""
reva_gateway: com.owncloud.api.gateway
translation_path: ""
events:
  endpoint: 127.0.0.1:9233
  cluster: ocis-cluster
  tls_insecure: false
  tls_root_ca_certificate: ""
  enable_tls: false
persistence:
  store: memory
  nodes: []
  database: userlog
  table: events
  ttl: 336h0m0s
  size: 0
disable_sse: false
global_notifications_secret: ""

# Autogenerated
# Filename: userlog-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9210
  token: ""
  pprof: false
  zpages: false
http:
  addr: 127.0.0.1:0
  root: /
  cors:
    allow_origins:
    - '*'
    allow_methods:
    - GET
    allow_headers:
    - Authorization
    - Origin
    - Content-Type
    - Accept
    - X-Requested-With
    - X-Request-Id
    - Ocs-Apirequest
    allow_credentials: true
  tls:
    enabled: false
    cert: ""
    key: ""
grpc_client_tls: null
token_manager:
  jwt_secret: ""
machine_auth_api_key: ""
reva_gateway: 127.0.0.1:9142
translation_path: ""
events:
  endpoint: 127.0.0.1:9233
  cluster: ocis-cluster
  tls_insecure: false
  tls_root_ca_certificate: ""
  enable_tls: false
persistence:
  store: memory
  nodes: []
  database: userlog
  table: events
  ttl: 336h0m0s
  size: 0