第一步:检查 Windows 版本与硬件要求
WSL 2 及systemd的支持需要特定的 Windows 系统版本。
- 按下
Win + R键,输入winver并回车。 - 确认系统版本:Windows 11 所有版本均支持;Windows 10 需为 Build 19041(2020年5月更新)或更高版本。(版本低会有不能使用wsl2、不能配置wsl网络桥接问题)
- 确认硬件支持虚拟化:在 BIOS 中确保已启用 Intel VT-x 或 AMD-V 选项。
第二步:安装 Node.js 20+
FreeLLMAPI 基于 Node.js 构建,要求版本在 20 以上。在 WSL 终端中执行以下命令安装 Node.js 22:
sudoaptupdatesudoaptinstall-ycurlcurl-fsSLhttps://deb.nodesource.com/setup_22.x|sudo-Ebash-sudoaptinstall-ynodejs安装完成后,验证版本:node -v和npm -v。
第三步:克隆项目与安装依赖
在 WSL 中拉取代码并安装项目所需的依赖包:
gitclone https://github.com/tashfeenahmed/freellmapi.gitcdfreellmapinpminstallnpmrun build第四步:生成加密密钥与环境配置
- 复制环境变量模板文件:
cp.env.example .env - 生成一个随机的十六进制加密密钥,并追加到
.env文件中:echo"ENCRYPTION_KEY=$(node-e"console.log(require('crypto').randomBytes(32).toString('hex'))")">>.env
第五步:启用 systemd 并配置服务后台运行(可选)
如果您希望通过systemctl命令将 FreeLLMAPI 配置为开机自启和后台常驻运行,需先在 WSL 中启用systemd(需 Windows 10 Build 19041+ 或 Windows 11):
- 在 WSL 中编辑配置文件:
sudo vi \etc\systemd\system。 - 添加以下配置:
Description=FreeLLMAPI Self-hosted AI Gateway After=network.target [Service] Type=simple # 替换为你的实际项目安装路径 WorkingDirectory=/root/freellmapi # 确保使用 Node.js 20+ 环境 ExecStart=/usr/bin/node server/dist/index.js Restart=on-failure RestartSec=10 # 设置环境变量(systemd 不会自动加载 .env 文件,需手动指定) EnvironmentFile=/root/freellmapi/.env [Install] WantedBy=multi-user.target - 保存退出
- 重载服务
sudosystemctl daemon-reloadsudosystemctl restart freellmapi - 验证FreeLLMApi启动
sudo journalctl -u freellmapi -f
第六步:在 Windows 浏览器中访问
在 Windows 宿主机上打开浏览器,访问以下地址:
- 前端管理面板:
http://localhost:3001(如果无法访问,请尝试使用 WSL 的 IP 地址,如http://<WSL_IP>:3001,可通过ip addr命令获取)。
第七步:配置秘钥与路由策略
首次访问管理面板时,创建一个管理员账号。
在密钥页面添加各平台的免费 API Key(如 Groq、Mistral、智谱 Z.ai 等)。
1. 官方密钥
2. 自定义密钥在模型页面配置路由策略。
复制页面顶部的统一 API Key(格式为
freellmapi-...),用于后续代码调用。
常见问题与提示
- 端口被占用:如果 3001 端口在 Windows 上被占用,可以在 WSL 中修改配置文件更换端口。
- 项目构建失败: 由于wsl缺少构建工具,需要执行命令
sudo apt update && apt install -y build-essential make python3