Notifications Service Configuration
Introduction
The notification service is responsible for sending emails to users informing them about events that happened. To do this, it hooks into the event system and listens for certain events that the users need to be informed about. As an example, when a user is added to a share, a notification email will be sent to the user.
Configuration
Environment Variables
The notifications
service is configured via the following environment variables:
Name | Type | Default Value | Description |
---|---|---|---|
|
string |
|
The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". |
|
bool |
false |
Activates pretty log output. |
|
bool |
false |
Activates colorized log output. |
|
string |
|
The path to the log file. Activates logging to this file if set. |
|
string |
127.0.0.1:9174 |
Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. |
|
string |
|
Token to secure the metrics endpoint. |
|
bool |
false |
Enables pprof, which can be used for profiling. |
|
bool |
false |
Enables zpages, which can be used for collecting and viewing in-memory traces. |
|
string |
https://localhost:9200 |
The public facing URL of the oCIS Web UI, used e.g. when sending notification eMails |
|
string |
|
SMTP host to connect to. |
|
int |
1025 |
Port of the SMTP host to connect to. |
|
string |
ownCloud <noreply@example.com> |
Sender address of emails that will be sent. |
|
string |
|
Username for the SMTP host to connect to. |
|
string |
|
Password for the SMTP host to connect to. |
|
bool |
false |
Allow insecure connections to the SMTP server. |
|
string |
none |
Authentication method for the SMTP communication. Possible values are 'login', 'plain', 'crammd5', 'none' |
|
string |
none |
Encryption method for the SMTP communication. Possible values are 'starttls', 'ssl', 'ssltls', 'tls' and 'none'. |
|
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. |
|
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. |
|
string |
notifications |
Name of the event group / queue on the event system. |
|
bool |
false |
Whether to verify the server TLS certificates. |
|
string |
|
The root CA certificate used to validate the server’s TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. |
|
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.. |
|
string |
|
Machine auth API key used to validate internal requests necessary to access resources from other services. |
|
string |
|
Path to Email notification templates overriding embedded ones. |
|
string |
127.0.0.1:9142 |
CS3 gateway used to look up user metadata |
Name | Type | Default Value | Description |
---|---|---|---|
|
string |
|
The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". |
|
bool |
false |
Activates pretty log output. |
|
bool |
false |
Activates colorized log output. |
|
string |
|
The path to the log file. Activates logging to this file if set. |
|
string |
127.0.0.1:9174 |
Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. |
|
string |
|
Token to secure the metrics endpoint. |
|
bool |
false |
Enables pprof, which can be used for profiling. |
|
bool |
false |
Enables zpages, which can be used for collecting and viewing in-memory traces. |
|
string |
https://localhost:9200 |
The public facing URL of the oCIS Web UI, used e.g. when sending notification eMails |
|
string |
|
SMTP host to connect to. |
|
int |
1025 |
Port of the SMTP host to connect to. |
|
string |
ownCloud <noreply@example.com> |
Sender address of emails that will be sent. |
|
string |
|
Username for the SMTP host to connect to. |
|
string |
|
Password for the SMTP host to connect to. |
|
bool |
false |
Allow insecure connections to the SMTP server. |
|
string |
none |
Authentication method for the SMTP communication. Possible values are 'login', 'plain', 'crammd5', 'none' |
|
string |
none |
Encryption method for the SMTP communication. Possible values are 'starttls', 'ssl', 'ssltls', 'tls' and 'none'. |
|
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. |
|
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. |
|
string |
notifications |
Name of the event group / queue on the event system. |
|
bool |
false |
Whether to verify the server TLS certificates. |
|
string |
|
The root CA certificate used to validate the server’s TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. |
|
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.. |
|
string |
|
Machine auth API key used to validate internal requests necessary to access resources from other services. |
|
string |
|
Path to Email notification templates overriding embedded ones. |
|
string |
127.0.0.1:9142 |
CS3 gateway used to look up user metadata |
|
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 to use transport security, but disables certificate verification (to be used with the autogenerated self-signed certificates). 'on' enables transport security, including server ceritificate verification. |
|
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. |
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.
# Autogenerated
# Filename: notifications-config-example.yaml
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: 1025
smtp_sender: ownCloud <noreply@example.com>
smtp_username: ""
smtp_password: ""
insecure: false
smtp_authentication: none
smtp_encryption: none
events:
endpoint: 127.0.0.1:9233
cluster: ocis-cluster
group: notifications
tls_insecure: false
tls_root_ca_certificate: ""
enable_tls: false
machine_auth_api_key: ""
email_template_path: ""
reva_gateway: 127.0.0.1:9142
grpc_client_tls: null
# Autogenerated
# Filename: notifications-config-example.yaml
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: 1025
smtp_sender: ownCloud <noreply@example.com>
smtp_username: ""
smtp_password: ""
insecure: false
smtp_authentication: none
smtp_encryption: none
events:
endpoint: 127.0.0.1:9233
cluster: ocis-cluster
group: notifications
tls_insecure: false
tls_root_ca_certificate: ""
enable_tls: false
machine_auth_api_key: ""
email_template_path: ""
reva_gateway: 127.0.0.1:9142
grpc_client_tls:
mode: ""
cacert: ""