Update README.md

This commit is contained in:
Jordan Wages 2025-05-01 18:05:17 -05:00
parent 5ad179974a
commit 21a91e6c17

View file

@ -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