快速开始
欢迎使用 Realm API！本指南将帮助您快速上手这个强大的大模型网关系统。
🚀 什么是 Realm API？
Realm API 是一个新一代的大模型网关与AI资产管理系统，提供：
- 🔄 统一接口 - 标准化的 API 格式，支持多种模型协议
- 🎨 现代化界面 - 基于 React + Semi UI 的管理界面
- 🔒 安全可靠 - 完善的权限管理和认证机制
- 💰 灵活计费 - 支持多种计费模式和成本控制
- 📊 数据统计 - 详细的使用分析和监控报表
📋 系统要求
在开始之前，请确保您的环境满足以下要求：
最低要求
- 操作系统: Linux / macOS / Windows
- 内存: 2GB RAM
- 存储: 1GB 可用空间
- 网络: 稳定的互联网连接
推荐配置
- 操作系统: Ubuntu 20.04+ / CentOS 8+
- 内存: 4GB+ RAM
- 存储: 10GB+ SSD
- CPU: 2核心以上
数据库支持
- 本地: SQLite（默认）
- 远程: MySQL 5.7.8+ / PostgreSQL 9.6+
🎯 5分钟快速部署
方式一：Docker Compose（推荐）
bash
# 1. 克隆项目
git clone https://github.com/QuantumNous/new-api.git
cd new-api
# 2. 启动服务
docker-compose up -d
# 3. 访问系统
# 浏览器打开: http://localhost:3000方式二：Docker 命令
bash
# 使用 SQLite（默认）
docker run --name new-api -d --restart always \
-p 3000:3000 \
-e TZ=Asia/Shanghai \
-v ./data:/data \
calciumion/new-api:latest
# 使用 MySQL
docker run --name new-api -d --restart always \
-p 3000:3000 \
-e SQL_DSN="root:123456@tcp(localhost:3306)/newapi" \
-e TZ=Asia/Shanghai \
-v ./data:/data \
calciumion/new-api:latest🔧 初始配置
1. 访问管理界面
部署完成后，在浏览器中访问 http://localhost:3000。
2. 创建管理员账户
首次访问时，系统会引导您创建管理员账户：
- 输入用户名和密码
- 设置邮箱地址
- 完成注册流程
3. 配置基础设置
登录后，进入 设置 > 运营设置 进行基础配置：
yaml
# 系统名称
SystemName: "Realm API"
# 默认模型
DefaultModel: "gpt-3.5-turbo"
# 注册模式
RegisterEnabled: true
# 充值功能
TopupEnabled: true🎯 第一个 API 调用
1. 创建 API Token
- 进入 控制台 > Token 管理
- 点击 创建新的 Token
- 设置 Token 名称和过期时间
- 复制生成的 Token
2. 配置模型渠道
- 进入 控制台 > 渠道管理
- 点击 添加渠道
- 选择模型类型（如 OpenAI）
- 填写 API 密钥和其他配置
- 启用渠道
3. 测试 API 调用
使用 curl 测试您的第一个 API 调用：
bash
curl -X POST "http://localhost:3000/api/chat/completions" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-3.5-turbo",
"messages": [
{"role": "user", "content": "Hello, Realm API!"}
]
}'📚 下一步
恭喜！您已经成功部署并配置了 New API。接下来您可以：
❓ 常见问题
Q: 如何修改端口？
A: 通过环境变量 PORT 修改，或在 docker-compose.yml 中调整端口映射。
Q: 如何备份数据？
A: 定期备份 data 目录（SQLite）或数据库（MySQL/PostgreSQL）。
Q: 如何更新版本？
A: 拉取最新镜像并重新启动容器：
bash
docker-compose pull
docker-compose up -dQ: 如何查看日志？
A: 使用 docker-compose logs -f new-api 查看实时日志。
🤝 获取帮助
如果您在使用过程中遇到问题：
- 📋 查看常见问题
- 💬 GitHub Discussions
- 🐛 报告问题
- 📖 完整文档
💡 提示: 建议在生产环境中使用 MySQL 或 PostgreSQL 数据库，并配置 Redis 缓存以获得更好的性能。