docs: 添加 Docker 快速启动说明到所有 README 文件
为方便用户快速部署,在所有语言的 README 文件中添加了 Docker 快速启动指南,包括命令示例和参数说明
This commit is contained in:
parent
cea64688a2
commit
14b762fc60
3 changed files with 39 additions and 0 deletions
13
README-JA.md
13
README-JA.md
|
|
@ -89,6 +89,19 @@
|
|||
|
||||
AIClient-2-APIを使い始める最も推奨される方法は、自動起動スクリプトを使用し、**Web UIコンソール**で直接ビジュアル設定を行うことです。
|
||||
|
||||
#### 🐳 Docker クイックスタート (推奨)
|
||||
|
||||
```bash
|
||||
docker run -d -p 3000:3000 --restart=always -v "指定パス:/app/configs" --name aiclient2api justlikemaki/aiclient-2-api
|
||||
```
|
||||
|
||||
**パラメータ説明**:
|
||||
- `-d`:バックグラウンドでコンテナを実行
|
||||
- `-p 3000:3000`:コンテナ内の3000ポートをホストの3000ポートにマッピング
|
||||
- `--restart=always`:コンテナ自動再起動ポリシー
|
||||
- `-v "指定パス:/app/configs"`:設定ディレクトリをマウント(「指定パス」を実際のパスに置き換えてください、例:`/home/user/aiclient-configs`)
|
||||
- `--name aiclient2api`:コンテナ名
|
||||
|
||||
#### 1. 起動スクリプトの実行
|
||||
* **Linux/macOS**: `chmod +x install-and-run.sh && ./install-and-run.sh`
|
||||
* **Windows**: `install-and-run.bat` をダブルクリックして実行
|
||||
|
|
|
|||
13
README-ZH.md
13
README-ZH.md
|
|
@ -88,6 +88,19 @@
|
|||
|
||||
使用 AIClient-2-API 最推荐的方式是通过自动化脚本启动,并直接在 **Web UI 控制台** 进行可视化配置。
|
||||
|
||||
#### 🐳 Docker 快捷启动 (推荐)
|
||||
|
||||
```bash
|
||||
docker run -d -p 3000:3000 --restart=always -v "指定路径:/app/configs" --name aiclient2api justlikemaki/aiclient-2-api
|
||||
```
|
||||
|
||||
**参数说明**:
|
||||
- `-d`:后台运行容器
|
||||
- `-p 3000:3000`:将容器内 3000 端口映射到主机 3000 端口
|
||||
- `--restart=always`:容器自动重启策略
|
||||
- `-v "指定路径:/app/configs"`:挂载配置目录(请将"指定路径"替换为实际路径,如 `/home/user/aiclient-configs`)
|
||||
- `--name aiclient2api`:容器名称
|
||||
|
||||
#### 1. 运行启动脚本
|
||||
* **Linux/macOS**: `chmod +x install-and-run.sh && ./install-and-run.sh`
|
||||
* **Windows**: 双击运行 `install-and-run.bat`
|
||||
|
|
|
|||
13
README.md
13
README.md
|
|
@ -89,6 +89,19 @@
|
|||
|
||||
The most recommended way to use AIClient-2-API is to start it through an automated script and configure it visually directly in the **Web UI console**.
|
||||
|
||||
#### 🐳 Docker Quick Start (Recommended)
|
||||
|
||||
```bash
|
||||
docker run -d -p 3000:3000 --restart=always -v "your_path:/app/configs" --name aiclient2api justlikemaki/aiclient-2-api
|
||||
```
|
||||
|
||||
**Parameter Description**:
|
||||
- `-d`: Run container in background
|
||||
- `-p 3000:3000`: Map container port 3000 to host port 3000
|
||||
- `--restart=always`: Container auto-restart policy
|
||||
- `-v "your_path:/app/configs"`: Mount configuration directory (replace "your_path" with actual path, e.g., `/home/user/aiclient-configs`)
|
||||
- `--name aiclient2api`: Container name
|
||||
|
||||
#### 1. Run the startup script
|
||||
* **Linux/macOS**: `chmod +x install-and-run.sh && ./install-and-run.sh`
|
||||
* **Windows**: Double-click `install-and-run.bat`
|
||||
|
|
|
|||
Loading…
Reference in a new issue