Files
Evection/README.md
T
ksmithandClaude Sonnet 5 cb5617edb8 Pin dependencies by hash and refuse to follow a rewritten release tag (S7)
pyproject.toml used broad version ranges with no lock file, so two
deployments of the same release could end up with different dependency
versions, and there was no check that a package actually matches what
was reviewed/tested — a compromised or substituted package on the index
could install silently.

requirements.txt and requirements-dev.txt (generated via `pip-compile
--generate-hashes`, see the new README section on regenerating them)
pin every dependency to an exact version with its hash. install.sh and
upgrade.sh now install from requirements.txt with --require-hashes,
then the app itself with --no-deps — a tampered or substituted package
fails the hash check instead of installing.

Both scripts also no longer `git fetch --tags --force`: a plain fetch
refuses to move a tag ref they already have onto a different commit,
so a rewritten/tampered release tag is reported and stops the
deploy/install instead of being silently followed into production.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-31 15:27:29 -06:00

61 lines
2.0 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.
### 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:
```bash
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
```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.