Skip to content

Commit

Permalink
📝 Update configuration options
Browse files Browse the repository at this point in the history
  • Loading branch information
@lukevella
lukevella committed Apr 25, 2023
1 parent 166f558 commit b4c3ac4
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions apps/docs/self-hosting/configuration-options.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,19 @@ description: Using environment variable to configure a self-hosted instance of R

Rallly can be configured with the following environment variables.

| Environment Variable | Default | Description |
| ---------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `ALLOWED_EMAILS` | | Comma separated list of email addresses that are allowed to register and login. Wildcard characters are supported. Example: `*@yourcompany.com` |
| `AUTH_REQUIRED` | false | Set to `true` to require authentication for creating new polls and accessing admin pages |
| `DATABASE_URL` | | Postgres database connection string |
| `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) |
| `SMTP_TLS_ENABLED` | false | Enable TLS for your SMTP connection |
| `SUPPORT_EMAIL` | | All outgoing emails will show this email as the sender's email address, which also serves as the support email. |
| Environment Variable | Default | Description |
| ---------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ALLOWED_EMAILS` | | Comma separated list of email addresses that are allowed to register and login. Wildcard characters are supported. Example: `*@yourcompany.com` |
| `AUTH_REQUIRED` | false | Set to `true` to require authentication for creating new polls and accessing admin pages |
| `DATABASE_URL` | | Postgres database connection string |
| `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) |
| `SMTP_TLS_ENABLED` | false | Enable TLS for your SMTP connection |
| `NOREPLY_EMAIL` | | This email is used as the sender for all transactional emails. |
| `SUPPORT_EMAIL` | | This email will be shown as the contact email for support queries. If `NOREPLY_EMAIL` is not set, it will also be used as the sender for all transactional emails. |

0 comments on commit b4c3ac4

Please sign in to comment.