suzukirenz/nanobot

Nanobot Docker镜像文档

镜像概述和主要用途

Nanobot是一个基于Docker的服务应用，包含Gateway（网关）和CLI（命令行界面）两个核心组件。该镜像提供了便捷的容器化部署方案，支持配置持久化存储、Docker环境集成及资源管理，适用于需要稳定运行和灵活管理的服务场景。

项目信息

核心功能和特性

• 多组件支持：包含Gateway服务和CLI工具，满足不同使用需求
• 配置持久化：通过数据卷挂载实现配置文件持久化存储
• Docker集成：支持挂载Docker socket，实现与宿主Docker环境的交互
• 环境变量定制：可通过环境变量配置时区、API密钥等参数
• 资源管理：支持设置CPU和内存的使用限制与预留
• 灵活部署：通过Docker Compose实现多服务协同部署，CLI组件可通过profiles控制启动
• 高可用性：默认采用unless-stopped重启策略，确保服务稳定运行

使用场景和适用范围

• 需要后台持续运行的网关服务部署
• 需与Docker环境交互的服务管理场景
• 对资源使用有严格限制的应用部署
• 需要通过命令行工具进行服务状态监控和管理的场景
• 开发和生产环境中的一致化部署需求

详细使用方法和配置说明

前提条件

• 已安装Docker环境
• 已安装Docker Compose工具

安装Docker和Docker Compose

bash
# 安装Docker
curl -fsSL https://get.docker.com|sh

# 安装Docker Compose
pip3 install docker-compose

Docker Compose部署（推荐）

创建docker-compose.yml文件，内容如下：

yaml
x-common-config: &common-config
  # 构建配置（如需从源码构建，取消注释并配置）
  # build:
  #   context: https://github.com/HKUDS/nanobot.git#main
  #   dockerfile: Dockerfile
  
  # 镜像配置
  image: docker.xuanyuan.run/suzukirenz/nanobot:latest
  
  # 数据卷配置
  volumes:
    - ./config:/root/.nanobot  # 配置文件持久化存储
    - /var/run/docker.sock:/var/run/docker.sock  # Docker socket挂载，实现与宿主Docker交互
  
  # 环境变量
  environment:
    - TZ=Asia/Shanghai  # 设置时区
    # - API_KEY=  # 如需API密钥，取消注释并填入
  
  # 重启策略
  restart: unless-stopped  # 除非手动停止，否则自动重启

services:
  # Gateway服务（核心服务）
  nanobot-gateway:
    container_name: nanobot-gateway  # 容器名称
    <<: *common-config  # 继承通用配置
    command: ["gateway"]  # 启动Gateway服务
    ports:
      - "18790:18790"  # 端口映射（宿主端口:容器端口）
    deploy:
      resources:
        limits:
          cpus: '4'  # CPU使用上限
          memory: 2G  # 内存使用上限
        reservations:
          cpus: '1'  # CPU预留
          memory: 1G  # 内存预留

  # CLI服务（默认不启动，通过profiles控制）
  nanobot-cli:
    container_name: nanobot-cli  # 容器名称
    <<: *common-config  # 继承通用配置
    profiles:
      - cli  # 配置文件，使用时需指定--profile cli
    command: ["status"]  # 默认命令：查看状态
    stdin_open: true  # 保持标准输入打开
    tty: true  # 分配伪终端
    # privileged: true  # 如需特权模式，取消注释

环境变量配置

1. 复制环境变量示例文件（如项目提供）：

bash
cp .env.example .env

2. 编辑.env文件，根据需求配置环境变量，主要参数说明：

启动和管理服务

启动Gateway服务

bash
docker-compose up -d

启动CLI服务（需指定profile）

bash
docker-compose --profile cli up -d

查看服务状态

bash
# 查看Gateway服务状态
docker-compose ps nanobot-gateway

# 查看CLI服务日志
docker-compose --profile cli logs nanobot-cli

停止服务

bash
# 停止所有服务
docker-compose down

# 仅停止Gateway服务
docker-compose stop nanobot-gateway

重启服务

bash
docker-compose restart nanobot-gateway