Skip to content

Colporteur

Newsletter-to-feed converter: reads IMAP mailboxes, strips tracking pixels, and serves Atom XML feeds via HTTP basic auth. Repo: github.com/espadat-studio/colporteur

  • URL: https://feeds.{domain} (basic auth)
  • Port: internal (Caddy static file server)
  • Data: /var/lib/colporteur/feeds/
Terminal window
auberge deploy colporteur

Config lives locally at ~/.config/colporteur/config.toml and is copied to the VPS on deploy. The file must exist before deploying.

output_dir = "/var/lib/colporteur/feeds"
[accounts.mxroute]
server = "mail.mxroute.com"
username = "user@domain.com"
password = "secret"
[feeds.my-newsletter]
title = "My Newsletter"
account = "mxroute"
senders = ["hello@newsletter.com"]

Runs every 15 minutes via systemd timer. Check status:

Terminal window
sudo systemctl status colporteur.timer
sudo journalctl -u colporteur.service --since "1 hour ago"