Mail notifications in OpenCloud

This guide shows how to configure your OpenCloud instance to send notification E-Mails by modifying the .env file in your OpenCloud setup

Open the .env File

Edit the file with your preferred text editor:

nano .env

Or use vim, code, or gedit as you prefer.

Add or modify these Environment Variables

Adjust the following lines in your .env file according to your SMTP provider and requirements.
Note: SMTP_TRANSPORT_ENCRYPTION and SMTP_INSECURE may vary depending on your setup.

SMTP Settings:

SMTP_HOST=YOUR_SMTP_HOST
SMTP_PORT=1025
SMTP_SENDER=noreply@your.text
SMTP_USERNAME=YOUR_USERNAME
SMTP_PASSWORD=YOUR_PASSWORD
SMTP_TRANSPORT_ENCRYPTION=none
SMTP_INSECURE=true
SMTP_AUTHENTICATION=auto

See section Environment Variables in the developers documentation for possible values for these variables. Note, that the environment variables are prefixed with NOTIFICATIONS_, so NOTIFICATIONS_SMTP_AUTHENTICATION shows possible values for SMTP_AUTHENTICATION in the .env file.

By default, the notifications service is disabled. To send notifications, enable the service in the .env file:

START_ADDITIONAL_SERVICES=notifications

In the OpenCloud Compose setup, START_ADDITIONAL_SERVICES is mapped to OC_ADD_RUN_SERVICES inside the OpenCloud container.

Save and exit

For nano, press Ctrl + O to save and Ctrl + X to exit.

Restart OpenCloud

Apply the changes by restarting the OpenCloud services:

docker compose down
docker compose up -d

OpenCloud is now successfully configured to deliver notification emails, including those triggered by actions such as file sharing.