meme-generator 镜像文档

镜像概述和主要用途

meme-generator 是一个轻量级表情包生成器镜像，主要用于快速制作各种沙雕表情包。该镜像提供 API 接口，支持通过配置自定义表情资源、生成参数等，满足个性化表情包制作需求。

核心功能与特性

自定义表情包生成：支持通过 API 调用生成各类沙雕表情包。
额外表情资源加载：可通过配置加载用户自定义的表情资源目录。
GIF 生成控制：支持限制生成的 GIF 文件大小和帧数，避免资源占用过大。
百度翻译集成：可选集成百度翻译 API（需提供 AppID 和 APIKey），支持文本翻译功能。
可配置日志等级：支持调整日志输出等级，便于调试和运行状态监控。
API 接口支持：提供标准 API 接口，方便集成到各类应用中。

使用场景与适用范围

个人用户：通过 API 快速制作个性化沙雕表情包。
开发者集成：作为表情包生成模块集成到应用、网站或小程序中。
聊天机器人/社交平台：为聊天机器人、社交平台插件提供动态表情包生成能力。
批量生成场景：需要批量制作表情包的媒体内容创作场景。

部署与使用

Docker 快速启动

通过以下命令快速启动 meme-generator 容器：

shell
docker run -d \
  --name=meme-generator \
  -p 2233:2233 \
  --restart always \
  meetwq/meme-generator:latest

容器启动后，可通过 http://<容器IP>:2233 访问 API 接口调用表情包生成功能。

docker-compose 配置示例

创建 docker-compose.yml 文件，配置如下：

yaml
version: '3'
services:
  meme-generator:
    image: meetwq/meme-generator:latest
    container_name: meme-generator
    ports:
      - "2233:2233"
    volumes:
      - <YOUR_DATA_DIR>:/data  # 映射本地目录用于加载额外表情
    environment:
      - MEME_DIRS='["/data/memes"]'  # 额外表情路径
      - MEME_DISABLED_LIST='[]'      # 禁用表情列表
      - GIF_MAX_SIZE=10.0            # GIF 最大大小（MB）
      - GIF_MAX_FRAMES=100           # GIF 最大帧数
      - BAIDU_TRANS_APPID=<YOUR_BAIDU_TRANS_APPID>  # 百度翻译 AppID（可选）
      - BAIDU_TRANS_APIKEY=<YOUR_BAIDU_TRANS_APIKEY>  # 百度翻译 APIKey（可选）
      - LOG_LEVEL='INFO'             # 日志等级
    restart: always

启动命令：docker-compose up -d

环境变量配置

变量名	默认值	说明
`MEME_DIRS`	`'["/data/memes"]'`	额外表情资源路径，JSON 数组格式
`MEME_DISABLED_LIST`	`'[]'`	禁用表情列表，JSON 数组格式（表情名称）
`GIF_MAX_SIZE`	`10.0`	生成的 GIF 文件最大大小（单位：MB）
`GIF_MAX_FRAMES`	`100`	生成的 GIF 文件最大帧数
`BAIDU_TRANS_APPID`	`''`	百度翻译 API 的 AppID（可选，用于文本翻译）
`BAIDU_TRANS_APIKEY`	`''`	百度翻译 API 的 APIKey（可选，用于文本翻译）
`LOG_LEVEL`	`'INFO'`	日志输出等级，可选值：DEBUG、INFO、WARNING、ERROR

加载额外表情资源

通过配置 MEME_DIRS 环境变量可加载用户自定义表情资源，默认路径为 ["/data/memes"]。具体步骤如下：

映射本地目录：将容器内 /data 目录映射到本地目录 <YOUR_DATA_DIR>，通过 -v <YOUR_DATA_DIR>:/data 实现。
放置表情资源：将额外表情文件（如模板图片等）放置到本地目录 <YOUR_DATA_DIR>/memes 下。
完整启动示例：

shell
docker run -d \
  --name=meme-generator \
  -p 2233:2233 \
  --restart always \
  -v <YOUR_DATA_DIR>:/data \  # 替换为本地实际目录，如 /home/user/meme-data
  -e MEME_DIRS='["/data/memes"]' \
  -e GIF_MAX_SIZE=15.0 \  # 自定义 GIF 最大大小为 15MB
  -e LOG_LEVEL='DEBUG' \  # 开启 DEBUG 日志便于调试
  meetwq/meme-generator:main

启动后，容器将加载 <YOUR_DATA_DIR>/memes 下的额外表情资源。

配置参数详解

所有配置参数通过环境变量传入，具体说明如下：

MEME_DIRS：JSON 数组格式，指定额外表情资源的目录路径，支持多个路径（如 '["/data/memes", "/data/custom"]'）。
MEME_DISABLED_LIST：JSON 数组格式，指定需要禁用的表情名称（如 '["meme1", "meme2"]'），禁用后 API 将无法调用这些表情。
GIF_MAX_SIZE：浮点型，单位 MB，控制生成的 GIF 文件大小上限，超出将截断或报错。
GIF_MAX_FRAMES：整数型，控制生成的 GIF 文件帧数上限，避免生成过大动图。
BAIDU_TRANS_APPID 与 BAIDU_TRANS_APIKEY：若需使用百度翻译功能（如生成多语言文本表情包），需从百度翻译开放平台申请并填写，未提供则翻译功能不可用。
LOG_LEVEL：控制日志输出详细程度，DEBUG 等级适合开发调试，INFO 适合生产环境。