Quick Start

Get your self-hosted CI/CD server running in minutes.

Prerequisites

• macOS 10.15+ or Linux with systemd
• Rust toolchain (for building from source)
• Root access (for service installation)

Installation

1. Clone and build

   git clone https://github.com/devaryakjha/oore.build.git
   cd oore.build
   cargo build --release

2. Create configuration

   cp .env.example .env
   nano .env

   Minimal configuration:

   .env

   DATABASE_URL=sqlite:oore.db
   BASE_URL=https://your-mac.example.com
   OORE_ADMIN_TOKEN=your-secure-random-token
   ENCRYPTION_KEY=$(openssl rand -hex 32)

3. Install and start

   Production

   sudo ./target/release/oored install --env-file .env
   sudo oored start
   oored status

   Development

   # Terminal 1: Run server
   cargo run -p oore-server
   
   # Terminal 2: Use CLI
   cargo run -p oore-cli -- health

4. Verify installation

   curl http://localhost:8080/api/health
   # {"status":"ok"}

Add Your First Repository

1. Add repository

   oore repo add --provider github --owner myorg --repo my-flutter-app

2. Get webhook URL

   oore repo webhook-url <repo-id>

3. Configure webhook in GitHub/GitLab

   GitHub
   1. Go to your GitHub App settings (or repository Settings → Webhooks)
   2. Set the Webhook URL from step 2
   3. Set Content type to application/json
   4. Add your webhook secret
   GitLab
   1. Go to Settings → Webhooks in your GitLab project
   2. Add the webhook URL from step 2
   3. Enter your Secret Token
   4. Select triggers: Push events, Merge request events

4. Trigger a build

   # Push code or trigger manually
   oore build trigger <repo-id>
   oore build list --repo <repo-id>

What’s Next?

• Configuration Reference — All environment variables
• Service Management — Managing the oored service
• GitHub Integration — Full GitHub App setup
• CLI Reference — Complete command reference