CodeChat Api Docker镜像文档

镜像概述

CodeChat Api是基于Baileys实现的*** API服务，作为稳定且可扩展的RESTful API，用于控制功能。通过该服务，用户无需了解Node.js即可通过HTTP请求使用相关功能，支持创建多服务聊天、服务机器人及各类依赖***的业务系统。

维护与支持

• 维护者：The CodeChat Org
• 获取帮助：***群、***群
• 问题反馈：GitHub Issues

核心功能与特性

• 稳定可扩展的RESTful API：基于Baileys实现，提供可靠的***功能控制接口
• 多实例管理：支持创建和管理多个***实例，满足多服务并行需求
• 灵活的环境变量配置：通过环境变量全面配置服务参数，无需修改代码
• 数据持久化：支持PostgreSQL存储消息、联系人、聊天记录等数据
• Redis集成：可配置Redis存储***连接数据，提升性能
• Webhook支持：全局Webhook配置，监听所有实例的指定事件
• 完善的认证机制：支持全局API密钥和JWT认证，保障接口安全
• 文件存储集成：支持MinIO/AWS S3存储媒体文件
• 二维码控制：可配置二维码显示频率和过期时间
• 实例自动清理：支持无连接实例自动从内存中清理

使用场景

• 企业客服机器人：构建基于***的自动化客服系统，处理客户咨询
• 多服务聊天集成：将***消息集成到企业内部多服务聊天系统
• 消息自动化：实现订单通知、验证码、提醒等消息的自动发送
• 业务系统集成：为电商、物流等业务系统提供***消息交互能力
• 社交机器人开发：快速开发各类***聊天机器人，实现自定义交互逻辑

环境变量配置

服务器配置

日志配置

用于控制日志输出级别和格式。

实例清理配置

控制无连接实例在内存中的保留时间，默认5分钟。若设置为false则永不自动清理。

Webhook设置

配置全局Webhook，用于监听所有实例的指定事件。

数据持久化存储

当前仅支持PostgreSQL数据库。

Redis连接配置

用于存储***连接数据。

会话手机名称配置

设置在手机端显示的会话客户端名称。

二维码控制配置

***连接超时配置

认证配置

MinIO - AWS S3配置

用于媒体文件存储。

使用方法

Docker Run 命令

docker run -d --restart 'always' \
 --name 'api-codechat' \
 --mount 'type=bind,source=/data/instances,target=/codechat/instances' \
 --publish '8083:8083' \
 --hostname 'codechat' \
 --env-file './env' \
 --network 'codechat-net' \
 codechat/api:latest

参数说明：

• --restart 'always'：容器退出时总是自动重启
• --name 'api-codechat'：容器名称设为api-codechat
• --mount：挂载宿主机目录/data/instances到容器内/codechat/instances，用于持久化实例数据
• --publish '8083:8083'：端口映射，宿主机8083端口映射到容器8083端口
• --env-file './env'：从本地env文件加载环境变量
• --network 'codechat-net'：加入codechat-net网络

Docker Compose 配置

version: '3.8'

networks:
  public-network:
    driver: bridge

services:
  api:
    container_name: codechat_api
    image: codechat/api:latest
    restart: unless-stopped
    ports:
      - 8084:8084
    volumes:
      - instances_connecteds:/codechat/instances
    environment:
      - SERVER_PORT=8084
      - SESSION_SECRET=W0NvZGVDaGF0XTpbU2Vzc

      - LOG_LEVEL=ERROR|WARN|INFO|DEBUG|LOG|VERBOSE|DARK
      - LOG_COLOR=true

      - DATABASE_ENABLED=true
      - DATABASE_URL=postgres://[USER]:[PASS]@[HOST]:[PORT]/[DATABASE_NAME]?schema=public
      - DATABASE_SYNC_MESSAGES=true
      - DATABASE_SAVE_DATA_NEW_MESSAGE=true
      - DATABASE_SAVE_MESSAGE_UPDATE=true
      - DATABASE_SAVE_DATA_CONTACTS=true
      - DATABASE_SAVE_DATA_CHATS=true

      - GLOBAL_WEBHOOK_URL=url
      - GLOBAL_WEBHOOK_ENABLED=false

      - INSTANCE_EXPIRATION_TIME=false

      - CONFIG_SESSION_PHONE_CLIENT=CodeChat_V1
      - CONFIG_SESSION_PHONE_NAME=Edge

      - QRCODE_LIMIT=10
      - QRCODE_EXPIRATION_TIME=60

      - CONNECTION_TIMEOUT=300

      - AUTHENTICATION_GLOBAL_AUTH_TOKEN=zYzP7ocstxh3SJ23D4FZTCu4ehnM8v4hu
      - AUTHENTICATION_JWT_EXPIRES_IN=0
      - AUTHENTICATION_JWT_SECRET=3RFYiiRmvNiokSBrLZzx

      # - REDIS_ENABLED=false
      # - REDIS_URI=redis://[HOST]/5
      # - REDIS_PREFIX=codechat

      # - S3_ENABLED=false
      # - S3_ACCESS_KEY=[ACCESS_KEY]
      # - S3_SECRET_KEY=[SECRET_KEY]
      # - S3_BUCKET=[BUCKET]
      # - S3_PORT=9000
      # - S3_ENDPOINT=[ENDPOINT]
      # - S3_USE_SSL=false
    networks:
      - public-network
  
  # redis_cache:
  #   image: redis:latest
  #   container_name: redis_cache
  #   volumes:
  #     - redis_data:/data
  #   ports:
  #     - "6379:6379"
  #   networks:
  #     - public-network

volumes:
  instances_connecteds:
    driver: local
  # redis_data:
  #   driver: local

说明：配置文件中包含了完整的环境变量设置示例，以及可选的Redis服务配置。根据实际需求取消注释并配置相应参数即可。

查看完整文档

查看Git仓库文档

By CodeChat ©