DocumentationInstallation
Installation
Minimum Requirements
- 4 CPU Cores (8 recommended if running Ollama locally).
- 8 GB RAM (16GB recommended if running Ollama locally).
- Postgres 14+, Redis 7+.
Docker Compose Path
The easiest way to stand up a single VPS is Docker Compose:
- Clone the repository.
- Copy
.env.exampleto.envand fill in secrets. - Run
docker compose build. - Run
docker compose up -d. - Run migrations:
docker compose exec django python manage.py migrate.
Helm + ArgoCD Path
For Kubernetes usage, an ArgoCD App configuration lives in deploy/argocd pointing to the Helm chart in deploy/helm. Configure your values file with the required secrets (or rely on ExternalSecrets).
First-Run Checklist
- Ensure containers are healthy (
docker compose ps). - Run database migrations.
- Create the superuser (see below).
- Run
docker compose exec django python manage.py bootstrap_live_sourcesto seed default RSS/Reddit connections.
Creating the First Superuser
docker compose exec django python manage.py createsuperuserSmoke Test
Log into the dashboard. Go to settings and add an RSS feed. If the Ingestion Settings page shows health check successes within 5 minutes, Celery, Postgres, and the Network are functional.