From c672fa7871f92ea8af3dcf790335e00cddaeff65 Mon Sep 17 00:00:00 2001 From: xintaofei Date: Sun, 29 Mar 2026 19:58:33 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0README=E4=BF=A1=E6=81=AF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 26 ++++++++++++++++---------- docs/readme/README.ar.md | 22 ++++++++++++++-------- docs/readme/README.de.md | 23 +++++++++++++++-------- docs/readme/README.es.md | 23 +++++++++++++++-------- docs/readme/README.fr.md | 23 +++++++++++++++-------- docs/readme/README.ja.md | 22 ++++++++++++++-------- docs/readme/README.ko.md | 22 ++++++++++++++-------- docs/readme/README.pt.md | 23 +++++++++++++++-------- docs/readme/README.zh-CN.md | 22 ++++++++++++++-------- docs/readme/README.zh-TW.md | 22 ++++++++++++++-------- 10 files changed, 146 insertions(+), 82 deletions(-) diff --git a/README.md b/README.md index 77d6d57..da302b7 100644 --- a/README.md +++ b/README.md @@ -21,18 +21,14 @@ Codeg (Code Generation) is an enterprise-grade multi-agent coding workspace. It unifies local AI coding agents (Claude Code, Codex CLI, OpenCode, Gemini CLI, -OpenClaw, Cline, etc.) in a desktop app and web service — enabling remote development from -any browser — with session aggregation, parallel `git worktree` development, -MCP/Skills management, and integrated Git/file/terminal workflows. +OpenClaw, Cline, etc.) in a desktop app, standalone server, or Docker container — enabling +remote development from any browser — with session aggregation, parallel `git worktree` +development, MCP/Skills management, and integrated Git/file/terminal workflows. ## Main Interface ![Codeg Light](./docs/images/main-light.png#gh-light-mode-only) ![Codeg Dark](./docs/images/main-dark.png#gh-dark-mode-only) -## Session tile display -![Codeg Light](./docs/images/main2-light.png#gh-light-mode-only) -![Codeg Dark](./docs/images/main2-dark.png#gh-dark-mode-only) - ## Settings | Agents | MCP | Skills | Version Control | Web Service | | :---: | :---: | :---: | :---: | :---: | @@ -49,7 +45,7 @@ MCP/Skills management, and integrated Git/file/terminal workflows. - Git remote account management (GitHub and other Git servers) - Web service mode — access Codeg from any browser for remote work - **Standalone server deployment** — run `codeg-server` on any Linux/macOS server, access via browser -- **Docker support** — deploy with `docker compose up` for zero-config server setup +- **Docker support** — multi-stage build image with `docker compose up` or `docker run`, supports custom token, port, volume mounts for data persistence and project directories - Integrated engineering loop (file tree, diff, git changes, commit, terminal) ## Project Boot @@ -209,12 +205,22 @@ CODEG_STATIC_DIR=./web ./codeg-server #### Option 4: Docker ```bash +# Using Docker Compose (recommended) docker compose up -d -# Or run directly -docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest +# Or run directly with Docker +docker run -d -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest + +# With custom token and project directory mounted +docker run -d -p 3080:3080 \ + -v codeg-data:/data \ + -v /path/to/projects:/projects \ + -e CODEG_TOKEN=your-secret-token \ + ghcr.io/xintaofei/codeg:latest ``` +The Docker image uses a multi-stage build (Node.js + Rust → slim Debian runtime) and includes `git` and `ssh` for repository operations. Data is persisted in the `/data` volume. You can optionally mount project directories to access local repos from within the container. + #### Option 5: Build from source ```bash diff --git a/docs/readme/README.ar.md b/docs/readme/README.ar.md index 0dd3d02..8437f2a 100644 --- a/docs/readme/README.ar.md +++ b/docs/readme/README.ar.md @@ -21,17 +21,13 @@ Codeg (Code Generation) هو مساحة عمل مؤسسية متعددة الوكلاء للبرمجة. يوحّد وكلاء البرمجة المحليين بالذكاء الاصطناعي (Claude Code، Codex CLI، OpenCode، Gemini CLI، -OpenClaw، وغيرها) في تطبيق سطح مكتب وخدمة ويب — مما يتيح التطوير عن بُعد من أي متصفح — مع تجميع الجلسات، والتطوير المتوازي +OpenClaw، وغيرها) في تطبيق سطح مكتب أو خادم مستقل أو حاوية Docker — مما يتيح التطوير عن بُعد من أي متصفح — مع تجميع الجلسات، والتطوير المتوازي عبر `git worktree`، وإدارة MCP/Skills، وسير عمل متكامل لـ Git/الملفات/الطرفية. ## الواجهة الرئيسية ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) -## عرض الجلسات كبلاطات -![Codeg Light](../images/main2-light.png#gh-light-mode-only) -![Codeg Dark](../images/main2-dark.png#gh-dark-mode-only) - ## الإعدادات | الوكلاء | MCP | Skills | التحكم في الإصدارات | خدمة الويب | | :---: | :---: | :---: | :---: | :---: | @@ -48,7 +44,7 @@ OpenClaw، وغيرها) في تطبيق سطح مكتب وخدمة ويب — - إدارة حسابات Git البعيدة (GitHub وخوادم Git الأخرى) - وضع خدمة الويب — الوصول إلى Codeg من أي متصفح للعمل عن بُعد - **نشر خادم مستقل** — شغّل `codeg-server` على أي خادم Linux/macOS، والوصول عبر المتصفح -- **دعم Docker** — انشر باستخدام `docker compose up` لإعداد الخادم بدون تكوين +- **دعم Docker** — صورة بناء متعددة المراحل، تدعم `docker compose up` أو `docker run`، مع رمز مصادقة ومنفذ قابلين للتخصيص، واستمرارية البيانات وتحميل مجلدات المشاريع - حلقة هندسية متكاملة (شجرة الملفات، الفروقات، تغييرات git، الإيداع، الطرفية) ## مُنشئ المشروع @@ -208,12 +204,22 @@ CODEG_STATIC_DIR=./web ./codeg-server #### الخيار 4: Docker ```bash +# باستخدام Docker Compose (مُوصى به) docker compose up -d -# أو التشغيل مباشرة -docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest +# أو التشغيل مباشرة باستخدام Docker +docker run -d -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest + +# مع رمز مصادقة مخصص وتحميل مجلد المشروع +docker run -d -p 3080:3080 \ + -v codeg-data:/data \ + -v /path/to/projects:/projects \ + -e CODEG_TOKEN=your-secret-token \ + ghcr.io/xintaofei/codeg:latest ``` +تستخدم صورة Docker بناءً متعدد المراحل (Node.js + Rust → بيئة تشغيل Debian خفيفة) وتتضمن `git` و`ssh` لعمليات المستودعات. يتم تخزين البيانات بشكل دائم في وحدة التخزين `/data`. يمكنك اختياريًا تحميل مجلدات المشاريع للوصول إلى المستودعات المحلية من داخل الحاوية. + #### الخيار 5: البناء من المصدر ```bash diff --git a/docs/readme/README.de.md b/docs/readme/README.de.md index 0fc5218..e54ffaf 100644 --- a/docs/readme/README.de.md +++ b/docs/readme/README.de.md @@ -22,7 +22,8 @@ Codeg (Code Generation) ist ein unternehmenstauglicher Multi-Agent-Workspace für die Programmierung. Es vereint lokale KI-Coding-Agenten (Claude Code, Codex CLI, OpenCode, -Gemini CLI, OpenClaw usw.) in einer Desktop-App und einem Webservice — Remote-Entwicklung von jedem Browser aus — mit Sitzungsaggregation, +Gemini CLI, OpenClaw usw.) in einer Desktop-App, einem Standalone-Server oder +Docker-Container — Remote-Entwicklung von jedem Browser aus — mit Sitzungsaggregation, paralleler `git worktree`-Entwicklung, MCP/Skills-Verwaltung und integrierten Git/Datei/Terminal-Workflows. @@ -30,10 +31,6 @@ Git/Datei/Terminal-Workflows. ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) -## Sitzungskachelansicht -![Codeg Light](../images/main2-light.png#gh-light-mode-only) -![Codeg Dark](../images/main2-dark.png#gh-dark-mode-only) - ## Einstellungen | Agenten | MCP | Skills | Versionskontrolle | Webdienst | | :---: | :---: | :---: | :---: | :---: | @@ -50,7 +47,7 @@ Git/Datei/Terminal-Workflows. - Git-Remote-Kontoverwaltung (GitHub und andere Git-Server) - Webdienst-Modus — Zugriff auf Codeg über jeden Browser für Remote-Arbeit - Standalone-Server-Bereitstellung — codeg-server auf jedem Linux/macOS-Server ausführen, Zugriff über den Browser -- Docker-Unterstützung — Bereitstellung mit docker compose up für konfigurationsfreien Serverbetrieb +- **Docker-Unterstützung** — Multi-Stage-Build-Image, unterstützt `docker compose up` oder `docker run`, benutzerdefinierter Token/Port, Datenpersistenz und Projektverzeichnis-Mounts - Integrierter Engineering-Kreislauf (Dateibaum, Diff, Git-Änderungen, Commit, Terminal) ## Projekt-Starter @@ -210,12 +207,22 @@ CODEG_STATIC_DIR=./web ./codeg-server #### Option 4: Docker ```bash +# Mit Docker Compose (empfohlen) docker compose up -d -# Oder direkt ausführen -docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest +# Oder direkt mit Docker ausführen +docker run -d -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest + +# Mit benutzerdefiniertem Token und Projektverzeichnis-Mount +docker run -d -p 3080:3080 \ + -v codeg-data:/data \ + -v /path/to/projects:/projects \ + -e CODEG_TOKEN=your-secret-token \ + ghcr.io/xintaofei/codeg:latest ``` +Das Docker-Image verwendet einen Multi-Stage-Build (Node.js + Rust → schlanke Debian-Laufzeitumgebung) und enthält `git` und `ssh` für Repository-Operationen. Daten werden im `/data`-Volume persistent gespeichert. Optional können Projektverzeichnisse gemountet werden, um aus dem Container auf lokale Repositories zuzugreifen. + #### Option 5: Aus Quellcode kompilieren ```bash diff --git a/docs/readme/README.es.md b/docs/readme/README.es.md index faecb2f..b659646 100644 --- a/docs/readme/README.es.md +++ b/docs/readme/README.es.md @@ -22,7 +22,8 @@ Codeg (Code Generation) es un espacio de trabajo empresarial para codificación con múltiples agentes. Integra agentes locales de codificación con IA (Claude Code, Codex CLI, OpenCode, -Gemini CLI, OpenClaw, Cline, etc.) en una aplicación de escritorio y un servicio web — permitiendo el desarrollo remoto desde cualquier navegador — con agregación +Gemini CLI, OpenClaw, Cline, etc.) en una aplicación de escritorio, servidor independiente +o contenedor Docker — permitiendo el desarrollo remoto desde cualquier navegador — con agregación de sesiones, desarrollo paralelo con `git worktree`, gestión de MCP/Skills y flujos integrados de Git/archivos/terminal. @@ -30,10 +31,6 @@ flujos integrados de Git/archivos/terminal. ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) -## Vista de mosaico de sesiones -![Codeg Light](../images/main2-light.png#gh-light-mode-only) -![Codeg Dark](../images/main2-dark.png#gh-dark-mode-only) - ## Configuración | Agentes | MCP | Skills | Control de versiones | Servicio web | | :---: | :---: | :---: | :---: | :---: | @@ -50,7 +47,7 @@ flujos integrados de Git/archivos/terminal. - Gestión de cuentas remotas de Git (GitHub y otros servidores Git) - Modo de servicio web — accede a Codeg desde cualquier navegador para trabajo remoto - Despliegue como servidor independiente — ejecuta codeg-server en cualquier servidor Linux/macOS, accede desde el navegador -- Soporte de Docker — despliega con docker compose up para una configuración sin esfuerzo +- **Soporte Docker** — imagen con compilación multi-etapa, compatible con `docker compose up` o `docker run`, token/puerto personalizables, persistencia de datos y montaje de directorios de proyecto - Ciclo de ingeniería integrado (árbol de archivos, diff, cambios git, commit, terminal) ## Inicio de Proyecto @@ -210,12 +207,22 @@ CODEG_STATIC_DIR=./web ./codeg-server #### Opción 4: Docker ```bash +# Usando Docker Compose (recomendado) docker compose up -d -# O ejecutar directamente -docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest +# O ejecutar directamente con Docker +docker run -d -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest + +# Con token personalizado y directorio de proyecto montado +docker run -d -p 3080:3080 \ + -v codeg-data:/data \ + -v /path/to/projects:/projects \ + -e CODEG_TOKEN=your-secret-token \ + ghcr.io/xintaofei/codeg:latest ``` +La imagen Docker utiliza una compilación multi-etapa (Node.js + Rust → runtime Debian slim) e incluye `git` y `ssh` para operaciones con repositorios. Los datos se persisten en el volumen `/data`. Opcionalmente, puedes montar directorios de proyecto para acceder a repositorios locales desde el contenedor. + #### Opción 5: Compilar desde el código fuente ```bash diff --git a/docs/readme/README.fr.md b/docs/readme/README.fr.md index 7cc13ef..40b3c87 100644 --- a/docs/readme/README.fr.md +++ b/docs/readme/README.fr.md @@ -21,17 +21,14 @@ Codeg (Code Generation) est un workspace de codage multi-agents de niveau entreprise. Il unifie les agents de codage IA locaux (Claude Code, Codex CLI, OpenCode, Gemini CLI, -OpenClaw, Cline, etc.) dans une application de bureau et un service web — permettant le développement à distance depuis n'importe quel navigateur — avec agrégation de sessions, développement +OpenClaw, Cline, etc.) dans une application de bureau, un serveur autonome ou un conteneur +Docker — permettant le développement à distance depuis n'importe quel navigateur — avec agrégation de sessions, développement parallèle via `git worktree`, gestion MCP/Skills et workflows intégrés Git/fichiers/terminal. ## Interface principale ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) -## Affichage en tuiles des sessions -![Codeg Light](../images/main2-light.png#gh-light-mode-only) -![Codeg Dark](../images/main2-dark.png#gh-dark-mode-only) - ## Paramètres | Agents | MCP | Skills | Contrôle de version | Service web | | :---: | :---: | :---: | :---: | :---: | @@ -48,7 +45,7 @@ parallèle via `git worktree`, gestion MCP/Skills et workflows intégrés Git/fi - Gestion des comptes distants Git (GitHub et autres serveurs Git) - Mode service web — accédez à Codeg depuis n'importe quel navigateur pour le travail à distance - Déploiement en serveur autonome — exécutez codeg-server sur n'importe quel serveur Linux/macOS, accédez via le navigateur -- Support Docker — déployez avec docker compose up pour une configuration serveur sans effort +- **Support Docker** — image multi-stage build, compatible `docker compose up` ou `docker run`, token/port personnalisables, persistance des données et montage de répertoires de projets - Boucle d'ingénierie intégrée (arborescence de fichiers, diff, changements git, commit, terminal) ## Lanceur de projet @@ -208,12 +205,22 @@ CODEG_STATIC_DIR=./web ./codeg-server #### Option 4 : Docker ```bash +# Avec Docker Compose (recommandé) docker compose up -d -# Ou exécuter directement -docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest +# Ou exécuter directement avec Docker +docker run -d -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest + +# Avec token personnalisé et répertoire de projet monté +docker run -d -p 3080:3080 \ + -v codeg-data:/data \ + -v /path/to/projects:/projects \ + -e CODEG_TOKEN=your-secret-token \ + ghcr.io/xintaofei/codeg:latest ``` +L'image Docker utilise un build multi-stage (Node.js + Rust → runtime Debian allégé) et inclut `git` et `ssh` pour les opérations sur les dépôts. Les données sont persistées dans le volume `/data`. Vous pouvez optionnellement monter des répertoires de projets pour accéder aux dépôts locaux depuis le conteneur. + #### Option 5 : Compiler depuis les sources ```bash diff --git a/docs/readme/README.ja.md b/docs/readme/README.ja.md index cf29d10..30be4f6 100644 --- a/docs/readme/README.ja.md +++ b/docs/readme/README.ja.md @@ -21,17 +21,13 @@ Codeg（Code Generation）は、エンタープライズ級のマルチ Agent コーディングワークスペースです。 Claude Code、Codex CLI、OpenCode、Gemini CLI、OpenClaw などのローカル AI コーディング Agent を -デスクトップアプリと Web サービスに統合し——ブラウザからどこでもリモート開発が可能——セッション集約、並列 `git worktree` 開発、MCP/Skills 管理、 +デスクトップアプリ、スタンドアロンサーバー、または Docker コンテナに統合し——ブラウザからどこでもリモート開発が可能——セッション集約、並列 `git worktree` 開発、MCP/Skills 管理、 Git/ファイル/ターミナル連携ワークフローを提供します。 ## メインインターフェース ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) -## セッションタイル表示 -![Codeg Light](../images/main2-light.png#gh-light-mode-only) -![Codeg Dark](../images/main2-dark.png#gh-dark-mode-only) - ## 設定 | エージェント | MCP | Skills | バージョン管理 | Web サービス | | :---: | :---: | :---: | :---: | :---: | @@ -48,7 +44,7 @@ Git/ファイル/ターミナル連携ワークフローを提供します。 - Git リモートアカウント管理（GitHub およびその他の Git サーバー） - Web サービスモード — ブラウザから Codeg にアクセスでき、リモートワークに対応 - **スタンドアロンサーバーデプロイ** — 任意の Linux/macOS サーバーで `codeg-server` を実行し、ブラウザからアクセス -- **Docker サポート** — `docker compose up` でゼロ設定のサーバーセットアップが可能 +- **Docker サポート** — マルチステージビルドイメージ、`docker compose up` または `docker run` に対応、カスタムトークン・ポート設定、データ永続化およびプロジェクトディレクトリのマウントをサポート - 統合エンジニアリングループ（ファイルツリー、Diff、Git 変更、コミット、ターミナル） ## プロジェクトブート @@ -208,12 +204,22 @@ CODEG_STATIC_DIR=./web ./codeg-server #### オプション 4: Docker ```bash +# Docker Compose を使用（推奨） docker compose up -d -# または直接実行 -docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest +# または Docker で直接実行 +docker run -d -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest + +# カスタムトークンとプロジェクトディレクトリのマウント +docker run -d -p 3080:3080 \ + -v codeg-data:/data \ + -v /path/to/projects:/projects \ + -e CODEG_TOKEN=your-secret-token \ + ghcr.io/xintaofei/codeg:latest ``` +Docker イメージはマルチステージビルド（Node.js + Rust → 軽量 Debian ランタイム）を使用し、リポジトリ操作用の `git` と `ssh` を含みます。データは `/data` ボリュームに永続化されます。オプションでプロジェクトディレクトリをマウントして、コンテナ内からローカルリポジトリにアクセスできます。 + #### オプション 5: ソースからビルド ```bash diff --git a/docs/readme/README.ko.md b/docs/readme/README.ko.md index 4b1c5ac..b6ccb81 100644 --- a/docs/readme/README.ko.md +++ b/docs/readme/README.ko.md @@ -21,17 +21,13 @@ Codeg(Code Generation)는 엔터프라이즈급 멀티 Agent 코딩 워크스페이스입니다. Claude Code, Codex CLI, OpenCode, Gemini CLI, OpenClaw 등 로컬 AI 코딩 Agent를 -데스크톱 앱과 웹 서비스로 통합하여 — 브라우저만으로 어디서든 원격 개발이 가능하며 — 세션 집계, 병렬 `git worktree` 개발, MCP/Skills 관리, +데스크톱 앱, 독립형 서버 또는 Docker 컨테이너로 통합하여 — 브라우저만으로 어디서든 원격 개발이 가능하며 — 세션 집계, 병렬 `git worktree` 개발, MCP/Skills 관리, Git/파일/터미널 통합 워크플로를 제공합니다. ## 메인 인터페이스 ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) -## 세션 타일 표시 -![Codeg Light](../images/main2-light.png#gh-light-mode-only) -![Codeg Dark](../images/main2-dark.png#gh-dark-mode-only) - ## 설정 | 에이전트 | MCP | Skills | 버전 관리 | 웹 서비스 | | :---: | :---: | :---: | :---: | :---: | @@ -48,7 +44,7 @@ Git/파일/터미널 통합 워크플로를 제공합니다. - Git 원격 계정 관리 (GitHub 및 기타 Git 서버) - Web 서비스 모드 — 브라우저에서 Codeg에 접속하여 원격 작업 가능 - **독립형 서버 배포** — 모든 Linux/macOS 서버에서 `codeg-server`를 실행하고 브라우저로 접속 -- **Docker 지원** — `docker compose up`으로 설정 없이 서버 구축 가능 +- **Docker 지원** — 멀티 스테이지 빌드 이미지, `docker compose up` 또는 `docker run` 지원, 사용자 정의 토큰/포트, 데이터 영속화 및 프로젝트 디렉토리 마운트 지원 - 통합 엔지니어링 루프 (파일 트리, Diff, Git 변경사항, 커밋, 터미널) ## 프로젝트 부트 @@ -208,12 +204,22 @@ CODEG_STATIC_DIR=./web ./codeg-server #### 옵션 4: Docker ```bash +# Docker Compose 사용 (권장) docker compose up -d -# 또는 직접 실행 -docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest +# 또는 Docker로 직접 실행 +docker run -d -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest + +# 사용자 정의 토큰 및 프로젝트 디렉토리 마운트 +docker run -d -p 3080:3080 \ + -v codeg-data:/data \ + -v /path/to/projects:/projects \ + -e CODEG_TOKEN=your-secret-token \ + ghcr.io/xintaofei/codeg:latest ``` +Docker 이미지는 멀티 스테이지 빌드(Node.js + Rust → 경량 Debian 런타임)를 사용하며, 저장소 작업을 위한 `git`과 `ssh`가 포함되어 있습니다. 데이터는 `/data` 볼륨에 영속적으로 저장됩니다. 선택적으로 프로젝트 디렉토리를 마운트하여 컨테이너 내에서 로컬 저장소에 접근할 수 있습니다. + #### 옵션 5: 소스에서 빌드 ```bash diff --git a/docs/readme/README.pt.md b/docs/readme/README.pt.md index 2831ba1..47b6c57 100644 --- a/docs/readme/README.pt.md +++ b/docs/readme/README.pt.md @@ -21,17 +21,14 @@ Codeg (Code Generation) é um workspace de codificação multi-agentes de nível empresarial. Ele unifica agentes de codificação IA locais (Claude Code, Codex CLI, OpenCode, Gemini CLI, -OpenClaw, Cline, etc.) em um aplicativo desktop e um serviço web — possibilitando o desenvolvimento remoto a partir de qualquer navegador — com agregação de sessões, desenvolvimento +OpenClaw, Cline, etc.) em um aplicativo desktop, servidor standalone ou contêiner +Docker — possibilitando o desenvolvimento remoto a partir de qualquer navegador — com agregação de sessões, desenvolvimento paralelo via `git worktree`, gerenciamento de MCP/Skills e fluxos integrados de Git/arquivos/terminal. ## Interface principal ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) -## Exibição em mosaico das sessões -![Codeg Light](../images/main2-light.png#gh-light-mode-only) -![Codeg Dark](../images/main2-dark.png#gh-dark-mode-only) - ## Configurações | Agentes | MCP | Skills | Controle de versão | Serviço web | | :---: | :---: | :---: | :---: | :---: | @@ -48,7 +45,7 @@ paralelo via `git worktree`, gerenciamento de MCP/Skills e fluxos integrados de - Gerenciamento de contas remotas Git (GitHub e outros servidores Git) - Modo de serviço web — acesse o Codeg de qualquer navegador para trabalho remoto - **Implantação de servidor standalone** — execute `codeg-server` em qualquer servidor Linux/macOS, acesse via navegador -- **Suporte a Docker** — implante com `docker compose up` para configuração zero do servidor +- **Suporte a Docker** — imagem com build multi-stage, compatível com `docker compose up` ou `docker run`, token/porta personalizáveis, persistência de dados e montagem de diretórios de projetos - Ciclo de engenharia integrado (árvore de arquivos, diff, alterações git, commit, terminal) ## Inicializador de Projeto @@ -208,12 +205,22 @@ CODEG_STATIC_DIR=./web ./codeg-server #### Opção 4: Docker ```bash +# Usando Docker Compose (recomendado) docker compose up -d -# Ou executar diretamente -docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest +# Ou executar diretamente com Docker +docker run -d -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest + +# Com token personalizado e diretório de projeto montado +docker run -d -p 3080:3080 \ + -v codeg-data:/data \ + -v /path/to/projects:/projects \ + -e CODEG_TOKEN=your-secret-token \ + ghcr.io/xintaofei/codeg:latest ``` +A imagem Docker usa um build multi-stage (Node.js + Rust → runtime Debian slim) e inclui `git` e `ssh` para operações com repositórios. Os dados são persistidos no volume `/data`. Opcionalmente, você pode montar diretórios de projetos para acessar repositórios locais de dentro do contêiner. + #### Opção 5: Compilar a partir do código-fonte ```bash diff --git a/docs/readme/README.zh-CN.md b/docs/readme/README.zh-CN.md index 089630d..8cbbe4e 100644 --- a/docs/readme/README.zh-CN.md +++ b/docs/readme/README.zh-CN.md @@ -21,17 +21,13 @@ Codeg（Code Generation）是一个企业级多 Agent 编码工作台。 它将本地 AI 编码代理（Claude Code、Codex CLI、OpenCode、Gemini CLI、 -OpenClaw、Cline 等）统一到桌面应用与 Web 服务中——通过浏览器即可远程开发——支持会话聚合、 +OpenClaw、Cline 等）统一到桌面应用、独立服务器或 Docker 容器中——通过浏览器即可远程开发——支持会话聚合、 并行 `git worktree` 开发、MCP/Skills 管理，以及集成的 Git/文件/终端工作流。 ## 主界面 ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) -## 会话平铺显示 -![Codeg Light](../images/main2-light.png#gh-light-mode-only) -![Codeg Dark](../images/main2-dark.png#gh-dark-mode-only) - ## 设置 | 代理 | MCP | Skills | 版本控制 | Web 服务 | | :---: | :---: | :---: | :---: | :---: | @@ -48,7 +44,7 @@ OpenClaw、Cline 等）统一到桌面应用与 Web 服务中——通过浏览 - Git 远程账号管理（支持 GitHub 及其它 Git 服务器） - Web 服务模式 — 开启后可在浏览器中访问 Codeg，支持远程工作 - **独立服务器部署** — 在任意 Linux/macOS 服务器上运行 `codeg-server`，通过浏览器访问 -- **Docker 支持** — 使用 `docker compose up` 部署，零配置启动服务 +- **Docker 支持** — 多阶段构建镜像，支持 `docker compose up` 或 `docker run`，可自定义令牌、端口，支持数据持久化及项目目录挂载 - 集成工程闭环（文件树、Diff、Git 变更、提交、终端） ## 项目启动器 @@ -208,12 +204,22 @@ CODEG_STATIC_DIR=./web ./codeg-server #### 方式四：Docker ```bash +# 使用 Docker Compose（推荐） docker compose up -d -# 或直接运行 -docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest +# 或直接使用 Docker 运行 +docker run -d -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest + +# 自定义令牌并挂载项目目录 +docker run -d -p 3080:3080 \ + -v codeg-data:/data \ + -v /path/to/projects:/projects \ + -e CODEG_TOKEN=your-secret-token \ + ghcr.io/xintaofei/codeg:latest ``` +Docker 镜像采用多阶段构建（Node.js + Rust → 精简 Debian 运行时），内置 `git` 和 `ssh` 以支持仓库操作。数据持久化存储在 `/data` 卷中。可选挂载项目目录以从容器内访问本地仓库。 + #### 方式五：从源码构建 ```bash diff --git a/docs/readme/README.zh-TW.md b/docs/readme/README.zh-TW.md index af79382..ef2c252 100644 --- a/docs/readme/README.zh-TW.md +++ b/docs/readme/README.zh-TW.md @@ -21,17 +21,13 @@ Codeg（Code Generation）是一個企業級多 Agent 編碼工作台。 它將本地 AI 編碼代理（Claude Code、Codex CLI、OpenCode、Gemini CLI、 -OpenClaw、Cline 等）整合到桌面應用與 Web 服務中——透過瀏覽器即可遠端開發——支援會話彙整、並行 `git worktree` +OpenClaw、Cline 等）整合到桌面應用、獨立伺服器或 Docker 容器中——透過瀏覽器即可遠端開發——支援會話彙整、並行 `git worktree` 開發、MCP/Skills 管理，以及整合的 Git/檔案/終端工作流。 ## 主介面 ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) -## 會話平鋪顯示 -![Codeg Light](../images/main2-light.png#gh-light-mode-only) -![Codeg Dark](../images/main2-dark.png#gh-dark-mode-only) - ## 設定 | 代理 | MCP | Skills | 版本控制 | Web 服務 | | :---: | :---: | :---: | :---: | :---: | @@ -48,7 +44,7 @@ OpenClaw、Cline 等）整合到桌面應用與 Web 服務中——透過瀏覽 - Git 遠端帳號管理（支援 GitHub 及其他 Git 伺服器） - Web 服務模式 — 開啟後可在瀏覽器中存取 Codeg，支援遠端工作 - **獨立伺服器部署** — 在任意 Linux/macOS 伺服器上執行 `codeg-server`，透過瀏覽器存取 -- **Docker 支援** — 使用 `docker compose up` 部署，零設定啟動服務 +- **Docker 支援** — 多階段建置映像，支援 `docker compose up` 或 `docker run`，可自訂令牌、連接埠，支援資料持久化及專案目錄掛載 - 整合工程閉環（檔案樹、Diff、Git 變更、提交、終端） ## 專案啟動器 @@ -208,12 +204,22 @@ CODEG_STATIC_DIR=./web ./codeg-server #### 方式四：Docker ```bash +# 使用 Docker Compose（推薦） docker compose up -d -# 或直接執行 -docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest +# 或直接使用 Docker 執行 +docker run -d -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest + +# 自訂令牌並掛載專案目錄 +docker run -d -p 3080:3080 \ + -v codeg-data:/data \ + -v /path/to/projects:/projects \ + -e CODEG_TOKEN=your-secret-token \ + ghcr.io/xintaofei/codeg:latest ``` +Docker 映像採用多階段建置（Node.js + Rust → 精簡 Debian 執行環境），內建 `git` 和 `ssh` 以支援倉庫操作。資料持久化儲存在 `/data` 卷中。可選掛載專案目錄以從容器內存取本地倉庫。 + #### 方式五：從原始碼建置 ```bash