diff --git a/README.md b/README.md index 9a05eed..ab4dad2 100644 --- a/README.md +++ b/README.md @@ -93,18 +93,19 @@ By default the app will run unencrypted on port 3000. If you want to serve the a The app can be configured with the following environment variables. -| Environment Variable | Default | Description | -| ----------------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| `AUTH_REQUIRED` | false | Set to `true` to require authentication for creating new polls and accessing admin pages | -| `ALLOWED_EMAILS` | | Comma separated list of email addresses that are allowed to register and login. Wildcard characters are supported. Example: `*@yourcompany.com` | -| `DISABLE_LANDING_PAGE` | false | Whether or not to disable the landing page | -| `NEXT_PUBLIC_BASE_URL` | http://localhost:3000 | The base url where this instance is accessible, including the scheme (eg. `http://` or `https://`), the domain name, and optionally a port. | -| `SECRET_PASSWORD` | | A random 32-character secret key used to encrypt user sessions | -| `SMTP_HOST` | localhost | The host address of your SMTP server | -| `SMTP_PORT` | 25 or 465 | The port of your SMTP server | -| `SMTP_SECURE` | false | Set to "true" if SSL is enabled for your SMTP connection | -| `SMTP_USER` | | The username (if auth is enabled on your SMTP server) | -| `SMTP_PWD` | | The password (if auth is enabled on your SMTP server) | +| Environment Variable | Default | Description | +| ---------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | +| `AUTH_REQUIRED` | false | Set to `true` to require authentication for creating new polls and accessing admin pages | +| `ALLOWED_EMAILS` | | Comma separated list of email addresses that are allowed to register and login. Wildcard characters are supported. Example: `*@yourcompany.com` | +| `DISABLE_LANDING_PAGE` | false | Whether or not to disable the landing page | +| `NEXT_PUBLIC_BASE_URL` | http://localhost:3000 | The base url where this instance is accessible, including the scheme (eg. `http://` or `https://`), the domain name, and optionally a port. | +| `SECRET_PASSWORD` | | A random 32-character secret key used to encrypt user sessions | +| `SUPPORT_EMAIL` | | All outgoing emails will show this email as the sender's email address, which also serves as the support email. | +| `SMTP_HOST` | localhost | The host address of your SMTP server | +| `SMTP_PORT` | 25 or 465 | The port of your SMTP server | +| `SMTP_SECURE` | false | Set to "true" if SSL is enabled for your SMTP connection | +| `SMTP_USER` | | The username (if auth is enabled on your SMTP server) | +| `SMTP_PWD` | | The password (if auth is enabled on your SMTP server) | ## Update Instructions