llmgateway

环境要求

• 已安装 Docker（自托管部署必需）
• 已安装 openssl，用于生成随机密钥
• 本地开发需安装 pnpm 与 Node.js 环境
• WSL2 用户需确保 Docker Desktop 已开启 WSL 集成

安装与启动步骤

1. 1生成网关密钥

   用 openssl 生成两个随机密钥并导出为环境变量，供后续容器启动时注入使用。

   export LLM_GATEWAY_SECRET="$(openssl rand -base64 32 | tr -d '
   ')"
   export GATEWAY_API_KEY_HASH_SECRET="$(openssl rand -base64 32 | tr -d '
   ')"

   复制

2. 2运行一键启动脚本

   README 推荐方式，脚本位于仓库 scripts 目录，会拉起一体化镜像所需的全部服务。

   ./scripts/run-unified-container.sh

   复制

3. 3或手动 docker run

   不想用脚本时，先创建两个命名卷，再启动容器并把密钥通过 -e 传入，务必使用命名卷。

   docker volume create llmgateway_postgres
   docker volume create llmgateway_redis
   
   docker run -d 
     --name llmgateway 
     --restart unless-stopped 
     -p 3002:3002 
     -p 3003:3003 
     -p 3005:3005 
     -p 3006:3006 
     -p 3007:3007 
     -p 4001:4001 
     -p 4002:4002 
     -v llmgateway_postgres:/var/lib/postgresql/data 
     -v llmgateway_redis:/var/lib/redis 
     -e AUTH_SECRET="$LLM_GATEWAY_SECRET" 
     -e GATEWAY_API_KEY_HASH_SECRET="$GATEWAY_API_KEY_HASH_SECRET" 
     ghcr.io/theopenco/llmgateway-unified:latest

   复制

4. 4安装依赖并初始化

   本地开发方式：pnpm i 安装依赖，pnpm run setup 会启动 Docker 服务、同步数据库结构并写入种子数据。

   pnpm i && pnpm run setup

   复制

5. 5启动开发服务器

   在仓库根目录执行，启动本地开发用服务，改代码后可直接调试。

   pnpm dev

   复制

6. 6构建生产版本

   部署到生产环境前执行构建，产出可运行的生产包。

   pnpm build

   复制

关键配置

如何确认成功

执行 docker ps 确认 llmgateway 容器处于运行状态，再访问本机映射端口（如 http://localhost:3002）打开界面。

常见问题

注意事项

• 统一镜像必须使用 Docker 管理的卷，禁止把宿主机目录直接绑定挂载到 /var/lib/postgresql/data。
• 容器默认暴露 3002、3003、3005、3006、3007、4001、4002 端口，注意宿主机端口是否被占用。
• 本地开发依赖 pnpm，README 未给出 npm/yarn 的替代用法。
• README 中托管版本与自托管版本二选一，托管版只需在 llmgateway.io 注册获取 API Key。