3pp-mirror/rallly
1
0
Fork 0
mirror of https://github.com/lukevella/rallly.git synced 2025-06-04 03:32:12 +02:00
Code Issues Projects Releases Packages Wiki Activity

📝 Update docs

Browse source
This commit is contained in:
Luke Vella 2023-04-22 11:29:05 +01:00
parent 7cbf14127a
commit ac403d1f99
26 changed files with 111 additions and 122 deletions
Download patch file Download diff file Expand all files Collapse all files

59
apps/docs/self-hosting/configuration-options.mdx
View file

@ -1,49 +1,24 @@
---
title: Configuration options
description: Learn how to configure Rallly with environment variables.
title: Configuration Options
description: Using environment variable to configure a self-hosted instance of Rallly.
---
## 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 |
| 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. |

6
apps/docs/self-hosting/getting-started.mdx → apps/docs/self-hosting/introduction.mdx
View file

@ -1,11 +1,11 @@
---
title: Self-Hosting Rallly
title: Introduction
description: How to run your own instance of Rallly.
---
## Getting Started
## Get Started
Depending on how comfortable you are with technical things, you can either run Rallly on your own server or choose a provider that will do it for you.
Depending on how comfortable you are with technical things, you can either run Rallly on your own server or choose a managed hosting provider that will do it for you.
<CardGroup cols={2}>
<Card