Notifications Service Configuration

Introduction

The Infinite Scale Notification service provides …​

Services are under development because of the beta badge 1 stage of Infinite Scale. Their service, environment variables and configuration may change. Forgive us if there are mistakes or information is missing. Feel free to report issues and we’ll take care of them as soon as possible on github. You want to fix them yourself? We’d appreciate that even more.

Configuration

Environment Variables

The notifications extension is configured via the following environment variables:

Environment variables for the notifications extension
Name Type Default Value Description

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.

NOTIFICATIONS_SMTP_HOST

string

127.0.0.1

SMTP host, to connect to.

NOTIFICATIONS_SMTP_PORT

string

1025

Port of the SMTP host, to connect to.

NOTIFICATIONS_SMTP_SENDER

string

Sender of emails, that will be sent.

NOTIFICATIONS_SMTP_PASSWORD

string

Password of the SMTP host, to connect to.

NOTIFICATIONS_EVENTS_ENDPOINT

string

127.0.0.1:9233

Endpoint of the event system.

NOTIFICATIONS_EVENTS_CLUSTER

string

ocis-cluster

Cluster ID of the event system.

NOTIFICATIONS_EVENTS_GROUP

string

notifications

Name of the event group / queue on the event system.

REVA_GATEWAY
NOTIFICATIONS_REVA_GATEWAY

string

127.0.0.1:9142

CS3 gateway used to look up user metadata

OCIS_MACHINE_AUTH_API_KEY
NOTIFICATIONS_MACHINE_AUTH_API_KEY

string

Machine auth API key used for accessing the 'auth-machine' service to look up their email.

Since Version: + added, - deprecated

YAML Example

# 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
notifications:
  SMTP:
    smtp_host: 127.0.0.1
    smtp_port: "1025"
    smtp_sender: noreply@example.com
    smtp_password: ""
  events:
    endpoint: 127.0.0.1:9233
    cluster: ocis-cluster
    group: notifications
  reva_gateway: 127.0.0.1:9142
  machine_auth_api_key: ""