Skip to main content
This guide walks you through setting up InteraOne for local development. By the end of this guide, you’ll have all InteraOne services running on your machine.

Prerequisites

Before you begin, ensure you have the following installed:

Clone the Repository


Configure Environment Variables

Each application includes an example environment file. Copy every .env.example to .env. Example:
Configure the required API keys and environment variables before starting the services.
See Self Hosting → Environment Variables for a complete reference.

Install Dependencies


Start Infrastructure

Start the required infrastructure services.
This typically starts services such as:
  • MongoDB
  • Redis
  • Qdrant

Start the Applications

If your repository provides a single startup command:
Otherwise, start each application individually according to your development workflow.

Verify the Installation

After all services have started:
  • Gateway is running.
  • Console is accessible.
  • Agent service is connected.
  • Worker is processing jobs.
  • Launcher is available.
  • Database connections are healthy.
You can also verify the running containers:

Project Structure


Next Steps

Continue with:
  • Self Hosting — Deployment and infrastructure.
  • Architecture — Learn how InteraOne services communicate.
  • AI — Understand the agent pipeline.
  • API Reference — Explore the REST API.