ad80a1/hostguard-ai repository overview

⁠HostGuard AI 容器镜像说明

⁠一、镜像仓库

所有预构建镜像托管在 Docker Hub：

ad80a1/hostguard-ai

拉取命令：

docker pull ad80a1/hostguard-ai:<tag>

⁠二、镜像 Tag 清单

⁠三、各镜像运行参数

⁠backend（后端）

• 暴露端口：8000（API 与 Web 控制台后端）
• 数据卷：
  • hg-data:/app/data —— SQLite 数据库与采集数据（持久化，删容器不丢）
  • hg-logs:/app/logs —— 运行日志
• 环境变量：
  • TZ=Asia/Shanghai —— 时区
  • 其余配置见主 README / backend/docs/development.md，可通过挂载自定义 .env 覆盖
• 入口脚本：docker-entrypoint.sh 在容器内缺 .env 时，自动由 .env.example 生成，无需手动准备。

⁠frontend（前端）

• 暴露端口：容器内 80，通常映射到宿主机 8080
• 环境变量：
  • API_PORT=8000 —— 前端页面请求后端 API 的端口，需与 backend 实际映射端口一致
• 由 nginx 托管 frontend/ 下的静态文件，本身不含后端逻辑。

⁠四、快速运行

⁠方式 A：docker run（两份镜像分开起）

docker run -d \
  --name hostguard-backend \
  --restart unless-stopped \
  -p 8000:8000 \
  -v hg-data:/app/data \
  -v hg-logs:/app/logs \
  -e TZ=Asia/Shanghai \
  ad80a1/hostguard-ai:backend

docker run -d \
  --name hostguard-frontend \
  --restart unless-stopped \
  -p 8080:80 \
  -e TZ=Asia/Shanghai \
  -e API_PORT=8000 \
  ad80a1/hostguard-ai:frontend

访问：http://服务器IP:8080⁠ ，默认账号 admin / admin@123。

⁠方式 B：docker-compose（推荐）

项目根目录 docker-compose.yml 已引用上述预构建镜像，直接执行即可同时拉起前后端：

docker compose up -d

⁠五、镜像构建（自行构建参考）

镜像由仓库内 Dockerfile 多阶段构建：

• backend/Dockerfile：Python 3.12 多阶段构建，运行时镜像约 240MB，不含编译器。
• frontend/Dockerfile：基于 nginx:alpine 托管静态前端。

本地构建并推送：

docker build -f backend/Dockerfile  -t ad80a1/hostguard-ai:backend  .
docker build -f frontend/Dockerfile -t ad80a1/hostguard-ai:frontend .

docker push ad80a1/hostguard-ai:backend
docker push ad80a1/hostguard-ai:frontend
# 如需同步 latest（=backend）
docker tag ad80a1/hostguard-ai:backend ad80a1/hostguard-ai:latest
docker push ad80a1/hostguard-ai:latest

⁠六、默认凭据

• 管理员账号：admin / admin@123（首次登录后请修改）

⁠七、镜像版本记录（运维备注）

⁠八、相关文档

• 主 README.md —— 部署总览、脚本部署（方式一）、端口扫描（8090）等
• backend/docs/development.md —— 高级配置、自定义 .env、部署排错
• 源码：https://gitee.com/cncsrf/hostguard-ai/⁠