wuxu/codeg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

支持一键安装脚本

Browse Source
This commit is contained in:
xintaofei
2026-03-29 19:46:41 +08:00
parent 1cda9aa5f5
commit a49b59e403
13 changed files with 996 additions and 163 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
docs/readme/README.ar.md
View File

@@ -156,17 +156,75 @@ cargo build
يمكن تشغيل Codeg كخادم ويب مستقل بدون بيئة سطح مكتب.
#### الخيار 1: الملف التنفيذي المباشر
#### الخيار 1: التثبيت بسطر واحد (Linux / macOS)
```bash
# بناء الملف التنفيذي للخادم
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash
```
تثبيت إصدار محدد أو في دليل مخصص:
```bash
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash -s -- --version v0.5.0 --dir ~/.local/bin
```
ثم التشغيل:
```bash
codeg-server
```
#### الخيار 2: التثبيت بسطر واحد (Windows PowerShell)
```powershell
irm https://raw.githubusercontent.com/xintaofei/codeg/main/install.ps1 | iex
```
أو تثبيت إصدار محدد:
```powershell
.\install.ps1 -Version v0.5.0
```
#### الخيار 3: التنزيل من GitHub Releases
الملفات التنفيذية المُعدّة مسبقًا (مع موارد الويب المضمّنة) متاحة في صفحة [Releases](https://github.com/xintaofei/codeg/releases):
| المنصة | الملف |
| --- | --- |
| Linux x64 | `codeg-server-linux-x64.tar.gz` |
| Linux arm64 | `codeg-server-linux-arm64.tar.gz` |
| macOS x64 | `codeg-server-darwin-x64.tar.gz` |
| macOS arm64 | `codeg-server-darwin-arm64.tar.gz` |
| Windows x64 | `codeg-server-windows-x64.zip` |
```bash
# مثال: التنزيل والاستخراج والتشغيل
tar xzf codeg-server-linux-x64.tar.gz
cd codeg-server-linux-x64
CODEG_STATIC_DIR=./web ./codeg-server
```
#### الخيار 4: Docker
```bash
docker compose up -d
# أو التشغيل مباشرة
docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest
```
#### الخيار 5: البناء من المصدر
```bash
pnpm install && pnpm build # بناء الواجهة الأمامية
cd src-tauri
cargo build --release --bin codeg-server --no-default-features
# التشغيل
CODEG_PORT=3080 CODEG_STATIC_DIR=../out ./target/release/codeg-server
CODEG_STATIC_DIR=../out ./target/release/codeg-server
```
#### التكوين
متغيرات البيئة:
| المتغير | الافتراضي | الوصف |
@@ -177,17 +235,6 @@ CODEG_PORT=3080 CODEG_STATIC_DIR=../out ./target/release/codeg-server
| `CODEG_DATA_DIR` | `~/.local/share/codeg` | دليل قاعدة بيانات SQLite |
| `CODEG_STATIC_DIR` | `./web` أو `./out` | دليل التصدير الثابت لـ Next.js |
#### الخيار 2: Docker
```bash
# البناء والتشغيل
docker compose up -d
# أو البناء يدويًا
docker build -t codeg .
docker run -p 3080:3080 -v codeg-data:/data codeg
```
## الهندسة المعمارية
```text

90
docs/readme/README.de.md
View File

@@ -154,30 +154,88 @@ cargo clippy
cargo build
```
## Server-Bereitstellung
### Server-Bereitstellung
Codeg kann als eigenständiger Webserver ohne Tauri-Abhängigkeiten oder GUI betrieben werden.
Codeg kann als eigenständiger Webserver ohne Desktop-Umgebung betrieben werden.
### Option 1: Direktes Binary
#### Option 1: Ein-Zeilen-Installation (Linux / macOS)
```bash
pnpm server:build
./target/release/codeg-server
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash
```
Eine bestimmte Version oder in ein benutzerdefiniertes Verzeichnis installieren:
```bash
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash -s -- --version v0.5.0 --dir ~/.local/bin
```
Dann ausführen:
```bash
codeg-server
```
#### Option 2: Ein-Zeilen-Installation (Windows PowerShell)
```powershell
irm https://raw.githubusercontent.com/xintaofei/codeg/main/install.ps1 | iex
```
Oder eine bestimmte Version installieren:
```powershell
.\install.ps1 -Version v0.5.0
```
#### Option 3: Von GitHub Releases herunterladen
Vorkompilierte Binärdateien (mit gebündelten Web-Assets) sind auf der [Releases](https://github.com/xintaofei/codeg/releases)-Seite verfügbar:
| Plattform | Datei |
| --- | --- |
| Linux x64 | `codeg-server-linux-x64.tar.gz` |
| Linux arm64 | `codeg-server-linux-arm64.tar.gz` |
| macOS x64 | `codeg-server-darwin-x64.tar.gz` |
| macOS arm64 | `codeg-server-darwin-arm64.tar.gz` |
| Windows x64 | `codeg-server-windows-x64.zip` |
```bash
# Beispiel: Herunterladen, Entpacken und Ausführen
tar xzf codeg-server-linux-x64.tar.gz
cd codeg-server-linux-x64
CODEG_STATIC_DIR=./web ./codeg-server
```
#### Option 4: Docker
```bash
docker compose up -d
# Oder direkt ausführen
docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest
```
#### Option 5: Aus Quellcode kompilieren
```bash
pnpm install && pnpm build # Frontend kompilieren
cd src-tauri
cargo build --release --bin codeg-server --no-default-features
CODEG_STATIC_DIR=../out ./target/release/codeg-server
```
#### Konfiguration
Umgebungsvariablen:
| Variable | Standardwert | Beschreibung |
| --- | --- | --- |
| CODEG_PORT | 3080 | HTTP-Port |
| CODEG_HOST | 0.0.0.0 | Bind-Adresse |
| CODEG_TOKEN | (zufällig) | Authentifizierungstoken |
| CODEG_DATA_DIR | ~/.local/share/codeg | SQLite-Datenbankverzeichnis |
| CODEG_STATIC_DIR | ./web oder ./out | Next.js-Statikexport-Verzeichnis |
### Option 2: Docker
```bash
docker compose up
```
| `CODEG_PORT` | `3080` | HTTP-Port |
| `CODEG_HOST` | `0.0.0.0` | Bind-Adresse |
| `CODEG_TOKEN` | *(zufällig)* | Authentifizierungstoken (wird beim Start auf stderr ausgegeben) |
| `CODEG_DATA_DIR` | `~/.local/share/codeg` | SQLite-Datenbankverzeichnis |
| `CODEG_STATIC_DIR` | `./web` oder `./out` | Next.js-Statikexport-Verzeichnis |
## Architektur

90
docs/readme/README.es.md
View File

@@ -154,30 +154,88 @@ cargo clippy
cargo build
```
## Despliegue del servidor
### Despliegue del servidor
Codeg puede ejecutarse como un servidor web independiente sin dependencias de Tauri ni GUI.
Codeg puede ejecutarse como un servidor web independiente sin entorno de escritorio.
### Opción 1: Binario directo
#### Opción 1: Instalación en una línea (Linux / macOS)
```bash
pnpm server:build
./target/release/codeg-server
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash
```
Instalar una versión específica o en un directorio personalizado:
```bash
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash -s -- --version v0.5.0 --dir ~/.local/bin
```
Luego ejecutar:
```bash
codeg-server
```
#### Opción 2: Instalación en una línea (Windows PowerShell)
```powershell
irm https://raw.githubusercontent.com/xintaofei/codeg/main/install.ps1 | iex
```
O instalar una versión específica:
```powershell
.\install.ps1 -Version v0.5.0
```
#### Opción 3: Descargar desde GitHub Releases
Los binarios precompilados (con recursos web incluidos) están disponibles en la página de [Releases](https://github.com/xintaofei/codeg/releases):
| Plataforma | Archivo |
| --- | --- |
| Linux x64 | `codeg-server-linux-x64.tar.gz` |
| Linux arm64 | `codeg-server-linux-arm64.tar.gz` |
| macOS x64 | `codeg-server-darwin-x64.tar.gz` |
| macOS arm64 | `codeg-server-darwin-arm64.tar.gz` |
| Windows x64 | `codeg-server-windows-x64.zip` |
```bash
# Ejemplo: descargar, extraer y ejecutar
tar xzf codeg-server-linux-x64.tar.gz
cd codeg-server-linux-x64
CODEG_STATIC_DIR=./web ./codeg-server
```
#### Opción 4: Docker
```bash
docker compose up -d
# O ejecutar directamente
docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest
```
#### Opción 5: Compilar desde el código fuente
```bash
pnpm install && pnpm build # compilar frontend
cd src-tauri
cargo build --release --bin codeg-server --no-default-features
CODEG_STATIC_DIR=../out ./target/release/codeg-server
```
#### Configuración
Variables de entorno:
| Variable | Valor por defecto | Descripción |
| --- | --- | --- |
| CODEG_PORT | 3080 | Puerto HTTP |
| CODEG_HOST | 0.0.0.0 | Dirección de enlace |
| CODEG_TOKEN | (aleatorio) | Token de autenticación |
| CODEG_DATA_DIR | ~/.local/share/codeg | Directorio de base de datos SQLite |
| CODEG_STATIC_DIR | ./web o ./out | Directorio de exportación estática de Next.js |
### Opción 2: Docker
```bash
docker compose up
```
| `CODEG_PORT` | `3080` | Puerto HTTP |
| `CODEG_HOST` | `0.0.0.0` | Dirección de enlace |
| `CODEG_TOKEN` | *(aleatorio)* | Token de autenticación (se imprime en stderr al iniciar) |
| `CODEG_DATA_DIR` | `~/.local/share/codeg` | Directorio de base de datos SQLite |
| `CODEG_STATIC_DIR` | `./web` o `./out` | Directorio de exportación estática de Next.js |
## Arquitectura

90
docs/readme/README.fr.md
View File

@@ -152,30 +152,88 @@ cargo clippy
cargo build
```
## Déploiement du serveur
### Déploiement du serveur
Codeg peut fonctionner comme un serveur web autonome sans dépendances Tauri ni interface graphique.
Codeg peut fonctionner comme un serveur web autonome sans environnement de bureau.
### Option 1 : Binaire direct
#### Option 1 : Installation en une ligne (Linux / macOS)
```bash
pnpm server:build
./target/release/codeg-server
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash
```
Installer une version spécifique ou dans un répertoire personnalisé :
```bash
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash -s -- --version v0.5.0 --dir ~/.local/bin
```
Puis exécuter :
```bash
codeg-server
```
#### Option 2 : Installation en une ligne (Windows PowerShell)
```powershell
irm https://raw.githubusercontent.com/xintaofei/codeg/main/install.ps1 | iex
```
Ou installer une version spécifique :
```powershell
.\install.ps1 -Version v0.5.0
```
#### Option 3 : Télécharger depuis GitHub Releases
Les binaires pré-compilés (avec les ressources web incluses) sont disponibles sur la page [Releases](https://github.com/xintaofei/codeg/releases) :
| Plateforme | Fichier |
| --- | --- |
| Linux x64 | `codeg-server-linux-x64.tar.gz` |
| Linux arm64 | `codeg-server-linux-arm64.tar.gz` |
| macOS x64 | `codeg-server-darwin-x64.tar.gz` |
| macOS arm64 | `codeg-server-darwin-arm64.tar.gz` |
| Windows x64 | `codeg-server-windows-x64.zip` |
```bash
# Exemple : télécharger, extraire et exécuter
tar xzf codeg-server-linux-x64.tar.gz
cd codeg-server-linux-x64
CODEG_STATIC_DIR=./web ./codeg-server
```
#### Option 4 : Docker
```bash
docker compose up -d
# Ou exécuter directement
docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest
```
#### Option 5 : Compiler depuis les sources
```bash
pnpm install && pnpm build # compiler le frontend
cd src-tauri
cargo build --release --bin codeg-server --no-default-features
CODEG_STATIC_DIR=../out ./target/release/codeg-server
```
#### Configuration
Variables d'environnement :
| Variable | Valeur par défaut | Description |
| --- | --- | --- |
| CODEG_PORT | 3080 | Port HTTP |
| CODEG_HOST | 0.0.0.0 | Adresse de liaison |
| CODEG_TOKEN | (aléatoire) | Jeton d'authentification |
| CODEG_DATA_DIR | ~/.local/share/codeg | Répertoire de base de données SQLite |
| CODEG_STATIC_DIR | ./web ou ./out | Répertoire d'export statique Next.js |
### Option 2 : Docker
```bash
docker compose up
```
| `CODEG_PORT` | `3080` | Port HTTP |
| `CODEG_HOST` | `0.0.0.0` | Adresse de liaison |
| `CODEG_TOKEN` | *(aléatoire)* | Jeton d'authentification (affiché sur stderr au démarrage) |
| `CODEG_DATA_DIR` | `~/.local/share/codeg` | Répertoire de base de données SQLite |
| `CODEG_STATIC_DIR` | `./web` ou `./out` | Répertoire d'export statique Next.js |
## Architecture

81
docs/readme/README.ja.md
View File

@@ -156,17 +156,75 @@ cargo build
Codeg はデスクトップ環境なしでスタンドアロン Web サーバーとして実行できます。
#### オプション 1: バイナリ直接実行
#### オプション 1: ワンラインインストール（Linux / macOS）
```bash
# サーバーバイナリのビルド
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash
```
特定のバージョンまたはカスタムディレクトリにインストール:
```bash
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash -s -- --version v0.5.0 --dir ~/.local/bin
```
実行:
```bash
codeg-server
```
#### オプション 2: ワンラインインストール（Windows PowerShell）
```powershell
irm https://raw.githubusercontent.com/xintaofei/codeg/main/install.ps1 | iex
```
または特定のバージョンをインストール:
```powershell
.\install.ps1 -Version v0.5.0
```
#### オプション 3: GitHub Releases からダウンロード
ビルド済みバイナリ（Web アセットをバンドル済み）は [Releases](https://github.com/xintaofei/codeg/releases) ページからダウンロードできます:
| プラットフォーム | ファイル |
| --- | --- |
| Linux x64 | `codeg-server-linux-x64.tar.gz` |
| Linux arm64 | `codeg-server-linux-arm64.tar.gz` |
| macOS x64 | `codeg-server-darwin-x64.tar.gz` |
| macOS arm64 | `codeg-server-darwin-arm64.tar.gz` |
| Windows x64 | `codeg-server-windows-x64.zip` |
```bash
# 例: ダウンロード、解凍、実行
tar xzf codeg-server-linux-x64.tar.gz
cd codeg-server-linux-x64
CODEG_STATIC_DIR=./web ./codeg-server
```
#### オプション 4: Docker
```bash
docker compose up -d
# または直接実行
docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest
```
#### オプション 5: ソースからビルド
```bash
pnpm install && pnpm build # フロントエンドをビルド
cd src-tauri
cargo build --release --bin codeg-server --no-default-features
# 実行
CODEG_PORT=3080 CODEG_STATIC_DIR=../out ./target/release/codeg-server
CODEG_STATIC_DIR=../out ./target/release/codeg-server
```
#### 設定
環境変数:
| 変数 | デフォルト | 説明 |
@@ -175,18 +233,7 @@ CODEG_PORT=3080 CODEG_STATIC_DIR=../out ./target/release/codeg-server
| `CODEG_HOST` | `0.0.0.0` | バインドアドレス |
| `CODEG_TOKEN` | *(ランダム)* | 認証トークン（起動時に stderr に出力） |
| `CODEG_DATA_DIR` | `~/.local/share/codeg` | SQLite データベースディレクトリ |
| `CODEG_STATIC_DIR` | `./web` or `./out` | Next.js 静的エクスポートディレクトリ |
#### オプション 2: Docker
```bash
# ビルドして実行
docker compose up -d
# または手動でビルド
docker build -t codeg .
docker run -p 3080:3080 -v codeg-data:/data codeg
```
| `CODEG_STATIC_DIR` | `./web` または `./out` | Next.js 静的エクスポートディレクトリ |
## アーキテクチャ

81
docs/readme/README.ko.md
View File

@@ -156,17 +156,75 @@ cargo build
Codeg는 데스크톱 환경 없이 독립형 웹 서버로 실행할 수 있습니다.
#### 옵션 1: 바이너리 직접 실행
#### 옵션 1: 원라인 설치 (Linux / macOS)
```bash
# 서버 바이너리 빌드
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash
```
특정 버전 또는 사용자 지정 디렉토리에 설치:
```bash
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash -s -- --version v0.5.0 --dir ~/.local/bin
```
실행:
```bash
codeg-server
```
#### 옵션 2: 원라인 설치 (Windows PowerShell)
```powershell
irm https://raw.githubusercontent.com/xintaofei/codeg/main/install.ps1 | iex
```
또는 특정 버전 설치:
```powershell
.\install.ps1 -Version v0.5.0
```
#### 옵션 3: GitHub Releases에서 다운로드
사전 빌드된 바이너리(웹 에셋 포함)는 [Releases](https://github.com/xintaofei/codeg/releases) 페이지에서 다운로드할 수 있습니다:
| 플랫폼 | 파일 |
| --- | --- |
| Linux x64 | `codeg-server-linux-x64.tar.gz` |
| Linux arm64 | `codeg-server-linux-arm64.tar.gz` |
| macOS x64 | `codeg-server-darwin-x64.tar.gz` |
| macOS arm64 | `codeg-server-darwin-arm64.tar.gz` |
| Windows x64 | `codeg-server-windows-x64.zip` |
```bash
# 예시: 다운로드, 압축 해제, 실행
tar xzf codeg-server-linux-x64.tar.gz
cd codeg-server-linux-x64
CODEG_STATIC_DIR=./web ./codeg-server
```
#### 옵션 4: Docker
```bash
docker compose up -d
# 또는 직접 실행
docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest
```
#### 옵션 5: 소스에서 빌드
```bash
pnpm install && pnpm build # 프론트엔드 빌드
cd src-tauri
cargo build --release --bin codeg-server --no-default-features
# 실행
CODEG_PORT=3080 CODEG_STATIC_DIR=../out ./target/release/codeg-server
CODEG_STATIC_DIR=../out ./target/release/codeg-server
```
#### 구성
환경 변수:
| 변수 | 기본값 | 설명 |
@@ -175,18 +233,7 @@ CODEG_PORT=3080 CODEG_STATIC_DIR=../out ./target/release/codeg-server
| `CODEG_HOST` | `0.0.0.0` | 바인드 주소 |
| `CODEG_TOKEN` | *(랜덤)* | 인증 토큰 (시작 시 stderr에 출력) |
| `CODEG_DATA_DIR` | `~/.local/share/codeg` | SQLite 데이터베이스 디렉토리 |
| `CODEG_STATIC_DIR` | `./web` or `./out` | Next.js 정적 내보내기 디렉토리 |
#### 옵션 2: Docker
```bash
# 빌드 및 실행
docker compose up -d
# 또는 수동으로 빌드
docker build -t codeg .
docker run -p 3080:3080 -v codeg-data:/data codeg
```
| `CODEG_STATIC_DIR` | `./web` 또는 `./out` | Next.js 정적 내보내기 디렉토리 |
## 아키텍처

79
docs/readme/README.pt.md
View File

@@ -156,17 +156,75 @@ cargo build
O Codeg pode ser executado como um servidor web standalone sem ambiente desktop.
#### Opção 1: Binário direto
#### Opção 1: Instalação em uma linha (Linux / macOS)
```bash
# Build do binário do servidor
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash
```
Instalar uma versão específica ou em um diretório personalizado:
```bash
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash -s -- --version v0.5.0 --dir ~/.local/bin
```
Em seguida, executar:
```bash
codeg-server
```
#### Opção 2: Instalação em uma linha (Windows PowerShell)
```powershell
irm https://raw.githubusercontent.com/xintaofei/codeg/main/install.ps1 | iex
```
Ou instalar uma versão específica:
```powershell
.\install.ps1 -Version v0.5.0
```
#### Opção 3: Baixar do GitHub Releases
Binários pré-compilados (com recursos web incluídos) estão disponíveis na página de [Releases](https://github.com/xintaofei/codeg/releases):
| Plataforma | Arquivo |
| --- | --- |
| Linux x64 | `codeg-server-linux-x64.tar.gz` |
| Linux arm64 | `codeg-server-linux-arm64.tar.gz` |
| macOS x64 | `codeg-server-darwin-x64.tar.gz` |
| macOS arm64 | `codeg-server-darwin-arm64.tar.gz` |
| Windows x64 | `codeg-server-windows-x64.zip` |
```bash
# Exemplo: baixar, extrair e executar
tar xzf codeg-server-linux-x64.tar.gz
cd codeg-server-linux-x64
CODEG_STATIC_DIR=./web ./codeg-server
```
#### Opção 4: Docker
```bash
docker compose up -d
# Ou executar diretamente
docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest
```
#### Opção 5: Compilar a partir do código-fonte
```bash
pnpm install && pnpm build # compilar frontend
cd src-tauri
cargo build --release --bin codeg-server --no-default-features
# Executar
CODEG_PORT=3080 CODEG_STATIC_DIR=../out ./target/release/codeg-server
CODEG_STATIC_DIR=../out ./target/release/codeg-server
```
#### Configuração
Variáveis de ambiente:
| Variável | Padrão | Descrição |
@@ -177,17 +235,6 @@ Variáveis de ambiente:
| `CODEG_DATA_DIR` | `~/.local/share/codeg` | Diretório do banco de dados SQLite |
| `CODEG_STATIC_DIR` | `./web` ou `./out` | Diretório de exportação estática do Next.js |
#### Opção 2: Docker
```bash
# Build e execução
docker compose up -d
# Ou build manual
docker build -t codeg .
docker run -p 3080:3080 -v codeg-data:/data codeg
```
## Arquitetura
```text

79
docs/readme/README.zh-CN.md
View File

@@ -156,17 +156,75 @@ cargo build
Codeg 可以作为独立 Web 服务器运行，无需桌面环境。
#### 方式一：直接运行二进制
#### 方式一：一键安装（Linux / macOS）
```bash
# 构建服务器二进制
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash
```
安装指定版本或到自定义目录：
```bash
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash -s -- --version v0.5.0 --dir ~/.local/bin
```
然后运行：
```bash
codeg-server
```
#### 方式二：一键安装（Windows PowerShell）
```powershell
irm https://raw.githubusercontent.com/xintaofei/codeg/main/install.ps1 | iex
```
或安装指定版本：
```powershell
.\install.ps1 -Version v0.5.0
```
#### 方式三：从 GitHub Releases 下载
预构建二进制文件（已打包 Web 前端资源）可在 [Releases](https://github.com/xintaofei/codeg/releases) 页面下载：
| 平台 | 文件 |
| --- | --- |
| Linux x64 | `codeg-server-linux-x64.tar.gz` |
| Linux arm64 | `codeg-server-linux-arm64.tar.gz` |
| macOS x64 | `codeg-server-darwin-x64.tar.gz` |
| macOS arm64 | `codeg-server-darwin-arm64.tar.gz` |
| Windows x64 | `codeg-server-windows-x64.zip` |
```bash
# 示例：下载、解压、运行
tar xzf codeg-server-linux-x64.tar.gz
cd codeg-server-linux-x64
CODEG_STATIC_DIR=./web ./codeg-server
```
#### 方式四：Docker
```bash
docker compose up -d
# 或直接运行
docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest
```
#### 方式五：从源码构建
```bash
pnpm install && pnpm build # 构建前端
cd src-tauri
cargo build --release --bin codeg-server --no-default-features
# 运行
CODEG_PORT=3080 CODEG_STATIC_DIR=../out ./target/release/codeg-server
CODEG_STATIC_DIR=../out ./target/release/codeg-server
```
#### 配置
环境变量：
| 变量 | 默认值 | 说明 |
@@ -177,17 +235,6 @@ CODEG_PORT=3080 CODEG_STATIC_DIR=../out ./target/release/codeg-server
| `CODEG_DATA_DIR` | `~/.local/share/codeg` | SQLite 数据库目录 |
| `CODEG_STATIC_DIR` | `./web` 或 `./out` | Next.js 静态导出目录 |
#### 方式二：Docker
```bash
# 构建并运行
docker compose up -d
# 或手动构建
docker build -t codeg .
docker run -p 3080:3080 -v codeg-data:/data codeg
```
## 架构
```text

79
docs/readme/README.zh-TW.md
View File

@@ -156,17 +156,75 @@ cargo build
Codeg 可以作為獨立 Web 伺服器執行，無需桌面環境。
#### 方式一：直接執行二進位檔
#### 方式一：一鍵安裝（Linux / macOS）
```bash
# 建置伺服器二進位檔
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash
```
安裝指定版本或到自訂目錄：
```bash
curl -fsSL https://raw.githubusercontent.com/xintaofei/codeg/main/install.sh | bash -s -- --version v0.5.0 --dir ~/.local/bin
```
然後執行：
```bash
codeg-server
```
#### 方式二：一鍵安裝（Windows PowerShell）
```powershell
irm https://raw.githubusercontent.com/xintaofei/codeg/main/install.ps1 | iex
```
或安裝指定版本：
```powershell
.\install.ps1 -Version v0.5.0
```
#### 方式三：從 GitHub Releases 下載
預建置二進位檔（已打包 Web 前端資源）可在 [Releases](https://github.com/xintaofei/codeg/releases) 頁面下載：
| 平台 | 檔案 |
| --- | --- |
| Linux x64 | `codeg-server-linux-x64.tar.gz` |
| Linux arm64 | `codeg-server-linux-arm64.tar.gz` |
| macOS x64 | `codeg-server-darwin-x64.tar.gz` |
| macOS arm64 | `codeg-server-darwin-arm64.tar.gz` |
| Windows x64 | `codeg-server-windows-x64.zip` |
```bash
# 範例：下載、解壓縮、執行
tar xzf codeg-server-linux-x64.tar.gz
cd codeg-server-linux-x64
CODEG_STATIC_DIR=./web ./codeg-server
```
#### 方式四：Docker
```bash
docker compose up -d
# 或直接執行
docker run -p 3080:3080 -v codeg-data:/data ghcr.io/xintaofei/codeg:latest
```
#### 方式五：從原始碼建置
```bash
pnpm install && pnpm build # 建置前端
cd src-tauri
cargo build --release --bin codeg-server --no-default-features
# 執行
CODEG_PORT=3080 CODEG_STATIC_DIR=../out ./target/release/codeg-server
CODEG_STATIC_DIR=../out ./target/release/codeg-server
```
#### 設定
環境變數：
| 變數 | 預設值 | 說明 |
@@ -177,17 +235,6 @@ CODEG_PORT=3080 CODEG_STATIC_DIR=../out ./target/release/codeg-server
| `CODEG_DATA_DIR` | `~/.local/share/codeg` | SQLite 資料庫目錄 |
| `CODEG_STATIC_DIR` | `./web` 或 `./out` | Next.js 靜態匯出目錄 |
#### 方式二：Docker
```bash
# 建置並執行
docker compose up -d
# 或手動建置
docker build -t codeg .
docker run -p 3080:3080 -v codeg-data:/data codeg
```
## 架構
```text