Getting Started

Getting Started with OdinRun

OdinRun is designed for zero-friction setup. You can be up and running in under 60 seconds on any machine with Docker and Node.js installed.

---

📋 Prerequisites

• Docker Engine (or Docker Desktop with Compose v2)
• Node.js 20+ (if running services locally or building from source)
• Git

---

⚡ Option 1: Setup Wizard (Recommended)

Simple Mode launches OdinRun using SQLite and in-memory event queues with no external database dependencies.

# 1. Clone the OdinRun repository
git clone https://github.com/FoldedOdin/OdinRun.git
cd OdinRun

# 2. Copy the default environment template
cp deploy/.env.example deploy/.env

# 3. Start OdinRun
./odinrun start

Once started, open http://localhost:3000 to launch the interactive Setup Wizard. The wizard will guide you through:

1. Setting up administrator access
2. Onboarding your first repository
3. Generating a GitHub PAT or configuring webhooks
4. Running your first test pipeline

---

🏭 Option 2: Advanced Mode (Production)

Advanced Mode deploys a production-scale architecture powered by MongoDB, Redis, and Jaeger Distributed Tracing.

./odinrun advanced

Deployed Ports in Advanced Mode

Service	Port	Description
Frontend UI	3000	Real-time React Dashboard
API Service	3001	REST API, WebSockets, & Webhook Ingress
MongoDB	27017	Persistent Document Database
Redis	6379	Distributed Event & Job Queue
Jaeger UI	16686	Distributed Tracing Dashboard
Jaeger OTLP	4318	OpenTelemetry Collector Port