添加:ZHub 管理接口文档和客户端使用指南
This commit is contained in:
169
docs/tutorial-extras/docker-deployment.md
Normal file
169
docs/tutorial-extras/docker-deployment.md
Normal file
@@ -0,0 +1,169 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
title: Docker 部署
|
||||
description: ZHub Docker 容器化部署指南
|
||||
---
|
||||
|
||||
# Docker 部署
|
||||
|
||||
ZHub 支持 Docker 容器化部署,提供简化的构建和运行方式。
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 1. 准备文件
|
||||
|
||||
从 [https://zhub.dev/release/latest/](https://zhub.dev/release/latest/) 下载软件包并解压:
|
||||
|
||||
```bash
|
||||
# 解压后目录结构
|
||||
zhub/
|
||||
├── zhub.sh # 可执行文件
|
||||
├── app.ini # 配置文件
|
||||
└── auth.yml # 权限配置文件(可选)
|
||||
```
|
||||
|
||||
### 2. 构建镜像
|
||||
|
||||
创建 `Dockerfile` 文件:
|
||||
|
||||
```dockerfile
|
||||
# 使用Alpine Linux作为基础镜像
|
||||
FROM alpine:latest
|
||||
|
||||
# 设置工作目录
|
||||
WORKDIR /opt/zhub
|
||||
|
||||
# 复制解压后的文件
|
||||
COPY zhub.sh ./
|
||||
COPY app.ini ./
|
||||
COPY auth.yml ./
|
||||
|
||||
# 给执行文件添加执行权限
|
||||
RUN chmod +x ./zhub.sh
|
||||
|
||||
# 暴露端口
|
||||
# 711: 管理接口端口
|
||||
# 1216: 服务端口
|
||||
EXPOSE 711 1216
|
||||
|
||||
# 设置启动命令
|
||||
CMD ["./zhub.sh"]
|
||||
```
|
||||
|
||||
构建镜像:
|
||||
|
||||
```bash
|
||||
# 构建镜像
|
||||
docker build -t zhub:latest .
|
||||
```
|
||||
|
||||
### 3. 运行容器
|
||||
|
||||
```bash
|
||||
# 基础运行
|
||||
docker run -d -p 711:711 -p 1216:1216 --name zhub zhub:latest
|
||||
|
||||
# 带数据持久化
|
||||
docker run -d \
|
||||
-p 711:711 \
|
||||
-p 1216:1216 \
|
||||
-v /host/data:/opt/zhub/data \
|
||||
--name zhub \
|
||||
zhub:latest
|
||||
```
|
||||
|
||||
### 4. 验证部署
|
||||
|
||||
```bash
|
||||
# 检查服务状态
|
||||
curl http://localhost:711/_/info
|
||||
|
||||
# 查看容器日志
|
||||
docker logs -f zhub
|
||||
```
|
||||
|
||||
## 生产环境配置
|
||||
|
||||
### 数据持久化
|
||||
```bash
|
||||
# 挂载数据目录
|
||||
docker run -d \
|
||||
-p 711:711 \
|
||||
-p 1216:1216 \
|
||||
-v /host/data:/opt/zhub/data \
|
||||
--name zhub \
|
||||
zhub:latest
|
||||
```
|
||||
|
||||
### 自定义配置
|
||||
```bash
|
||||
# 挂载自定义配置文件
|
||||
docker run -d \
|
||||
-p 711:711 \
|
||||
-p 1216:1216 \
|
||||
-v /host/config/app.ini:/opt/zhub/app.ini \
|
||||
-v /host/config/auth.yml:/opt/zhub/auth.yml \
|
||||
--name zhub \
|
||||
zhub:latest
|
||||
```
|
||||
|
||||
## Docker Compose 部署
|
||||
|
||||
### 基础配置
|
||||
|
||||
创建 `docker-compose.yml` 文件:
|
||||
|
||||
```yaml
|
||||
version: '3.8'
|
||||
|
||||
services:
|
||||
zhub:
|
||||
image: zhub:latest
|
||||
container_name: zhub
|
||||
ports:
|
||||
- "711:711" # 管理端口
|
||||
- "1216:1216" # 服务端口
|
||||
volumes:
|
||||
- ./data:/opt/zhub/data
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
### 启动服务
|
||||
|
||||
```bash
|
||||
# 启动服务
|
||||
docker-compose up -d
|
||||
|
||||
# 查看服务状态
|
||||
docker-compose ps
|
||||
|
||||
# 停止服务
|
||||
docker-compose down
|
||||
```
|
||||
|
||||
## 故障排除
|
||||
|
||||
### 常见问题
|
||||
|
||||
```bash
|
||||
# 查看容器日志
|
||||
docker logs zhub
|
||||
|
||||
# 检查端口占用
|
||||
netstat -tulpn | grep :1216
|
||||
netstat -tulpn | grep :711
|
||||
|
||||
# 检查服务状态
|
||||
curl http://localhost:711/_/info
|
||||
```
|
||||
|
||||
### 调试模式
|
||||
|
||||
```bash
|
||||
# 以调试模式运行
|
||||
docker run -it --rm \
|
||||
-p 711:711 \
|
||||
-p 1216:1216 \
|
||||
-v ./data:/opt/zhub/data \
|
||||
zhub:latest
|
||||
```
|
||||
Reference in New Issue
Block a user