Quick Start

1. Create a config file

Colporteur reads its config from ~/.config/colporteur/config.toml:

output_dir = "/var/lib/colporteur/feeds"

[accounts.mxroute]
server = "mail.mxroute.com"
username = "news@domain.com"
password = "your-imap-password" # or "!pass show email/imap" for a password manager

[feeds.ideabrowser]
title = "Ideabrowser Daily"
account = "mxroute"
senders = ["notifications@mail.ideabrowser.com"]

2. Test the connection

colporteur test

testing accounts...
  mxroute      mail.mxroute.com               ok

3. Fetch newsletters

colporteur fetch

fetching feeds...
  ideabrowser          1 new  ->  /var/lib/colporteur/feeds/ideabrowser.xml
done. 1 entries written.

4. Subscribe in your feed reader

Point your feed reader at /var/lib/colporteur/feeds/ideabrowser.xml. Run colporteur fetch periodically (e.g. via cron) to keep it updated.

Next steps

• See Configuration for the full config reference
• See CLI Reference for all commands and flags
• See Examples for common setups