Self-Hosting
Run Raven Docs on your own infrastructure for full control over your data.
Deployment Options
| Option | Best For |
|---|---|
| Docker | Quick setup, small teams |
| Kubernetes | Production, scaling |
Requirements
Minimum
- 2 CPU cores
- 4 GB RAM
- 20 GB storage
- PostgreSQL 15+
- Redis 7+
Recommended (Production)
- 4+ CPU cores
- 8+ GB RAM
- 100 GB SSD storage
- PostgreSQL with replication
- Redis cluster
- Load balancer
Architecture
Quick Start
Docker Compose
# Clone the repo
git clone https://github.com/HaruHunab1320/raven-docs.git
cd raven-docs
# Configure environment
cp .env.example .env
# Edit .env with your settings
# Start services
docker compose up -d
Kubernetes
See the Kubernetes guide for deploying with Helm charts included in the repository.
Environment Variables
| Variable | Required | Description |
|---|---|---|
DATABASE_URL | Yes | PostgreSQL connection string |
REDIS_URL | Yes | Redis connection string |
APP_SECRET | Yes | Secret for encryption |
APP_URL | Yes | Public URL of your instance |
See Configuration for all options.
Upgrading
- Check the Changelog for breaking changes
- Back up your database
- Pull the latest changes
- Run migrations
- Restart services
# Docker
git pull
docker compose pull
docker compose up -d
Support
For community support: