notefeed¶

notefeed is a small inbox for short markdown notes. You post notes from scripts over HTTP, or by hand in a web UI, and read them back as an RSS feed. Each note is a plain .md file on disk.

It exists because dashboards like Glance and Dynacat can read RSS but have nowhere to post to. A backup job, a deploy script or a cron check can drop a note into notefeed, and it shows up on the dashboard a few minutes later.

The notefeed web UI: a compose box above notes grouped by day

Hosted or self-hosted¶

A hosted instance runs at notefeed.me. To run your own, follow the Quick start.

Where to go next¶

Quick start: run notefeed with Docker Compose.
Posting notes: the API, accepted formats, errors and script examples.
Web UI: writing notes by hand.
The feed: hooking notefeed up to Glance, Dynacat and other readers.
Configuration: every setting.
Reverse proxy: putting notefeed on the internet behind Caddy.
Operations: upgrades, backups and deleting notes.