N.E.K.O

环境要求

• Linux 系统（Docker 部署指南面向 Linux）
• 已安装 Docker 与 Docker Compose
• 宿主机普通用户 uid/gid 为 1000（容器内应用用户固定为 1000）
• 端口 48911（HTTP）与 48912（HTTPS）未被占用

安装与启动步骤

1. 1准备 Docker 环境

   确认系统为 Linux，并已装好 Docker 与 Docker Compose；README 未提供安装 Docker 的命令，请自行准备。

2. 2写 docker-compose.yml

   在部署目录新建 docker-compose.yml，填入 README 给出的官方配置，注意 48911/48912 端口映射与两个数据卷。

   version: '3.8'
   services:
     neko-main:
       image: docker.gh-proxy.org/ghcr.io/project-n-e-k-o/n.e.k.o:latest
       container_name: neko
       restart: unless-stopped
       ports:
         - "48911:80"
         - "48912:443"
       volumes:
         - ./neko-home:/home/neko
         - ./logs:/app/logs
       networks:
         - neko-network
   networks:
     neko-network:
       driver: bridge

   复制

3. 3启动容器

   在 docker-compose.yml 同级目录执行，-d 为后台运行。首次启动会自动生成自签名 SSL 证书到 ./neko-home/ssl/。

   docker-compose up -d

   复制

4. 4查看日志

   跟踪启动日志，确认容器正常拉起且 SSL 证书校验通过；启动失败时日志里会有原因。

   docker-compose logs -f

   复制

5. 5配置 API Key

   浏览器打开 Web UI，在 API Key 页面填核心 API（需支持 Realtime API，推荐阿里云）与辅助 API（ChatCompletion）。

6. 6可选：用 Docker Run

   不想用 Compose 时可用官方 docker run 命令，记得先创建 neko-network 网络，路径按需改成自己的。

   NEKO_BASE_PATH="/home/neko/neko-data" && 
   docker network create --driver bridge neko-network 2>/dev/null || true
   docker run -d 
     --name neko 
     --restart unless-stopped 
     -p 48911:80 
     -p 48912:443 
     -v "${NEKO_BASE_PATH}/neko-home:/home/neko" 
     -v "${NEKO_BASE_PATH}/logs:/app/logs" 
     --network neko-network 
     docker.gh-proxy.org/ghcr.io/project-n-e-k-o/n.e.k.o:latest

   复制

关键配置

如何确认成功

浏览器访问 http://localhost:48911 能打开 Web UI（API Key 页为 /api_key），且 docker-compose logs -f 无报错。

常见问题

注意事项

• 容器内应用用户固定为 uid/gid 1000，neko-home/ 在宿主机上属主就是你，备份、编辑、删除都无需 sudo。
• 首次启动会自动生成有效期 1000 年的自签名证书，存放在挂载目录下的 ./neko-home/ssl/。
• README 建议优先在 Web UI 中配置 API 与服务商，环境变量中部分项可能无效。
• 若改用源码本地安装，需 Node.js >= 20.19 构建前端，并用 uv sync 安装依赖后启动 main_server 与 memory_server。