mirror of
https://github.com/lukevella/rallly.git
synced 2025-04-28 17:56:37 +02:00
📝 Update docs
This commit is contained in:
Luke Vella
parent
fe2a0fad3c
commit
7e69dc5c44
10 changed files with 144 additions and 11 deletions
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: "Accessing the Admin Page"
|
||||
description:
|
||||
"👑 The admin page is where you can make changes to your poll and view its
|
||||
"The admin page is where you can make changes to your poll and view its
|
||||
results."
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: "Deleting a poll"
|
||||
description:
|
||||
"❌ Deleting a poll is an irreversible action. There is no way to restore a
|
||||
"Deleting a poll is an irreversible action. There is no way to restore a
|
||||
deleted poll."
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: "Sharing a poll"
|
||||
description:
|
||||
"🤝 Once you've created a poll, you will be redirected to the admin URL where
|
||||
"Once you've created a poll, you will be redirected to the admin URL where
|
||||
you can see your poll along with options to edit and share it."
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: "Guest sessions"
|
||||
description:
|
||||
"🙈 When you vote on a poll, you may need to come back later and adjust your
|
||||
"When you vote on a poll, you may need to come back later and adjust your
|
||||
votes. Guest sessions allow you to do this without making an account and
|
||||
logging in."
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: "Support"
|
||||
description: "⛑ Get help with rallly.co"
|
||||
description: "Get help with rallly.co"
|
||||
---
|
||||
|
||||
## FAQ
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
<svg width="1078" height="200" viewBox="0 0 1078 200" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M17.3889 0C7.78889 0 0 7.77778 0 17.3889V182.611C0 192.211 7.77778 200 17.3889 200H182.611C192.211 200 200 192.222 200 182.611V17.3889C200 7.78889 192.222 0 182.611 0H17.3889ZM181.822 45.4444H18.1778V181.822H181.822V45.4444ZM156.522 26.0889C156.564 27.2568 156.37 28.4212 155.952 29.5125C155.534 30.6038 154.9 31.5997 154.089 32.4407C153.277 33.2817 152.304 33.9506 151.229 34.4074C150.153 34.8643 148.996 35.0998 147.828 35.0998C146.659 35.0998 145.502 34.8643 144.427 34.4074C143.351 33.9506 142.378 33.2817 141.567 32.4407C140.756 31.5997 140.122 30.6038 139.704 29.5125C139.286 28.4212 139.092 27.2568 139.133 26.0889C139.214 23.8368 140.165 21.7038 141.787 20.139C143.409 18.5742 145.574 17.6998 147.828 17.6998C150.081 17.6998 152.247 18.5742 153.869 20.139C155.49 21.7038 156.442 23.8368 156.522 26.0889ZM43.4778 34.7778C44.6457 34.8195 45.8101 34.6256 46.9014 34.2074C47.9927 33.7893 48.9886 33.1556 49.8296 32.3441C50.6706 31.5326 51.3395 30.56 51.7963 29.4844C52.2532 28.4087 52.4886 27.252 52.4886 26.0833C52.4886 24.9147 52.2532 23.758 51.7963 22.6823C51.3395 21.6066 50.6706 20.634 49.8296 19.8226C48.9886 19.0111 47.9927 18.3774 46.9014 17.9592C45.8101 17.5411 44.6457 17.3471 43.4778 17.3889C41.2257 17.4694 39.0926 18.4207 37.5279 20.0424C35.9631 21.6641 35.0886 23.8298 35.0886 26.0833C35.0886 28.3369 35.9631 30.5025 37.5279 32.1243C39.0926 33.746 41.2257 34.6973 43.4778 34.7778ZM55.2556 116.111C54.8521 115.708 54.532 115.229 54.3136 114.702C54.0953 114.174 53.9829 113.609 53.9829 113.039C53.9829 112.468 54.0953 111.903 54.3136 111.376C54.532 110.849 54.8521 110.37 55.2556 109.967L61.4 103.822C61.8034 103.419 62.2824 103.099 62.8095 102.88C63.3367 102.662 63.9016 102.55 64.4722 102.55C65.0428 102.55 65.6078 102.662 66.1349 102.88C66.6621 103.099 67.141 103.419 67.5444 103.822L89.4778 125.744L137.489 77.7333C137.892 77.3298 138.371 77.0098 138.898 76.7914C139.426 76.573 139.991 76.4606 140.561 76.4606C141.132 76.4606 141.697 76.573 142.224 76.7914C142.751 77.0098 143.23 77.3298 143.633 77.7333L149.789 83.8778C150.604 84.6944 151.063 85.8014 151.063 86.9556C151.063 88.1097 150.604 89.2167 149.789 90.0333L92.5778 147.222C92.1744 147.626 91.6954 147.946 91.1683 148.164C90.6411 148.383 90.0761 148.495 89.5056 148.495C88.935 148.495 88.37 148.383 87.8429 148.164C87.3157 147.946 86.8368 147.626 86.4333 147.222L55.2556 116.111ZM357.989 29.1667H312.067V155.556H335.933V107.811H358.744L383.411 155.556H409.033V154.333L381.144 102.089C384.619 100.591 387.892 98.6648 390.889 96.3556C395.111 93.1111 398.378 89.0889 400.7 84.2889C403.011 79.4889 404.167 73.8111 404.167 67.2778C404.167 59 402.311 52.0222 398.611 46.3556C394.911 40.6889 389.611 36.4 382.722 33.5111C375.833 30.6222 367.589 29.1667 357.989 29.1667ZM335.933 88.9778H358.244C363.167 88.9778 367.244 88.1111 370.489 86.3667C373.722 84.6333 376.156 82.2333 377.778 79.1667C379.456 76.1 380.3 72.6 380.3 68.6667C380.3 64.4444 379.489 60.7889 377.856 57.7222C376.233 54.5962 373.651 52.0727 370.489 50.5222C367.189 48.8444 363.022 48 357.989 48H335.933V88.9778ZM510.778 29.1667H516.678L564.144 155.556H538.811L529.311 127.433H482.111L472.667 155.556H447.4L494.622 29.1667H510.778ZM488.444 108.589H522.956L505.667 57.3667L488.444 108.589ZM690.722 136.811V155.556H610.511V29.1667H634.389V136.811H690.722ZM820.222 155.556V136.8H763.889V29.1778H740.022V155.556H820.222ZM949.744 136.8V155.556H869.522V29.1667H893.411V136.811L949.744 136.8ZM1019 88.1111L991.222 29.1667H964.833L1006.93 109.278V155.556H1031.16V109.289L1073.16 29.1667H1046.96L1019 88.1111Z" fill="#6366F1"/>
|
||||
<path fill-rule="evenodd" clip-rule="evenodd" d="M17.3889 0C7.78889 0 0 7.77778 0 17.3889V182.611C0 192.211 7.77778 200 17.3889 200H182.611C192.211 200 200 192.222 200 182.611V17.3889C200 7.78889 192.222 0 182.611 0H17.3889ZM181.822 45.4444H18.1778V181.822H181.822V45.4444ZM156.522 26.0889C156.564 27.2568 156.37 28.4212 155.952 29.5125C155.534 30.6038 154.9 31.5997 154.089 32.4407C153.277 33.2817 152.304 33.9506 151.229 34.4074C150.153 34.8643 148.996 35.0998 147.828 35.0998C146.659 35.0998 145.502 34.8643 144.427 34.4074C143.351 33.9506 142.378 33.2817 141.567 32.4407C140.756 31.5997 140.122 30.6038 139.704 29.5125C139.286 28.4212 139.092 27.2568 139.133 26.0889C139.214 23.8368 140.165 21.7038 141.787 20.139C143.409 18.5742 145.574 17.6998 147.828 17.6998C150.081 17.6998 152.247 18.5742 153.869 20.139C155.49 21.7038 156.442 23.8368 156.522 26.0889ZM43.4778 34.7778C44.6457 34.8195 45.8101 34.6256 46.9014 34.2074C47.9927 33.7893 48.9886 33.1556 49.8296 32.3441C50.6706 31.5326 51.3395 30.56 51.7963 29.4844C52.2532 28.4087 52.4886 27.252 52.4886 26.0833C52.4886 24.9147 52.2532 23.758 51.7963 22.6823C51.3395 21.6066 50.6706 20.634 49.8296 19.8226C48.9886 19.0111 47.9927 18.3774 46.9014 17.9592C45.8101 17.5411 44.6457 17.3471 43.4778 17.3889C41.2257 17.4694 39.0926 18.4207 37.5279 20.0424C35.9631 21.6641 35.0886 23.8298 35.0886 26.0833C35.0886 28.3369 35.9631 30.5025 37.5279 32.1243C39.0926 33.746 41.2257 34.6973 43.4778 34.7778ZM55.2556 116.111C54.8521 115.708 54.532 115.229 54.3136 114.702C54.0953 114.174 53.9829 113.609 53.9829 113.039C53.9829 112.468 54.0953 111.903 54.3136 111.376C54.532 110.849 54.8521 110.37 55.2556 109.967L61.4 103.822C61.8034 103.419 62.2824 103.099 62.8095 102.88C63.3367 102.662 63.9016 102.55 64.4722 102.55C65.0428 102.55 65.6078 102.662 66.1349 102.88C66.6621 103.099 67.141 103.419 67.5444 103.822L89.4778 125.744L137.489 77.7333C137.892 77.3298 138.371 77.0098 138.898 76.7914C139.426 76.573 139.991 76.4606 140.561 76.4606C141.132 76.4606 141.697 76.573 142.224 76.7914C142.751 77.0098 143.23 77.3298 143.633 77.7333L149.789 83.8778C150.604 84.6944 151.063 85.8014 151.063 86.9556C151.063 88.1097 150.604 89.2167 149.789 90.0333L92.5778 147.222C92.1744 147.626 91.6954 147.946 91.1683 148.164C90.6411 148.383 90.0761 148.495 89.5056 148.495C88.935 148.495 88.37 148.383 87.8429 148.164C87.3157 147.946 86.8368 147.626 86.4333 147.222L55.2556 116.111ZM357.989 29.1667H312.067V155.556H335.933V107.811H358.744L383.411 155.556H409.033V154.333L381.144 102.089C384.619 100.591 387.892 98.6648 390.889 96.3556C395.111 93.1111 398.378 89.0889 400.7 84.2889C403.011 79.4889 404.167 73.8111 404.167 67.2778C404.167 59 402.311 52.0222 398.611 46.3556C394.911 40.6889 389.611 36.4 382.722 33.5111C375.833 30.6222 367.589 29.1667 357.989 29.1667ZM335.933 88.9778H358.244C363.167 88.9778 367.244 88.1111 370.489 86.3667C373.722 84.6333 376.156 82.2333 377.778 79.1667C379.456 76.1 380.3 72.6 380.3 68.6667C380.3 64.4444 379.489 60.7889 377.856 57.7222C376.233 54.5962 373.651 52.0727 370.489 50.5222C367.189 48.8444 363.022 48 357.989 48H335.933V88.9778ZM510.778 29.1667H516.678L564.144 155.556H538.811L529.311 127.433H482.111L472.667 155.556H447.4L494.622 29.1667H510.778ZM488.444 108.589H522.956L505.667 57.3667L488.444 108.589ZM690.722 136.811V155.556H610.511V29.1667H634.389V136.811H690.722ZM820.222 155.556V136.8H763.889V29.1778H740.022V155.556H820.222ZM949.744 136.8V155.556H869.522V29.1667H893.411V136.811L949.744 136.8ZM1019 88.1111L991.222 29.1667H964.833L1006.93 109.278V155.556H1031.16V109.289L1073.16 29.1667H1046.96L1019 88.1111Z" fill="#4F46E5"/>
|
||||
</svg>
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 3.6 KiB After Width: | Height: | Size: 3.6 KiB |
|
|
@ -6,9 +6,9 @@
|
|||
},
|
||||
"favicon": "/favicon.png",
|
||||
"colors": {
|
||||
"primary": "#6366F1",
|
||||
"primary": "#4F46E5",
|
||||
"light": "#9C9EFF",
|
||||
"dark": "#334155",
|
||||
"dark": "#6366F1",
|
||||
"anchors": { "from": "#878AFA", "to": "#4347F1" }
|
||||
},
|
||||
"topbarCtaButton": {
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: "Editing a response"
|
||||
description:
|
||||
"✏️ As a participant, you are only allowed to edit your own response. Your
|
||||
"As a participant, you are only allowed to edit your own response. Your
|
||||
response will have a badge labelled 'You' next to the name."
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
title: "Submitting a response"
|
||||
description:
|
||||
"📥 To respond to a poll, start by clicking the buttons under the
|
||||
description: "To respond to a poll, start by clicking the buttons under the
|
||||
corresponding dates to set your availability."
|
||||
---
|
||||
|
||||
|
|
|
|||
134
apps/docs/self-hosting/introduction.mdx
Normal file
134
apps/docs/self-hosting/introduction.mdx
Normal file
|
|
@ -0,0 +1,134 @@
|
|||
# Rallly Self-Hosting Example
|
||||
|
||||
This repository contains all the necessary information and files to self-host your own instance of Rallly. Rallly is an open-source scheduling and collaboration tool designed to make organizing events and meetings easier.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Requirements](#requirements)
|
||||
- [Setup Instructions](#setup-instructions)
|
||||
- [Using a Reverse Proxy](#using-a-reverse-proxy)
|
||||
- [Configuration Options](#configuration-options)
|
||||
- [Update Instructions](#update-instructions)
|
||||
- [Links](#links)
|
||||
|
||||
## Requirements
|
||||
|
||||
To run this project you will need:
|
||||
|
||||
- Docker
|
||||
- Access to an SMTP server
|
||||
- x86-64 Architecture ([arm64 support has been suspended](https://github.com/lukevella/rallly/discussions/568))
|
||||
|
||||
## Setup Instructions
|
||||
|
||||
### 1. Clone the repository
|
||||
|
||||
```
|
||||
git clone https://github.com/lukevella/rallly-selfhosted.git
|
||||
cd rallly-selfhosted
|
||||
```
|
||||
|
||||
### 2. Add required config
|
||||
|
||||
In the root of this project you will find a file called `config.env`. This is where you can set your environment variables to configure your instance.
|
||||
|
||||
Start by generating a secret key. **Must be at least 32-characters long**.
|
||||
|
||||
```sh
|
||||
openssl rand -base64 32
|
||||
```
|
||||
|
||||
Open `config.env` and set `SECRET_PASSWORD` to your secret key.
|
||||
|
||||
Next, set `NEXT_PUBLIC_BASE_URL`. It should be the base url where this instance is accessible, including the scheme (eg. `http://` or `https://`), the domain name, and optionally a port. **Do not use trailing slashes or URLs with paths/subfolders.**.
|
||||
|
||||
### 3. Configure your SMTP Server
|
||||
|
||||
First, set `SUPPORT_EMAIL`. Your users will see this as the contact email for any support issues and it will also appear as the sender of all emails.
|
||||
|
||||
Next, use the following environment variables to configure your SMTP server:
|
||||
|
||||
- `SMTP_HOST` - The host address of your SMTP server
|
||||
- `SMTP_PORT` - The port of your SMTP server
|
||||
- `SMTP_SECURE` - Set to "true" if SSL is enabled for your SMTP connection
|
||||
- `SMTP_USER` - The username (if auth is enabled)
|
||||
- `SMTP_PWD` - The password (if auth is enabled)
|
||||
|
||||
### 4. Secure your instance (optional)
|
||||
|
||||
The default behaviour of the app is the same as on the cloud-hosted version on [rallly.co](https://rallly.co). i.e. Anyone can create polls without needing to log in. You can prevent this by setting `AUTH_REQUIRED` to `true` in `config.env` which limits poll creation and admin access to logged in users.
|
||||
|
||||
Additionally, you can restrict who is able to register and log in by setting `ALLOWED_EMAILS`. You can use wildcards to allow a range of email addresses.
|
||||
|
||||
```sh
|
||||
# Example: only users matching the following patterns can register/login
|
||||
ALLOWED_EMAILS="user@email.com,*@example.com,*@*.example.com"
|
||||
```
|
||||
|
||||
### 5. Disabling the landing page (optional)
|
||||
|
||||
By default the app will take you to the landing page which may not be what you want. If you want to go straight in to the app, set `DISABLE_LANDING_PAGE` to `true`.
|
||||
|
||||
### 6. Start the server
|
||||
|
||||
You can start the server by running:
|
||||
|
||||
```
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
This command will:
|
||||
|
||||
- Create a postgres database
|
||||
- Run migrations to set up the database schema
|
||||
- Start the Next.js server on port 3000
|
||||
|
||||
## Using a Reverse Proxy
|
||||
|
||||
By default the app will run unencrypted on port 3000. If you want to serve the app over HTTPS you will need to use a [reverse proxy](/reverse-proxy/README.md).
|
||||
|
||||
> After setting up a reverse proxy be sure to change this line `- 3000:3000` to - `127.0.0.1:3000:3000` in `docker-compose.yml` and restart the container for it to apply changes. This prevents Rallly from being accessed remotely using HTTP on port 3000 which is a security concern.
|
||||
|
||||
## Configuration Options
|
||||
|
||||
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` |
|
||||
| `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 |
|
||||
| `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
|
||||
|
||||
Rallly is constantly being updated but you will need to manually pull these updates and restart the server to run the latest version. You can do this by running the following commands from within this directory:
|
||||
|
||||
```sh
|
||||
docker compose down
|
||||
docker compose pull
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
### Version management
|
||||
|
||||
You can pin a specific version of Rallly by changing the `image` line in `docker-compose.yml`:
|
||||
|
||||
```
|
||||
- image: lukevella/rallly:<version>
|
||||
```
|
||||
|
||||
Check the [releases](https://github.com/lukevella/rallly/releases) to see what versions are available.
|
||||
We follow semver versioning so you may want to set your version to a major release (e.g. `lukevella/rallly:2`) to avoid pulling in breaking changes.
|
||||
|
||||
## Links
|
||||
|
||||
- [Source code](https://github.com/lukevella/rallly)
|
||||
Loading…
Add table
Reference in a new issue