iCal Filter Proxy
Proxy, filter, and transform noisy iCalendar feeds.
Read the docs
What's this thing?
Do you have iCal feeds with a bunch of stuff you don't need? Do you want to modify events generated by your rostering system?
iCal Filter Proxy is a simple service for proxying multiple iCal feeds while applying a list of filters to remove or modify events to suit your use case.
It supports:
- Multiple upstream calendars
- Private or public published feeds
- Ordered per-calendar filter rules
- Use match conditions and transformations to modify or remove events
- Docker, Helm, and Nix deployment options
- Prometheus metrics
Documentation
The full documentation site is published at:
https://yungwood.github.io/ical-filter-proxy/
Useful entry points:
Quick Start
Create a config file:
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 with Docker:
docker run --rm \
-v ./config.yaml:/app/config.yaml:ro \
-p 8080:8080 \
yungwood/ical-filter-proxy:latest
Subscribe to:
http://localhost:8080/calendars/example/feed
See the Quick Start
and Docker guide
for more complete examples.
Installation
Docker images are published to Docker Hub:
yungwood/ical-filter-proxy
Helm chart:
helm repo add yungwood https://yungwood.github.io/helm-charts/
helm install ical-filter-proxy yungwood/ical-filter-proxy
Nix:
nix run github:yungwood/ical-filter-proxy -- --help
See the documentation for Docker,
Helm,
Nix, and
source builds.
Development
Run tests:
go test ./...
Run linting:
go run github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.12.2 run --config .golangci.yml ./...
Build the docs:
cd docs
npm ci
npm run build
Roadmap to 1.0
- Time based event conditions
- Caching
- Prometheus metrics
- Testing
Contributing
Issues and pull requests are welcome.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Acknowledgments
This project was inspired by darkphnx/ical-filter-proxy. I needed more flexibility with filtering rules and the ability to modify event descriptions... plus I wanted an excuse to finally write something in Go.