Skip to main content

Quick Start

This starts a public example feed with Docker and a local config.yaml.

Create a config file:

config.yaml
calendars:
  - name: example
    publish_name: "Example Calendar"
    public: true
    feed_url: "https://example.com/calendar.ics"
    filters:
      - description: "Remove cancelled events"
        remove: true
        match:
          summary:
            prefix: "Canceled: "

Run the service:

docker run --rm \
  -v ./config.yaml:/app/config.yaml:ro \
  -p 8080:8080 \
  yungwood/ical-filter-proxy:latest

Subscribe to the filtered feed:

http://localhost:8080/calendars/example/feed

Next Steps​