Docs

EuroRAG documentation: quick start, deployment, and the GDPR compliance guide.

On this page

Welcome to the EuroRAG documentation. This is the public, marketing-site-facing docs hub: a quick orientation and an index of the guides shipped here. The full in-repo documentation (architecture, API reference, customization guide) ships with the product itself.

Quick start

Requirements: Docker and Docker Compose, 4GB RAM minimum (8GB recommended).

# 1. Pick the config that matches your setup (see env-examples/README.md for all options)
cp env-examples/mistral-cloud.env .env    # EU cloud API (recommended)
# or: cp env-examples/local-only.env .env  # fully local (needs GPU)

# 2. Edit .env: set SECRET_KEY and your API key
#    Generate a key: python -c "import secrets; print(secrets.token_urlsafe(32))"

# 3. Start everything
docker compose -f docker-compose.yml up -d

# 4. Only if using local Ollama: pull models
docker compose exec ollama ollama pull mistral
docker compose exec ollama ollama pull nomic-embed-text

Open http://localhost:8000, register an account, upload a document, and start asking questions. That's it.

Developing/customizing? cp docker-compose.override.example.yml docker-compose.override.yml enables hot-reload, see custom/README.md.

Guides