Skip to content

Commit

Permalink
Add usage documentation
Browse files Browse the repository at this point in the history
RealOrangeOne committed Mar 18, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent f50300d commit e4937a1
Showing 2 changed files with 7 additions and 4 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -4,6 +4,12 @@ A utility to merge calendar feeds together, optionally offsetting by a given num

Individual calendars can be protected by basic authentication if required (values can be read from environment variables, too).

## Usage

Calendars are served based on their [name](#configuration), at `/{name}.ics`.

Calendars which allow custom offsets (`allow_custom_offset = true`) can add `?offset_days=3` to customize the offset. Events can only be offset ±10 years. When not configured, this parameter is ignored.

## Deployment

`calmerge` is available as a Docker container. Configuration should be mounted to `/app/calendars.toml`. An empty file is provided so the server will start successfully.
5 changes: 1 addition & 4 deletions tests/calendars.toml
Original file line number Diff line number Diff line change
@@ -24,7 +24,4 @@ name = "python-authed"
urls = [
"https://endoflife.date/calendar/python.ics",
]

[calendar.auth]
username = "user"
password = "password"
auth = {username = "user", password="password"}

0 comments on commit e4937a1

Please sign in to comment.