Private
Public Access
Adds an admin-only dashboard (apps/core) surfacing feeds that are failing to fetch, with error messages, subscriber counts, and a one-click retry that resets backoff and re-queues the fetch. Hardens config/settings/prod.py with the remaining standard Django security settings (HSTS preload, nosniff, referrer-policy, frame-options, SameSite cookies) plus a Content-Security-Policy header via django-csp, as a second layer behind nh3's HTML sanitization of feed content. Adds docs/install.md (pip + gunicorn + systemd + nginx, SQLite and Postgres both covered) plus the systemd units and nginx snippet it references, LICENSE (AGPL-3.0-or-later, matching pyproject.toml), and an updated README. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
48 lines
1.4 KiB
Markdown
48 lines
1.4 KiB
Markdown
# 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](docs/install.md) for a production install: pip + gunicorn
|
|
+ systemd + nginx, with both SQLite and PostgreSQL covered.
|
|
|
|
## Development setup
|
|
|
|
```bash
|
|
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
|
|
|
|
```bash
|
|
pytest
|
|
ruff check .
|
|
black --check .
|
|
```
|
|
|
|
## License
|
|
|
|
[GNU AGPL-3.0-or-later](LICENSE) — if you run a modified version of Evection as
|
|
a network service, you must make your modified source available to its users.
|