Skip to main content

Calendars

Each item under calendars defines one published feed.

config.yaml
calendars:
- name: outlook
publish_name: "Work Calendar"
token: "changeme"
feed_url: "https://outlook.office365.com/owa/calendar/example.ics"
user_agent: "ical-filter-proxy"

Common fields:

FieldRequiredDescription
nameYesCalendar slug used in the feed URL.
feed_urlYes, unless feed_url_file is setUpstream iCalendar URL. Must start with http:// or https://.
publish_nameNoCalendar name written to the published feed. Uses the upstream value when omitted.
publicNoAllows access without a token when true.
tokenRequired unless public: true or token_file is setToken required to access the published feed.
token_fileNoFile containing the access token. Takes precedence over token.
feed_url_fileNoFile containing the upstream feed URL. Takes precedence over feed_url.
user_agentNoOverrides the User-Agent header sent to this upstream feed. Defaults to ical-filter-proxy/<version>.
filtersNoOrdered filter and transform rules applied to events.

Published feeds are exposed at:

/calendars/<name>/feed
/calendars/<name>/feed?token=<token>

Use user_agent when an upstream provider requires a specific client string or blocks generic calendar fetchers. Leading and trailing whitespace is ignored.