From 7afeca1accb4e8e2dad0a6c2cf1bc9242bddb535 Mon Sep 17 00:00:00 2001 From: Joshua Ryder Date: Sun, 4 May 2025 18:13:54 -0400 Subject: [PATCH 1/3] Update and rename docker-compose.yml to docker-compose-build.yml --- docker-compose.yml => docker-compose-build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename docker-compose.yml => docker-compose-build.yml (84%) diff --git a/docker-compose.yml b/docker-compose-build.yml similarity index 84% rename from docker-compose.yml rename to docker-compose-build.yml index e60160a..8dfbf84 100644 --- a/docker-compose.yml +++ b/docker-compose-build.yml @@ -1,6 +1,6 @@ services: app: - container_name: rsvp_manager-dev + container_name: rsvp_manager build: context: . dockerfile: Dockerfile @@ -15,4 +15,4 @@ services: volumes: data: - uploads: \ No newline at end of file + uploads: From 3288ff6589057c8acd59c4e307639f0711d06385 Mon Sep 17 00:00:00 2001 From: Joshua Ryder Date: Sun, 4 May 2025 18:15:01 -0400 Subject: [PATCH 2/3] Create docker-compose.yml --- docker-compose.yml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docker-compose.yml diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..f600924 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,16 @@ +services: + app: + container_name: rsvp_manager + image: ryderjj89/rsvp-manager:latest + ports: + - "3000:3000" + volumes: + - data:/app + - uploads:/app/uploads + environment: + - NODE_ENV=production + restart: unless-stopped + +volumes: + data: + uploads: From bd2fd004e1068eb0283ec665e62d5d478c3796cc Mon Sep 17 00:00:00 2001 From: Joshua Ryder Date: Fri, 16 May 2025 21:44:26 -0400 Subject: [PATCH 3/3] Update README.md Added environment variable information. --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6820f83..d91c3f9 100644 --- a/README.md +++ b/README.md @@ -61,12 +61,26 @@ There are 2 branches, latest & dev. | Branch | Description | | ------------- | ------------- | | Latest | The most recent stable build. Use this if you don't like to get changes early. | -| Dev | Use this if you want to be on the cutting edge, can be unstable. | +| Dev | Use this if you want to be on the cutting edge, can be unstable, or even broken. | + +#### 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. -2. Edit the `docker-compose.yml` for the tag you'd like to use, then save it. +2. Edit the `docker-compose.yml` for the tag you'd like to use & environment variables (described above), then save it. 3. Run `docker compose up -d` to start the application. 4. Access the application at `http://localhost:3000`. @@ -81,6 +95,14 @@ docker run -d --name rsvp-manager \ -v rsvp-manager_data:/app \ -v rsvp-manager_uploads:/app/uploads \ -e NODE_ENV=production \ + -e EMAIL_HOST=smtp.host.com \ + -e EMAIL_PORT=### \ + -e EMAIL_USER=username \ + -e EMAIL_PASS=password \ + -e EMAIL_FROM_NAME=name \ + -e EMAIL_FROM_ADDRESS=name@example.com \ + -e EMAIL_SECURE=true or false \ + -e FRONTEND_BASE_URL=https://rsvp.example.com \ --restart unless-stopped \ ryderjj89/rsvp-manager: ```