From f52e21a5e82cf216f9a9a182066bf5332bd21d27 Mon Sep 17 00:00:00 2001 From: Nick Fox Date: Tue, 1 Jan 2019 01:34:41 +0000 Subject: [PATCH] Created SMTP configuration (markdown) --- SMTP-configuration.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 SMTP-configuration.md diff --git a/SMTP-configuration.md b/SMTP-configuration.md new file mode 100644 index 0000000..d9df4da --- /dev/null +++ b/SMTP-configuration.md @@ -0,0 +1,27 @@ +You can configure bitwarden_rs to send emails via a SMTP agent: + +```sh +docker run -d --name bitwarden \ + -e SMTP_HOST= \ + -e SMTP_FROM= \ + -e SMTP_PORT=587 \ + -e SMTP_SSL=true \ + -e SMTP_USERNAME= \ + -e SMTP_PASSWORD= \ + -v /bw-data/:/data/ \ + -p 80:80 \ + mprasil/bitwarden:latest +``` + +When `SMTP_SSL` is set to `true`(this is the default), only TLSv1.1 and TLSv1.2 protocols will be accepted and `SMTP_PORT` will default to `587`. If set to `false`, `SMTP_PORT` will default to `25` and the connection won't be encrypted. This can be very insecure, use this setting only if you know what you're doing. + +Note that if SMTP and invitations are enabled, invitations will be sent to new users via email. You must set the `DOMAIN` configuration option with the base URL of your bitwarden_rs instance for the invite link to be generated correctly: + +```sh +docker run -d --name bitwarden \ +... +-e DOMAIN=https://vault.example.com \ +... +``` + +User invitation links are valid for 5 days, after which a new invitation will need to be sent. \ No newline at end of file