From 21a91e6c17c06aabd54df3c3591e08c18cfe5ab9 Mon Sep 17 00:00:00 2001 From: wagesj45 Date: Thu, 1 May 2025 18:05:17 -0500 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 89a2556..83fbc6e 100644 --- a/README.md +++ b/README.md @@ -63,14 +63,28 @@ This project provides a self-contained, Dockerized email reminder system that po - SMTP credentials for an outbound mail service -## Environment Variables +## Environment Configuration -Place these in a `.env` file in the root of your project: +All configuration is done via environment variables. An example file is provided: -```env -... +```bash +.env.example ``` +To get started: + +1. Copy the file: +```bash +cp .env.example .env +``` + +2. Edit `.env` and fill in your CalDAV, SMTP, and scheduling details + +3. Run the container using that `.env` file + + +The app supports custom sync and dispatch intervals, authentication for CalDAV and SMTP, and full control over how reminders are sent. See `.env.example` for all available options and default values. + ## Building the Docker Image ```bash