Skip to content

Documentation

Raven documentation

Install and configure Raven, choose a deployment method, and explore its commands.

Start with installation, deploy Raven with Docker or from source, and use the WebUI for everyday work. The reference guides cover commands, runtime architecture, and repository structure.

Start here

  • Install Raven

    Install Raven on your platform, configure a model provider, and start using the WebUI.

    Quick Start

  • Self-host Raven

    Deploy Raven on your own machine and configure its services.

    Self-Hosting

  • Open the WebUI

    Open the browser interface and manage the background service.

    Launch WebUI

Choose how to run it

  • Docker Compose

    Build and start the gateway and WebUI together in a container.

    Start with Compose

  • Run from source

    Build and run Raven from a local clone to develop features or try unreleased changes.

    Start from source

See Self-Hosting for both deployment methods, configuration, and Docker image builds.

Explore the documentation

  • Self-Hosting

    Deploy with Docker Compose or from source, and manage configuration.

    Read

  • Docker Deployment

    Understand container services, sign-in, model providers, and data storage.

    Read

  • Launch WebUI

    Open the browser interface and start or stop the background service.

    Read

  • Architecture

    Understand the Assembly Root, runtime layers, and core systems.

    Read

  • Command Reference

    Find Raven commands and learn what each one does.

    Read

  • Repo Layout

    Explore the top-level directories, runtime packages, and commit scopes.

    Read

Raven is developed in the open by EverMind.