diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8439d34c0..e0c738d8f 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,4 +1,4 @@ -name: ci +name: CI on: pull_request jobs: diff --git a/README.md b/README.md index 2db31b399..3c6e4dd88 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -[![Actions Status](https://github.com/lukevella/rallly/workflows/ci/badge.svg)](https://github.com/lukevella/rallly/actions) +[![Actions Status](https://github.com/lukevella/rallly/workflows/CI/badge.svg)](https://github.com/lukevella/rallly/actions) Rallly is an open-source collaborative scheduling service – designed and developed by @lukevella @@ -19,18 +19,17 @@ git clone https://github.com/lukevella/Rallly.git cd Rallly ``` -_optional_: Configure your SMTP server. Without this, Rallly won't be able to send out emails. You can set the following environment variables in a `.env` in the root of the project. +_optional_: Configure your SMTP server. Without this, Rallly won't be able to send out emails. You can set the following environment variables in a `.env` in the root of the project ``` -# /.env -# This will appear as the FROM email address -SUPPORT_EMAIL="" -# SMTP Server Details -SMTP_HOST="" -SMTP_PORT="" -SMTP_SECURE="" # Enable TLS - "true" or "false" (default: "false") -SMTP_USER="" -SMTP_PWD="" +# support email - used as FROM email by SMTP server +SUPPORT_EMAIL=foo@yourdomain.com +# SMTP server - required if you want to send emails +SMTP_HOST=your-smtp-server +SMTP_PORT=587 +SMTP_SECURE="false" +SMTP_USER=your-smtp-user +SMTP_PWD=your-smtp-password ``` Build and run with `docker-compose` @@ -53,23 +52,22 @@ cd Rallly Copy the sample `.env` file then open it and set the variables. ```bash -cp rallly-conf.env .env +cp sample.env .env ``` -You will need to supply a url to an empty postgres database. +Fill in the required environment variables. ``` -# /.env -# Postgres connection URL -DATABASE_URL="" -# This will appear as the FROM email address -SUPPORT_EMAIL="" -# SMTP Server Details -SMTP_HOST="" -SMTP_PORT="" -SMTP_SECURE="" # Enable TLS - "true" or "false" (default: "false") -SMTP_USER="" -SMTP_PWD="" +# postgres database - not needed if running with docker-compose +DATABASE_URL=postgres://your-database/db +# support email - used as FROM email by SMTP server +SUPPORT_EMAIL=foo@yourdomain.com +# SMTP server - required if you want to send emails +SMTP_HOST=your-smtp-server +SMTP_PORT=587 +SMTP_SECURE="false" +SMTP_USER=your-smtp-user +SMTP_PWD=your-smtp-password ``` Install dependencies diff --git a/sample.env b/sample.env index 09e2388bc..2d1720ffb 100644 --- a/sample.env +++ b/sample.env @@ -1,8 +1,10 @@ -# postgres database - not needed if running with docker-compose -DATABASE_URL=replace-me -# smtp server - required if you want to receive emails -SMTP_HOST=replace-me -SMTP_PORT=replace-me -SMTP_SECURE=replace-me # TLS Enabled - "true" or "false" (default: "false") -SMTP_USER=replace-me -SMTP_PWD=replace-me +# postgres database - not needed if running with docker-compose +DATABASE_URL=postgres://your-database/db +# support email - used as FROM email by SMTP server +SUPPORT_EMAIL=foo@yourdomain.com +# SMTP server - required if you want to send emails +SMTP_HOST=your-smtp-server +SMTP_PORT=587 +SMTP_SECURE="false" +SMTP_USER=your-smtp-user +SMTP_PWD=your-smtp-password