| # Grok2API Hugging Face Spaces 部署包 |
|
|
| ## ✅ 配置文件已全部创建完成！ |
|
|
| **创建时间**: 2026-06-07 |
| **适配版本**: grok2api v2.0.4 |
| **Python 版本**: 3.11 |
| **SDK 类型**: Docker |
|
|
| --- |
|
|
| ## 📦 包含内容 |
|
|
| ### 配置文件（24 个） |
| ✅ 核心配置、启动脚本、文档、保活项目全部完成 |
|
|
| ### 缺少内容 |
| ⚠️ **需要手动获取 `app/` 目录**（源代码） |
|
|
| --- |
|
|
| ## 🚀 立即开始 |
|
|
| ### 第一步：获取源代码 |
|
|
| **Windows 用户（推荐使用 Git Bash）：** |
| ```bash |
| bash get_source.sh |
| ``` |
|
|
| **Linux/Mac 用户：** |
| ```bash |
| chmod +x get_source.sh |
| ./get_source.sh |
| ``` |
|
|
| **手动方式：** |
| ```bash |
| git clone https://github.com/chenyme/grok2api.git temp |
| cp -r temp/app ./ |
| rm -rf temp |
| ``` |
|
|
| ### 第二步：创建 Hugging Face Space |
|
|
| 1. 访问：https://huggingface.co/new-space |
| 2. 设置： |
| - **Space name**: grok2api（或自定义） |
| - **License**: MIT |
| - **SDK**: **Docker** ⚠️ 必须选择 Docker！ |
| - **Hardware**: CPU basic（免费） |
| 3. 点击 "Create Space" |
|
|
| ### 第三步：推送代码 |
|
|
| ```bash |
| # 初始化 git（如需要） |
| git init |
| git add . |
| git commit -m "Initial deployment" |
| |
| # 添加远程仓库（替换为你的 Space） |
| git remote add hf https://huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE |
| |
| # 推送 |
| git push hf main |
| ``` |
|
|
| ### 第四步：配置环境变量 |
|
|
| 在 Space Settings → Variables 中添加： |
|
|
| ```bash |
| APP_KEY=your_strong_password |
| API_KEY=sk-your-custom-api-key |
| APP_URL=https://YOUR_USERNAME-YOUR_SPACE.hf.space |
| DATA_DIR=/data |
| ACCOUNT_STORAGE=local |
| ``` |
|
|
| ### 第五步：启用 Persistent Storage |
|
|
| ⚠️ **非常重要！** 在 Space Settings 中启用 |
|
|
| ### 第六步：配置保活 |
|
|
| 1. 创建新的 GitHub 仓库或 Fork https://github.com/wankuzidi/hf-keepalive |
| 2. 上传 `keepalive/` 目录内容 |
| 3. 在仓库 Settings 中配置： |
| - Variables: `HF_SPACES=https://YOUR_SPACE.hf.space` |
| 4. 启用 GitHub Actions |
|
|
| --- |
|
|
| ## 📚 文档导航 |
|
|
| | 文档 | 说明 | |
| |------|------| |
| | [START_HERE.md](./START_HERE.md) | **本文件** - 快速开始 | |
| | [SUMMARY.md](./SUMMARY.md) | 配置文件总结 | |
| | [CHECKLIST.md](./CHECKLIST.md) | 部署检查清单 | |
| | [QUICKSTART.md](./QUICKSTART.md) | 快速部署指南 | |
| | [DEPLOY_GUIDE.md](./DEPLOY_GUIDE.md) | 详细部署教程 | |
| | [PROJECT_INFO.md](./PROJECT_INFO.md) | 项目完整信息 | |
| | [keepalive/README.md](./keepalive/README.md) | 保活配置说明 | |
|
|
| --- |
|
|
| ## ⚡ 关键要点 |
|
|
| ### ✅ 必须做的事 |
| 1. ✅ 获取源代码（`app/` 目录） |
| 2. ✅ 选择 **Docker SDK** |
| 3. ✅ 配置 5 个必需环境变量 |
| 4. ✅ 启用 **Persistent Storage** |
| 5. ✅ 配置保活项目 |
|
|
| ### ❌ 常见错误 |
| 1. ❌ 忘记获取源代码 |
| 2. ❌ 选错 SDK（不是 Docker） |
| 3. ❌ 未启用 Persistent Storage |
| 4. ❌ APP_URL 配置错误 |
| 5. ❌ 没有配置保活 |
| |
| --- |
| |
| ## 🎯 预期结果 |
| |
| 部署成功后，你将拥有： |
| |
| - ✅ 一个运行中的 Grok2API Space |
| - ✅ 兼容 OpenAI API 的接口 |
| - ✅ 管理后台（/admin） |
| - ✅ 持久化数据存储 |
| - ✅ 自动保活机制 |
| |
| API 地址：`https://YOUR_SPACE.hf.space/v1` |
|
|
| --- |
|
|
| ## 🆘 遇到问题？ |
|
|
| 1. **查看文档**：优先阅读 DEPLOY_GUIDE.md |
| 2. **检查清单**：对照 CHECKLIST.md 检查 |
| 3. **查看日志**：Space 的 Logs 标签 |
| 4. **原项目**：https://github.com/chenyme/grok2api/issues |
| |
| --- |
| |
| ## 📞 快速帮助 |
| |
| ### Space 无法启动 |
| → 检查 Logs，确认环境变量，确认有 `app/` 目录 |
| |
| ### 图片/视频 403 |
| → 必须正确设置 `APP_URL` |
|
|
| ### 数据丢失 |
| → 启用 Persistent Storage + 配置保活 |
|
|
| ### API 调用失败 |
| → 检查 API_KEY，确认账号已添加 |
| |
| --- |
| |
| ## 🔗 相关链接 |
| |
| - **原项目**: https://github.com/chenyme/grok2api |
| - **保活项目**: https://github.com/wankuzidi/hf-keepalive |
| - **创建 Space**: https://huggingface.co/new-space |
| - **HF 文档**: https://huggingface.co/docs/hub/spaces |
| |
| --- |
| |
| ## 🎉 准备就绪！ |
| |
| 所有配置文件已创建完成，现在： |
| |
| 1. 运行 `get_source.sh` 获取源代码 |
| 2. 按照上述步骤开始部署 |
| 3. 参考文档完成配置 |
|
|
| **祝部署顺利！** 🚀 |
|
|
| --- |
|
|
| **免责声明**: 本项目仅供学习交流使用，请遵守相关服务的使用条款。 |
|
|
