mirror of
https://github.com/lukevella/rallly.git
synced 2025-08-03 00:19:03 +02:00
📝 Updated docs
This commit is contained in:
parent
665925a0e6
commit
7cbf14127a
17 changed files with 177 additions and 264 deletions
49
apps/docs/self-hosting/configuration-options.mdx
Normal file
49
apps/docs/self-hosting/configuration-options.mdx
Normal file
|
@ -0,0 +1,49 @@
|
|||
---
|
||||
title: Configuration options
|
||||
description: Learn how to configure Rallly with environment variables.
|
||||
---
|
||||
|
||||
## Environment variables
|
||||
|
||||
Rallly can be configured with the following environment variables.
|
||||
|
||||
### Required config
|
||||
|
||||
These variables are required for Rallly to function properly.
|
||||
|
||||
| Name | Default | Description |
|
||||
| ---------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `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 |
|
||||
|
||||
### Email config
|
||||
|
||||
Configure the following variables to give Rallly the ability to send emails.
|
||||
|
||||
| Name | Default | Description |
|
||||
| ------------------ | --------- | --------------------------------------------------------------------------------------------------------------- |
|
||||
| `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) |
|
||||
| `SMTP_TLS_ENABLED` | false | Enable TLS for your SMTP connection |
|
||||
|
||||
### Optional config (recommended)
|
||||
|
||||
Adjust your instance and protect it from unauthorized users.
|
||||
|
||||
| Name | 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 |
|
||||
|
||||
### Advanced config
|
||||
|
||||
In most cases you won't need to set this yourself.
|
||||
|
||||
| Name | Default | Description |
|
||||
| -------------- | ------- | ----------------------------------- |
|
||||
| `DATABASE_URL` | | Postgres database connection string |
|
Loading…
Add table
Add a link
Reference in a new issue