mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-28 00:06:53 +01:00
d5fbd0b743
## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
49 lines
1.6 KiB
Markdown
49 lines
1.6 KiB
Markdown
---
|
|
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
|
|
|
|
```bash
|
|
[2021-05-07T12:59:04.572] [WARN] routes/user-controller.ts - email
|
|
was not sent to the user because email configuration is lacking
|
|
```
|
|
|
|
## Configuring {#configuring}
|
|
|
|
Depending on your deploy case there are different ways of configuring this service. Full documentation of all configuration possibilities is available [here](./configuring-unleash.md)
|
|
|
|
### Docker {#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 {#node}
|
|
|
|
With node, we can configure this when calling Unleash's start method.
|
|
|
|
```js
|
|
const unleash = require('unleash-server');
|
|
|
|
unleash.start({
|
|
email: {
|
|
host: 'myhost',
|
|
smtpuser: 'username',
|
|
smtppass: 'password',
|
|
sender: 'noreply@mycompany.com',
|
|
},
|
|
});
|
|
```
|