trustchain-oc1-orchestral/authentik
Archived
10
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

website/docs: note to not use quotation marks for email

Browse source 
Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
This commit is contained in:
Jens Langhammer 2021-11-21 21:52:29 +01:00
parent 61621e7d60
commit c663deb659
3 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
website/docs/installation/configuration.md
View file

@ -100,11 +100,11 @@ Disable the inbuilt update-checker. Defaults to `false`.
- `AUTHENTIK_EMAIL__USERNAME`
Default: `""`
Default: `` (Don't add quotation marks)
- `AUTHENTIK_EMAIL__PASSWORD`
Default: `""`
Default: `` (Don't add quotation marks)
- `AUTHENTIK_EMAIL__USE_TLS`

6
website/docs/installation/docker-compose.md
View file

@ -39,9 +39,9 @@ Append this block to your `.env` file
# SMTP Host Emails are sent to
AUTHENTIK_EMAIL__HOST=localhost
AUTHENTIK_EMAIL__PORT=25
# Optionally authenticate
AUTHENTIK_EMAIL__USERNAME=""
AUTHENTIK_EMAIL__PASSWORD=""
# Optionally authenticate (don't add quotation marks to you password)
AUTHENTIK_EMAIL__USERNAME=
AUTHENTIK_EMAIL__PASSWORD=
# Use StartTLS
AUTHENTIK_EMAIL__USE_TLS=false
# Use SSL

6
website/docs/troubleshooting/emails.md
View file

@ -5,7 +5,7 @@ title: Troubleshooting Email sending
To test if an email stage, or the global email settings are configured correctly, you can run the following command:
````
./manage.py test_email <to address> [-s <stage name>]
ak test_email <to address> [-s <stage name>]
```
If you omit the `-s` parameter, the email will be sent using the global settings. Otherwise, the settings of the specified stage will be used.
@ -13,11 +13,11 @@ If you omit the `-s` parameter, the email will be sent using the global settings
To run this command with docker-compose, use
```
docker-compose exec worker ./manage.py test_email [...]
docker-compose exec worker ak test_email [...]
```
To run this command with Kubernetes, use
```
kubectl exec -it deployment/authentik-worker -c authentik -- ./manage.py test_email [...]
kubectl exec -it deployment/authentik-worker -c authentik -- ak test_email [...]
```