swadhin / opencodehub public

docs: add Docker Hub description with logo and setup instructions

swadhinbiswas committed 3 months ago
bb98ea3
1 parent dc3b077
commit bb98ea3
2 files changed
+83 -2
Showing 2 changed files+83-2
.github/workflows/docker-publish.ymlDOCKERHUB.md
▼.github/workflows/docker-publish.yml
+2-2
@@ -85,5 +85,5 @@ jobs:
85
85
username: ${{ secrets.DOCKER_USERNAME }}
86
86
password: ${{ secrets.DOCKER_TOKEN }}
87
87
repository: ${{ env.IMAGE_NAME }}
88
- readme-filepath: ./README.md
89
- short-description: "A modern, self-hosted Git platform with stacked PRs, merge queue, CI/CD, and AI review."
88
+ readme-filepath: ./DOCKERHUB.md
89
+ short-description: "Self-hosted Git platform with stacked PRs, merge queue, CI/CD, and AI code review"
90
90
▼DOCKERHUB.md
+81-0
@@ -0,0 +1,81 @@
1
+# OpenCodeHub
2
+
3
+![OpenCodeHub](https://raw.githubusercontent.com/swadhinbiswas/OpencodeHub/main/public/logo-light.png)
4
+
5
+**The self-hosted Git platform that doesn't compromise.**
6
+
7
+OpenCodeHub is a self-hosted Git platform with stacked PRs, merge queue, CI/CD pipelines, and AI code review. One platform for everything your team needs — no vendor lock-in, no per-seat pricing.
8
+
9
+---
10
+
11
+## Features
12
+
13
+- **Stacked PRs** — Graphite-style stacked branches for incremental review
14
+- **Merge Queue** — Stack-aware merge ordering with speculative CI builds
15
+- **CI/CD Pipelines** — GitHub Actions-compatible workflows with Docker runners
16
+- **AI Code Review** — 10+ providers: GPT-4, Claude, Gemini, Groq, Ollama
17
+- **Git Hosting** — HTTP smart protocol + SSH push/pull, forks, mirroring, LFS
18
+- **Issues & Projects** — Labels, milestones, custom fields, kanban boards
19
+- **175+ API Endpoints** — REST + GraphQL for full programmatic access
20
+- **CLI** — `och` command line tool for stack workflows and repository management
21
+
22
+---
23
+
24
+## Quick Start
25
+
26
+```bash
27
+# Pull and run
28
+docker run -d \
29
+ --name opencodehub \
30
+ -p 4321:4321 \
31
+ -v opencodehub-data:/data \
32
+ -e JWT_SECRET=$(openssl rand -hex 32) \
33
+ -e SESSION_SECRET=$(openssl rand -hex 32) \
34
+ -e DATABASE_URL=postgresql://user:pass@db:5432/opencodehub \
35
+ opencodehub/opencodehub:latest
36
+```
37
+
38
+Or with Docker Compose:
39
+
40
+```bash
41
+git clone https://github.com/swadhinbiswas/OpencodeHub.git
42
+cd OpenCodeHub
43
+cp .env.example .env
44
+docker compose up -d
45
+docker compose exec app bun run scripts/seed-admin.ts
46
+```
47
+
48
+Open **http://localhost:4321** and create your admin account.
49
+
50
+---
51
+
52
+## Environment Variables
53
+
54
+| Variable | Required | Description |
55
+|----------|----------|-------------|
56
+| `DATABASE_URL` | Yes | PostgreSQL connection string |
57
+| `JWT_SECRET` | Yes | Random 32+ char string for JWT signing |
58
+| `SESSION_SECRET` | Yes | Random 32+ char string for session encryption |
59
+| `REDIS_URL` | Yes | Redis connection string |
60
+| `SITE_URL` | Yes | Your public URL (e.g., `https://git.example.com`) |
61
+| `STORAGE_TYPE` | No | `local` (default) or `s3` |
62
+
63
+---
64
+
65
+## Documentation
66
+
67
+Full documentation: **[docs.opencodehub.space](https://docs.opencodehub.space)**
68
+
69
+- [Installation Guide](https://docs.opencodehub.space/getting-started/installation/)
70
+- [Configuration Reference](https://docs.opencodehub.space/administration/configuration/)
71
+- [Deployment Options](https://docs.opencodehub.space/administration/deployment/)
72
+- [CLI Reference](https://docs.opencodehub.space/reference/cli-commands/)
73
+- [API Reference](https://docs.opencodehub.space/api/rest-api/)
74
+
75
+---
76
+
77
+## Links
78
+
79
+- **GitHub**: [github.com/swadhinbiswas/OpencodeHub](https://github.com/swadhinbiswas/OpencodeHub)
80
+- **Documentation**: [docs.opencodehub.space](https://docs.opencodehub.space)
81
+- **License**: MIT
0
82