feat: 添加 Docker 支持和完善文档
- 添加 Dockerfile (多阶段构建, alpine 运行时, 14MB 镜像) - 添加 docker-compose.yml - 添加 .dockerignore - README 添加 Docker 部署说明、二进制部署说明 - Docker 镜像: ouaone/tonav-go:v1.0.0
This commit is contained in:
54
README.md
54
README.md
@@ -80,11 +80,53 @@ ToNav-go/
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 环境要求
|
||||
- Go 1.24+
|
||||
- GCC(CGO 编译 SQLite 需要)
|
||||
### 方式一:Docker 部署(推荐)
|
||||
|
||||
### 编译运行
|
||||
```bash
|
||||
# 直接运行
|
||||
docker run -d \
|
||||
--name tonav-go \
|
||||
-p 9520:9520 \
|
||||
-v ./data:/app/data \
|
||||
-v ./backups:/app/backups \
|
||||
-e TONAV_SECRET=your-secret-key \
|
||||
ouaone/tonav-go:latest
|
||||
|
||||
# 或使用 docker-compose
|
||||
wget https://gitea.king.nyc.mn/openclaw/ToNav-go/raw/branch/master/docker-compose.yml
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
**Docker 镜像**:[ouaone/tonav-go](https://hub.docker.com/r/ouaone/tonav-go)
|
||||
|
||||
**环境变量:**
|
||||
|
||||
| 变量 | 默认值 | 说明 |
|
||||
|------|--------|------|
|
||||
| `TONAV_PORT` | `9520` | 监听端口 |
|
||||
| `TONAV_DB` | `/app/data/tonav.db` | 数据库路径 |
|
||||
| `TONAV_SECRET` | 内置密钥 | Cookie 签名密钥(生产环境务必修改) |
|
||||
| `TZ` | `Asia/Shanghai` | 时区 |
|
||||
|
||||
**数据持久化:**
|
||||
|
||||
| 挂载路径 | 说明 |
|
||||
|----------|------|
|
||||
| `/app/data` | 数据库文件 |
|
||||
| `/app/backups` | 本地备份文件 |
|
||||
|
||||
### 方式二:二进制部署
|
||||
|
||||
从 [Releases](https://gitea.king.nyc.mn/openclaw/ToNav-go/releases) 下载对应平台的二进制文件:
|
||||
|
||||
```bash
|
||||
chmod +x tonav-go-linux-amd64
|
||||
./tonav-go-linux-amd64
|
||||
```
|
||||
|
||||
### 方式三:源码编译
|
||||
|
||||
环境要求:Go 1.24+、GCC(CGO 编译 SQLite)
|
||||
|
||||
```bash
|
||||
# 克隆项目
|
||||
@@ -100,6 +142,8 @@ go build -o tonav-go-v1
|
||||
|
||||
### 使用管理脚本
|
||||
|
||||
项目自带 `tonav-go-ctl.sh` 管理脚本(二进制部署时使用):
|
||||
|
||||
```bash
|
||||
chmod +x tonav-go-ctl.sh
|
||||
|
||||
@@ -111,7 +155,7 @@ chmod +x tonav-go-ctl.sh
|
||||
./tonav-go-ctl.sh log # 查看日志
|
||||
```
|
||||
|
||||
### 环境变量配置
|
||||
### 环境变量配置(二进制部署时)
|
||||
|
||||
| 变量 | 默认值 | 说明 |
|
||||
|------|--------|------|
|
||||
|
||||
Reference in New Issue
Block a user