RyderTech/rsvp-manager
1
0
Fork 0
Code Issues Pull Requests Packages Activity

Update README.md

Browse Source
This commit is contained in:
Joshua Ryder
2025-05-25 19:50:04 -04:00
committed by GitHub
parent 2b4b3ecba7
commit f44683bc92
1 changed files with 3 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -79,20 +79,6 @@ These variables below are all for the email notifications. If you want to be abl
| EMAIL_FROM_ADDRESS | Email displayed in the "from" on email notifications |
| FRONTEND_BASE_URL | The main URL for your instance. This will be used in the links that are sent in the email notificiations, eg. https://rsvp.example.com |
#### Environment Variables
These variables below are all for the email notifications. If you want to be able to send email notifications, each of these needs to be provided and filled out.
| Variable | Description |
| ------------- | ------------- |
| EMAIL_HOST | Your email provider's host name |
| EMAIL_PORT | Your email provider's SMTP port |
| EMAIL_USER | Login username for your email provider |
| EMAIL_PASS | Login password for your email provider |
| EMAIL_FROM_NAME | Name displayed in the "from" on email notifications |
| EMAIL_FROM_ADDRESS | Email displayed in the "from" on email notifications |
| FRONTEND_BASE_URL | The main URL for your instance. This will be used in the links that are sent in the email notificiations, eg. https://rsvp.example.com |
#### Docker Compose
1. Clone the repository.
@@ -150,10 +136,12 @@ docker run -d --name rsvp-manager \
npm start
```
## Email Notifications (Currently in dev branch!)
## Email Notifications
By setting up the environment variables in the `docker-compose.yml`, you can have notifications sent to the recipients of your choice when someone submits an RSVP to an event. The notification will include the details of their submission and links to view or manage the RSVPs for that event.
Users will also have the option to get an email confirmation of their submission that will include a unique link to view/edit their submission!
## Authentication with Authentik
This application is compatible with Authentik. Make sure to create a Proxy Provider for Forward auth (single application). To protect the admin & create routes, add the following configuration to your Nginx Proxy Manager config in the Advanced section. For other web server applications, see the Setup area in Authentik on the Provider page for this app and setup the routes accordingly.