OpenCodeHub Documentation

Everything you need to know about OpenCodeHub — from getting started to advanced features

Welcome to OpenCodeHub's comprehensive documentation. Whether you're new to the platform or looking to master advanced features, you'll find everything you need here.

Quick Links

• Getting Started — Install and set up OpenCodeHub
• Features — Stacked PRs, AI review, merge queue, and more
• Tutorials — Hands-on guides
• API Reference — Integrate programmatically
• CLI Reference — Command-line tool

Documentation Sections

Getting Started

New to OpenCodeHub? Start here!

• Installation Guide — Set up OpenCodeHub (Docker or manual)
• Quick Start — Get up and running in 5 minutes
• Create Your First Repository — Push your first code

Core Features

Learn about OpenCodeHub's powerful features:

• Stacked Pull Requests
  Break large changes into reviewable stacks. Ship code faster.

• AI Code Review
  Get instant feedback from GPT-4 or Claude. Catch bugs automatically.

• Smart Merge Queue
  Automate merging with stack-aware CI optimization.

• CI/CD Pipelines
  GitHub Actions-compatible workflows. Build, test, deploy.

• Developer Metrics
  Track velocity, review efficiency, and team performance.

• Slack Integration
  Get actionable notifications in Slack. Review without leaving chat.

Hands-On Tutorials

Step-by-step guides to master OpenCodeHub:

• Your First Stacked PR
  15-minute tutorial: Create your first stack of PRs

• AI-Powered Code Reviews
  Set up and use AI review for your projects

• Automated Deployment
  Build a complete CI/CD pipeline from scratch

Guides

Best practices and workflows:

• Team Workflows — Collaborate effectively
• Branch Protection — Secure your branches
• Webhooks — Integrate with external services
• Storage Adapters — Configure S3, GCS, or local storage
• CircleCI Integration — Use CircleCI as your CI/CD provider
• Run Workers on CircleCI — Background workers via CircleCI

API Reference

Integrate OpenCodeHub into your tools:

• REST API — Complete API reference (140+ endpoints)
• Authentication — API tokens, PATs, OAuth, and SSH
• Webhooks — Event-driven integrations

Administration

For system administrators:

• Deployment Guide — Production deployment
• Deploy on Coolify — Self-hosted PaaS deployment
• Deploy on CyberPanel — OpenLiteSpeed hosting panel
• Deploy on cPanel — Shared hosting deployment
• Deploy on NAS — Synology, TrueNAS, QNAP
• Configuration Reference — All config options
• Security Best Practices — Secure your instance
• Monitoring — Monitor health and performance
• Incident Runbook — Respond to incidents
• Secret Rotation — Rotate credentials safely

Development

Contributing to OpenCodeHub:

• Architecture — System design and components
• Database Schema — Database tables and relationships
• Testing — Running and writing tests
• Contributing — Dev environment setup

Reference & Support

• CLI Commands — Full CLI reference
• Glossary — Project terminology
• Troubleshooting — Fix common issues

Popular Topics

Stacked Pull Requests

The #1 feature that makes OpenCodeHub unique:

main branch
  └── PR #123: Add database schema
       └── PR #124: Add auth service
            └── PR #125: Add login UI

• What are Stacked PRs?
• Create your first stack
• CLI reference

AI Code Review

Catch bugs before they reach production:

• Setup AI review
• Understanding output
• Cost optimization

Merge Queue

Merge automatically, in the right order:

och queue add 123 124 125
# Queue handles everything:
#    - CI runs
#    - Rebasing
#    - Merging in order
#    - Zero manual work

• How it works
• Queue configuration
• Best practices

Installation

Quick Start (Docker)

# 1. Download docker-compose.yml
curl -O https://raw.githubusercontent.com/swadhinbiswas/OpenCodeHub/main/docker-compose.yml

# 2. Configure
cp .env.example .env
# Edit .env with your settings

# 3. Start
docker-compose up -d

# 4. Create admin user
docker-compose exec app bun run scripts/seed-admin.ts

# 5. Open
open http://localhost:4321

Full installation guide

Requirements

• Docker: 20.10+ (recommended)
• OR Node.js: 18+ with Bun or npm
• Database: PostgreSQL 14+ or SQLite
• Storage: Local, S3, Google Cloud Storage, Azure Blob, and more

Learning Paths

For Developers

1. Quick Start — Get familiar with the platform
2. Your First Stack — Learn stacked PRs
3. Team Workflows — Collaborate effectively

For Teams

1. Installation — Set up your instance
2. Team Workflows — Define your process
3. Branch Protection — Secure your code
4. CI/CD Setup — Automate everything

For Administrators

1. Deployment Guide — Production setup
2. Security Best Practices — Secure your instance
3. Monitoring — Track health
4. Configuration — Tune performance

Community & Support

Get Help

• Documentation — You're here!
• GitHub Issues — Bug reports, feature requests
• GitHub Discussions — Community Q&A

Contributing

We welcome contributions!

• Contributing Guide — How to contribute
• Good First Issues — Easy issues for new contributors

Why OpenCodeHub?

License

OpenCodeHub is open source under the MIT License.

View license

Ready to get started?

Install OpenCodeHub | Quick Start | Your First Stack