Service Configuration

Example YAML Config

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48


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

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9174
  token: ""
  pprof: false
  zpages: false
ocis_url: https://localhost:9200
notifications:
  SMTP:
    smtp_host: ""
    smtp_port: 0
    smtp_sender: ""
    smtp_username: ""
    smtp_password: ""
    insecure: false
    smtp_authentication: ""
    smtp_encryption: none
  events:
    endpoint: 127.0.0.1:9233
    cluster: ocis-cluster
    tls_insecure: false
    tls_root_ca_certificate: ""
    enable_tls: false
    username: ""
    password: ""
  email_template_path: ""
  translation_path: ""
  default_language: ""
  reva_gateway: com.owncloud.api.gateway
  grpc_client_tls: null
grpc_client_tls:
  mode: ""
  cacert: ""
service_account:
  service_account_id: ""
  service_account_secret: ""

Environment Variables

Name	Type	Default Value	Description
OCIS_TRACING_ENABLED NOTIFICATIONS_TRACING_ENABLED	bool	false	Activates tracing.
OCIS_TRACING_TYPE NOTIFICATIONS_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 NOTIFICATIONS_TRACING_ENDPOINT	string		The endpoint of the tracing agent.
OCIS_TRACING_COLLECTOR NOTIFICATIONS_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 NOTIFICATIONS_LOG_LEVEL	string		The log level. Valid values are: ‘panic’, ‘fatal’, ’error’, ‘warn’, ‘info’, ‘debug’, ’trace’.
OCIS_LOG_PRETTY NOTIFICATIONS_LOG_PRETTY	bool	false	Activates pretty log output.
OCIS_LOG_COLOR NOTIFICATIONS_LOG_COLOR	bool	false	Activates colorized log output.
OCIS_LOG_FILE NOTIFICATIONS_LOG_FILE	string		The path to the log file. Activates logging to this file if set.
NOTIFICATIONS_DEBUG_ADDR	string	127.0.0.1:9174	Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
NOTIFICATIONS_DEBUG_TOKEN	string		Token to secure the metrics endpoint.
NOTIFICATIONS_DEBUG_PPROF	bool	false	Enables pprof, which can be used for profiling.
NOTIFICATIONS_DEBUG_ZPAGES	bool	false	Enables zpages, which can be used for collecting and viewing in-memory traces.
OCIS_URL NOTIFICATIONS_WEB_UI_URL	string	https://localhost:9200	The public facing URL of the oCIS Web UI, used e.g. when sending notification eMails
NOTIFICATIONS_SMTP_HOST	string		SMTP host to connect to.
NOTIFICATIONS_SMTP_PORT	int	0	Port of the SMTP host to connect to.
NOTIFICATIONS_SMTP_SENDER	string		Sender address of emails that will be sent (e.g. ‘ownCloud noreply@example.com’.
NOTIFICATIONS_SMTP_USERNAME	string		Username for the SMTP host to connect to.
NOTIFICATIONS_SMTP_PASSWORD	string		Password for the SMTP host to connect to.
NOTIFICATIONS_SMTP_INSECURE	bool	false	Allow insecure connections to the SMTP server.
NOTIFICATIONS_SMTP_AUTHENTICATION	string		Authentication method for the SMTP communication. Possible values are ’login’, ‘plain’, ‘crammd5’, ’none’ or ‘auto’. If set to ‘auto’ or unset, the authentication method is automatically negotiated with the server.
NOTIFICATIONS_SMTP_ENCRYPTION	string	none	Encryption method for the SMTP communication. Possible values are ‘starttls’, ‘ssltls’ and ’none’.
OCIS_EVENTS_ENDPOINT NOTIFICATIONS_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 NOTIFICATIONS_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 NOTIFICATIONS_EVENTS_TLS_INSECURE	bool	false	Whether to verify the server TLS certificates.
OCIS_EVENTS_TLS_ROOT_CA_CERTIFICATE NOTIFICATIONS_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 NOTIFICATIONS_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_EVENTS_AUTH_USERNAME NOTIFICATIONS_EVENTS_AUTH_USERNAME	string		The username to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services.
OCIS_EVENTS_AUTH_PASSWORD NOTIFICATIONS_EVENTS_AUTH_PASSWORD	string		The password to authenticate with the events broker. The events broker is the ocis service which receives and delivers events between the services.
OCIS_EMAIL_TEMPLATE_PATH NOTIFICATIONS_EMAIL_TEMPLATE_PATH	string		Path to Email notification templates overriding embedded ones.
OCIS_TRANSLATION_PATH NOTIFICATIONS_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_DEFAULT_LANGUAGE	string		The default language used by services and the WebUI. If not defined, English will be used as default. See the documentation for more details.
OCIS_REVA_GATEWAY	string	com.owncloud.api.gateway	CS3 gateway used to look up user metadata
OCIS_GRPC_CLIENT_TLS_MODE	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.
OCIS_GRPC_CLIENT_TLS_CACERT	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.
OCIS_SERVICE_ACCOUNT_ID NOTIFICATIONS_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 NOTIFICATIONS_SERVICE_ACCOUNT_SECRET	string		The service account secret.