ksmithandClaude Sonnet 5.5 ac5e951749 Harden the login throttle and cache readiness aggregates (R2-S4, R2-C5; #36, #45)
S4: the throttle keyed on the first X-Forwarded-For entry, which a client
or a proxy that appends can choose, and disabled itself entirely when
Redis was down.

EVECTION_TRUSTED_PROXIES (IPs/CIDRs of your reverse proxy) makes it
strict: X-Forwarded-For is only believed when the TCP peer is a trusted
proxy, and the rightmost entry that isn't itself a trusted proxy — the
address the proxy actually saw — is used instead of the spoofable first
one. Unset keeps the previous behavior so existing installs don't
suddenly share one bucket behind a proxy, and `manage.py check --deploy`
warns (evection.W001) until it's set. During a Redis outage the throttle
now falls back to a bounded in-process limiter instead of switching off.

C5: /health/ready/ reuses its queue/feed aggregates for 15s
(EVECTION_HEALTH_CACHE_SECONDS) so a fast-polling monitor can't create
steady load; the database, Redis and poller probes stay live. Docs
cover both settings, restricting the endpoint at the proxy, and the
tombstone/purge behavior from the previous changes.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-01 12:08:13 -07:00

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.

Updating pinned dependencies

requirements.txt/requirements-dev.txt are hash-pinned lock files generated from pyproject.toml — production installs (scripts/install.sh, scripts/upgrade.sh) install from requirements.txt with --require-hashes rather than re-resolving version ranges at install time. After changing a dependency in pyproject.toml, regenerate both and commit them alongside:

pip-compile --generate-hashes --allow-unsafe --output-file=requirements.txt pyproject.toml
pip-compile --generate-hashes --allow-unsafe --extra=dev --output-file=requirements-dev.txt pyproject.toml

Tests

pytest
ruff check .
black --check .

Testing against PostgreSQL

The suite runs on SQLite by default; the Postgres-only tests (search backend) are skipped there. To run everything against a real Postgres:

docker run -d --name evection-pg-test -e POSTGRES_PASSWORD=testpw -e POSTGRES_DB=evection \
    -p 127.0.0.1:55432:5432 postgres:16
DATABASE_URL=postgres://postgres:testpw@127.0.0.1:55432/evection pytest
docker rm -f evection-pg-test

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.

S
Description
Web RSS Feed Reader
Readme AGPL-3.0
1.4 MiB
0 Stars 0 Watchers 0 Forks
Languages
Python 82.7%
HTML 5.5%
Shell 4.4%
JavaScript 4.2%
CSS 3.2%