Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added server email configuration guide #140

Merged
merged 1 commit into from
Feb 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions website/docs/admin_server_email.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
id: admin_server_email
title: Configuring email
sidebar_label: Configuring email
---

Ayon server can be configured for sending emails to users,
this may be used for the password recovery or by addons.


Using Ynput Cloud email service
-------------------------------

With an active Ynput cloud subscription, emails are sent using Ynput servers
and no configuration is necessary.


Using SMTP
----------

Without YnputCloud subscription, a working SMTP server is required.
SMTP is configured using the environment variables of the server container:

- `AYON_EMAIL_FROM` Email sender address (example: `[email protected]`)
- `AYON_EMAIL_SMTP_HOST` SMTP server hostname (example: `smtp.mystudio.com`)
- `AYON_EMAIL_SMTP_PORT` SMTP server port (example: `587`)
- `AYON_EMAIL_SMTP_TLS` Use SSL for SMTP connection (example: `true`)
- `AYON_EMAIL_SMTP_USER` SMTP server username (example: `mailuser`)
- `AYON_EMAIL_SMTP_PASS` SMTP server password (example: `supersecretpassword`)

When the environment variables are set properly and server is restarted,
you should see a "Reset password" link on the login page.

You may use that link to ensure that emails are sent
(don't worry, your password won't be reset, unless you change it
using a link in the email message).
1 change: 1 addition & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ module.exports = {
"admin_server_installing_addons",
"admin_server_provisioning",
"admin_server_services",
"admin_server_email",
],
},
{
Expand Down
Loading