ksmithandClaude Sonnet 5 21c33e8188 Make the reverse proxy a required, pluggable part of every deployment
gunicorn previously only ever bound to a Unix socket, which assumes the
reverse proxy is nginx running on this same host — it can't be reached by
a proxy on a different machine at all (e.g. Nginx Proxy Manager on its own
box), which is this project's actual deployment target. Switch gunicorn to
listening on a plain TCP address instead, controlled by a new
EVECTION_GUNICORN_BIND setting in .env.

install.sh now asks whether the proxy is local or remote and picks a
sensible bind default either way (127.0.0.1:8000 vs 0.0.0.0:8000, with a
reminder to firewall the port in the remote case), and no longer tries to
automate nginx/certbot itself — docs/install.md's new "Reverse proxy"
section covers both shapes instead, since which proxy and where it runs is
the operator's choice, not something this script should assume or set up.
upgrade.sh's health check now curls the TCP bind instead of the old socket
path.

Also add WhiteNoise so gunicorn serves /static/ itself: the old approach
(nginx aliasing the staticfiles directory on disk) silently breaks the
moment the proxy isn't on this host and can't see this filesystem.
nginx.conf.example's own /static/ alias becomes an optional same-host perf
optimization rather than a requirement.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-31 09:01:46 -06: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.

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.

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%