jimeng-api

环境要求

• 已安装 Docker（推荐使用官方镜像部署）
• 已安装 Docker Compose（使用 docker-compose 方式时）
• 已安装 Node.js 与 npm（本地直接运行方式）
• 宿主机 5100 端口可用

安装与启动步骤

1. 1拉取并启动镜像

   官方推荐方式，直接拉取 ghcr.io 镜像并后台启动容器，映射 5100 端口，容器随系统自启。

   docker run -d --name jimeng-api -p 5100:5100 --restart unless-stopped ghcr.io/iptag/jimeng-api:latest

   复制

2. 2更新镜像版本

   通过 watchtower 一次性检查并更新名为 jimeng-api 的容器，需挂载 docker.sock。

   docker run --rm -v /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower --run-once jimeng-api

   复制

3. 3docker-compose 部署

   若项目目录下有 docker-compose 配置，可直接后台启动；无需手动执行 docker run。

   docker-compose up -d

   复制

4. 4手动构建并运行

   不使用现成镜像时，先在项目根目录构建本地镜像 jimeng-api，再按同样参数启动容器。

   docker build -t jimeng-api .
   docker run -d --name jimeng-api -p 5100:5100 --restart unless-stopped jimeng-api

   复制

5. 5本地安装依赖

   非容器方式运行时，在项目目录执行 npm install 安装依赖，README 未给出后续启动命令，需查阅源码。

   npm install

   复制

关键配置

如何确认成功

执行 docker ps 可见 jimeng-api 容器处于运行状态，且宿主机 5100 端口已被监听。

常见问题

注意事项

• 项目为非官方逆向接口，仅供研究学习，请自行评估合规与稳定性风险。
• README 中的 Configuration 章节为空，配置项需以源码中的配置文件为准。
• 默认服务端口为 5100，若被占用可自行调整宿主机端口映射。
• 建议关注项目仓库更新，官方接口变动可能影响可用性。