diff --git a/README.md b/README.md index b56c1f0..193da1a 100644 --- a/README.md +++ b/README.md @@ -23,21 +23,21 @@ strictly required, but some functions might not work if a service is configured go-drink uses Postgresql as a database backend and fully depends on it. If a database backend is not configured, or if it is unreachable during the application startup, go-drink terminates instantly. -| Environment Variable | Example Value | Notes | -| --- | --- |---------------------------------------------------------------| -| GODRINK_DB | `postgresql://godrink:changeme@db:5432/godrink?sslmode=disable` | A connection string describing of the database can be reached | +| Environment Variable | Example Value | Notes | +|----------------------|-----------------------------------------------------------------|---------------------------------------------------------------| +| GODRINK_DB | `postgresql://godrink:changeme@db:5432/godrink?sslmode=disable` | A connection string describing of the database can be reached | ### SMTP / Mailing An SMTP server can be configured, so that the application can send out emails to users, for example if a password reset is requested. If the SMTP configuration is omitted, or contains invalid data, a warning is logged, but the application functions otherwise normally. -| Environment Variable | Example Value | Notes | -| --- |--------------------------------|----------------------------------------------------------------| -| GODRINK_SMTPHOST | `yourmailhost.example:465` | The address of the SMTP Server, in the format : | -| GODRINK_SMTPUSER | `godrink@yourmailhost.example` | The username that should be used to authenticate to the server | -| GODRINK_SMTPPASS | `changeme` | The corresponding password for the user. | -| GODRINK_SMTPFROM | `godrink@yourmailhost.example` | The address that is used in the `From` header header when sending out emails. If omitted, the value of `GODRINK_SMTPUSER` is used. | +| Environment Variable | Example Value | Notes | +|----------------------|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------| +| GODRINK_SMTPHOST | `yourmailhost.example:465` | The address of the SMTP Server, in the format : | +| GODRINK_SMTPUSER | `godrink@yourmailhost.example` | The username that should be used to authenticate to the server | +| GODRINK_SMTPPASS | `changeme` | The corresponding password for the user. | +| GODRINK_SMTPFROM | `godrink@yourmailhost.example` | The address that is used in the `From` header header when sending out emails. If omitted, the value of `GODRINK_SMTPUSER` is used. | **A note on TLS:** Currently, the application expects that it can open a TLS encrypted connection to the target port. STARTTLS or plaintext communication is not supported at the moment.