v2026.10.31
install.sh and upgrade.sh deploy git tags, not branch tips, but the docs still described git pull/clone-and-run. Add a "Releases" section explaining the v<year>.<month>.<day> tagging convention and that a tag must exist before the first production install, update the manual upgrade steps to match what upgrade.sh actually does (fetch tags, checkout latest), and mention the /health/ endpoint upgrade.sh verifies against. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Evection
A self-hosted RSS/Atom feed reader, in the spirit of FreshRSS, built in Python (Django) instead of PHP. Installable as a PWA on your phone, with offline reading for anything you've already loaded.
Features
- Multi-user, with per-user folders, read/starred/saved-for-later state, and tags
- Background feed polling via Celery, with conditional GET and backoff on errors
- Full-text search over your articles (SQLite FTS5 or PostgreSQL, your choice)
- A filter/rules engine to auto-tag, star, hide, or mark feeds' articles read
- OPML import/export
- Installable as a PWA (Add to Home Screen) with an offline fallback page
- An admin dashboard surfacing feeds that are failing to fetch
Deploying your own instance
See docs/install.md for a production install: pip + gunicorn
- systemd + nginx, with both SQLite and PostgreSQL covered.
Development setup
python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
cp .env.example .env
python manage.py migrate
python manage.py runserver
Visit http://localhost:8000/ — you'll land on the first-run setup wizard to
create the instance's admin account.
Tests
pytest
ruff check .
black --check .
License
GNU AGPL-3.0-or-later — if you run a modified version of Evection as a network service, you must make your modified source available to its users.
Languages
Python
82.7%
HTML
5.5%
Shell
4.4%
JavaScript
4.2%
CSS
3.2%