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

📝 Updated docs

Browse source
This commit is contained in:
Luke Vella 2023-04-21 17:17:15 +01:00
parent 665925a0e6
commit 7cbf14127a
17 changed files with 177 additions and 264 deletions
Download patch file Download diff file Expand all files Collapse all files

17
apps/docs/administrators/accessing-the-admin-page.mdx
View file

@ -1,17 +0,0 @@
---
title: "Accessing the Admin Page"
description:
"The admin page is where you can make changes to your poll and view its
results."
---
When you create a poll, you will receive two links via email. One of those links
is for the admin page where you can make changes to your poll.
<Frame caption="The buttons at the top of the page are only visible on the admin page">
![](/images/administrators/admin-page.png)
</Frame>
Alternatively, if you log in with the same email address you used to create the
poll, you can access the admin page of any poll you created through the
[profile page](https://rallly.co/profile).

33
apps/docs/administrators/creating-a-poll.mdx Normal file
View file

@ -0,0 +1,33 @@
---
title: "Creating a meeting poll"
description: "Meeting polls allow participants to vote for their preferred dates."
---
## Get started
To create a meeting poll, start by going to the [New Meeting Poll Page](https://rallly.co/new).
## 1. Enter the meeting details
Enter a meaningful title for your participants to see.
You can also add a description to give more context to your poll and a location if desired.
<Frame>![](/images/administrators/new-meeting.png)</Frame>
Click **Continue** to proceed.
## 2. Choose date options
Use the date picker to select the dates you want to offer your participants.
After selecting your dates, you can also add a time range by switching on **Specify times**.
<Frame>![](/images/administrators/date-picker.png)</Frame>
If you're **logged in** you can click **Create poll** to create the poll.
If you're **not logged in**, can click **Continue** to proceed to the next step.
## 3. Enter your details (Guest's only)
Enter your name and email address.
These will only be used to email the link to the meeting poll to you and ensure you won't lose access to your poll.

2
apps/docs/administrators/deleting-a-poll.mdx
View file

@ -1,5 +1,5 @@
--- ---
title: "Deleting a poll" title: "Deleting a meeting poll"
description: 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." deleted poll."

2
apps/docs/administrators/editing-a-poll.mdx
View file

@ -1,5 +1,5 @@
--- ---
title: "Editing a poll" title: "Editing a meeting poll"
--- ---
First, make sure you have access to the First, make sure you have access to the

19
apps/docs/administrators/sharing-a-poll.mdx
View file

@ -1,23 +1,16 @@
--- ---
title: "Sharing a poll" title: "Sharing a meeting poll"
description: description: "How to share a meeting poll with participants."
"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."
--- ---
### Sharing with participants ### Sharing with participants
To share your poll with participants: To share your poll with participants, from the admin page:
1. Click on the **Share** button to open the popover. 1. Click on the **Share** button to open the popover.
2. Inside the popover you will see your **participant URL** for your poll. Copy 2. Inside the popover you will see a link to the **Participant Page** for your poll. Copy
this URL and send it to your participants via email or whichever way you this link and send it to your participants via email or whichever way you
prefer to communicate with your participants. prefer to communicate with your participants.
### Sharing with administrators <Frame>![Share Poll](/images/administrators/sharing.png)</Frame>
In some cases, you might want to give others the ability to make changes to your
poll such as adding more options or changing the title and description. This can
only be done with the **admin URL**. The admin URL is sent to you by email when
you create a poll.

BIN
apps/docs/favicon.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 707 B

After

Width:  |  Height:  |  Size: 566 B

Before After
Before After

44
apps/docs/get-started.mdx Normal file
View file

@ -0,0 +1,44 @@
---
title: "Get started"
description: "Welcome to the official documentation for Rallly"
---
## What is Rallly?
Rallly is a tool for creating meeting polls. It's designed to help you
schedule meetings with your team, friends, or anyone else. It's free to use and
you can create as many polls as you want.
## What is a Meeting Poll?
A meeting poll is a poll that helps you find a time that works for everyone. The host
of the meeting will typically select a few date and time options for participants to choose
from and then tally the results to find the best time.
## Guides
<CardGroup cols={2}>
<Card title="Quick start" icon="note" href="/administrator/creating-a-poll">
Get started by learning how to create a new meeting poll.
</Card>
<Card title="Self-Hosting" icon="server" href="/">
Learn how to run your own instance of Rallly on your own server.
</Card>
</CardGroup>
## Contact
If your question isn't answered here you can reach out through the following
channels:
<CardGroup cols={3}>
<Card title="Email" icon="envelope" href="mailto:support@rallly.co" />
<Card title="Discord" icon="discord" href="https://discord.gg/uzg4ZcHbuM" />
<Card
title="Support chat"
icon="comments"
href="https://go.crisp.chat/chat/embed/?website%5Fid=19d601db-af05-4f24-8342-8dd4449aedb8"
/>
</CardGroup>

BIN
apps/docs/images/administrators/date-picker.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 94 KiB

BIN
apps/docs/images/administrators/new-meeting.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 42 KiB

BIN
apps/docs/images/administrators/sharing.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 39 KiB

82
apps/docs/introduction.mdx
View file

@ -1,82 +0,0 @@
---
title: "Support"
description: "Get help with rallly.co"
---
## FAQ
<AccordionGroup>
<Accordion title="How long does Rallly keep a poll? When will my poll be deleted?" >
Polls are deleted if all the date options are in the past and no one has
accessed the poll for over 30 days.
Demo polls are deleted after 1 day.
</Accordion>
<Accordion title="How do I hide participants from each other?">
This is not currently supported but will be made possible in a future update.
</Accordion>
<Accordion title="How do I limit the number of participants for each option?">
This is not currently supported but will be made possible in a future update.
</Accordion>
<Accordion title="How do I find a poll I created?" >
When you create a poll the link to the **admin page** is emailed to you. Use the
link inside the email to get back to your poll.
Alternatively, you can [log in](https://rallly.co/login) with the same email
address you used to create the poll and go to the
[profile page](https://rallly.co/profile) were you can see a list of all the
polls you created.
</Accordion>
<Accordion title="What times will my participants see if they are in different timezones?" >
When you create a poll with timed options, Rallly will assume that the times are
specific to your current location. When participants view your poll they will
see times adjusted to their time zone. This works well if:
- participants are in different time zones and the meeting is being held
remotely
- all participants are in the same time zone
</Accordion>
<Accordion title="What if my participants are in different time zones but the event is in a specific location?" >
You can choose **Ignore time zone** when specifying options to make sure
everyone sees the same times. If you forget to do that when you create the poll
you can always change it later by going to **Manage > Edit Options** on your
poll.
![](/images/support.png)
</Accordion>
<Accordion title="How do I export my results to Excel?">
From your **admin page,** click on **Manage** **\> Export to CSV**. You can
open CSV files in [Google Sheets](https://sheets.google.com) or
[Excel](https://www.microsoft.com/en-ww/microsoft-365/excel).
</Accordion>
</AccordionGroup>
## Contact
If your question isn't answered here you can reach out through the following
channels:
<CardGroup cols ={3}>
<Card title="Email" icon="envelope" href="mailto:support@rallly.co" />
<Card title="Discord" icon="discord" href="https://discord.gg/uzg4ZcHbuM" />
<Card
title="Support chat"
icon="comments"
href="https://go.crisp.chat/chat/embed/?website%5Fid=19d601db-af05-4f24-8342-8dd4449aedb8"
/>
</CardGroup>

20
apps/docs/mint.json
View file

@ -12,12 +12,12 @@
"anchors": { "from": "#878AFA", "to": "#4347F1" } "anchors": { "from": "#878AFA", "to": "#4347F1" }
}, },
"topbarCtaButton": { "topbarCtaButton": {
"name": "Get started", "name": "Create a meeting poll",
"url": "https://rallly.co/new" "url": "https://rallly.co/new"
}, },
"topbarLinks": [ "topbarLinks": [
{ {
"name": "Live demo", "name": "Live chat",
"url": "https://rallly.co/demo" "url": "https://rallly.co/demo"
} }
], ],
@ -41,27 +41,31 @@
"navigation": [ "navigation": [
{ {
"group": "Introduction", "group": "Introduction",
"pages": ["introduction"] "pages": ["get-started"]
}, },
{ {
"group": "Administrators", "group": "For Administrators",
"pages": [ "pages": [
"administrators/accessing-the-admin-page", "administrators/creating-a-poll",
"administrators/sharing-a-poll", "administrators/sharing-a-poll",
"administrators/editing-a-poll", "administrators/editing-a-poll",
"administrators/deleting-a-poll" "administrators/deleting-a-poll"
] ]
}, },
{ {
"group": "Participants", "group": "For Participants",
"pages": [ "pages": [
"participants/submitting-a-response", "participants/submitting-a-response",
"participants/editing-a-response" "participants/editing-a-response"
] ]
}, },
{ {
"group": "Other Docs", "group": "Self-Hosting",
"pages": ["guest-sessions", "privacy-and-security", "self-hosting"] "pages": [
"self-hosting/getting-started",
"self-hosting/managed-hosting",
"self-hosting/configuration-options"
]
} }
], ],
"footerSocials": { "footerSocials": {

8
apps/docs/self-hosting.mdx
View file

@ -1,8 +0,0 @@
---
title: "Self-Hosting"
---
Rallly is completely open-source and self-hostable. For instructions on how to
get it running, check out the
[rallly-selfhosted](https://github.com/lukevella/rallly-selfhosted) repo on
github.

49
apps/docs/self-hosting/configuration-options.mdx Normal file
View 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 |

25
apps/docs/self-hosting/getting-started.mdx Normal file
View file

@ -0,0 +1,25 @@
---
title: Self-Hosting Rallly
description: How to run your own instance of Rallly.
---
## Getting 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.
<CardGroup cols={2}>
<Card
title="Run on my own server"
icon="docker"
href="https://github.com/lukevella/rallly-selfhosted"
>
Host your own instance of Rallly on your own server using Docker.
</Card>
<Card
icon="server"
title="Using a hosting provider"
href="/self-hosting/managed-hosting"
>
Choose a provider that will install and run an instance of Rallly for you.
</Card>
</CardGroup>

134
apps/docs/self-hosting/introduction.mdx
View file

@ -1,134 +0,0 @@
# 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)

6
apps/docs/self-hosting/managed-hosting.mdx Normal file
View file

@ -0,0 +1,6 @@
---
title: Managed Hosting
description: Using a managed hosting service to host your instance of Rallly.
---
Coming soon…