Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity
5c3fe631f0
unleash.unleash/website/docs/using-unleash/deploy/email-service.md
Drew Gorton b2b19e4970
Navigation refactor (#5227) 
## About the changes
Refactor the main nav, with the following goals: 
* Communicate the value of each section vs the format (ex:
“Understanding Unleash” vs “Topic Guides”)
* Make space for the Feature Flag tutorials section that we’re starting
to build
* Scope updates to navigation and pages that need updates based on new
URLs & organization
* Update URLs to follow the new hierarchy without breaking links (adding
redirects & editing internal links between pages as needed)

### Important files
sidebar.js
docusaurus.config.js

## Discussion points
* Redirects can't be tested out of prod, which is a bummer :/
* Some URLs have been preserved untouched while we monitor for potential
negative SEO impact of client-side redirects
* It's a large PR (sorry). Nav changes and file movements impacted lots
of files.

---------

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-10-31 09:38:03 -05:00

1.6 KiB
Raw Blame History

title
Email service

New since Unleash v4.0.0 is an email service allowing us to send reset password and welcome mails to new users. In order for this to work you'll need to tell unleash what SMTP service you'd like to send mails from.

If the service is not configured you'll see a log line every time you add a new user saying

[2021-05-07T12:59:04.572] [WARN] routes/user-controller.ts - email
was not sent to the user because email configuration is lacking

Configuring

Depending on your deploy case there are different ways of configuring this service. Full documentation of all configuration possibilities is available here

Docker

With docker, we configure the mail service via environment variables.

You'll want to at least include EMAIL_HOST, EMAIL_USER, EMAIL_PASSWORD and EMAIL_SENDER

Environment variables:

  • EMAIL_HOST - Your SMTP server address
  • EMAIL_PORT - Your SMTP server port - defaults to 567
  • EMAIL_SECURE - whether to use SMTPS - set to false or true - defaults to false,
  • EMAIL_USER - the username to authenticate against your SMTP server
  • EMAIL_PASSWORD - the password for your SMTP user
  • EMAIL_SENDER - which address should reset-password mails and welcome mails be sent from - defaults to noreply@unleash-hosted.com which is probably not what you want.

Node

With node, we can configure this when calling Unleash's start method.

const unleash = require('unleash-server');

unleash.start({
  email: {
    host: 'myhost',
    smtpuser: 'username',
    smtppass: 'password',
    sender: 'noreply@mycompany.com',
  },
});