README.md

metadata

title: Grok2API
emoji: 🛰️
colorFrom: gray
colorTo: blue
sdk: docker
app_port: 7860
pinned: false
license: mit

Grok2API on Hugging Face Spaces

个人用 Docker Space 部署（v3.0.7，已适配 HF 端口与 Secrets）。

仅供个人学习研究。请遵守 Grok 使用条款与当地法律；不要把管理员密码、API Key、账号凭据写进公开 README。

快速开始

1. Space SDK 选 Docker，建议 Private
2. 用本仓库 scripts/push-to-hf.ps1 推送（会排除大图与嵌套目录）
3. Settings → Secrets 配置：

Secret	必须	说明
BOOTSTRAP_ADMIN_PASSWORD	是	管理端初始密码
JWT_SECRET	强烈建议	≥32 字符；与现网一致可解密旧会话
CREDENTIAL_ENCRYPTION_KEY	强烈建议	Base64 32 字节；写入账号后不要改

4. 等待 Building → Running
5. 打开 https://<user>-<space>.hf.space，用 admin + 密码登录

数据持久化

• 尽量开启 Persistent Storage，挂载到 /data
• 入口脚本会自动把 SQLite / 媒体写到 /data（无盘时回退 /app/data）
• 监听：HF 注入 PORT 时用 0.0.0.0:$PORT，否则 HF 环境默认 7860

环境变量（可选）

变量	默认	作用
BOOTSTRAP_ADMIN_USERNAME	admin	初始管理员
PUBLIC_API_BASE_URL	https://$SPACE_HOST	公开 API 基址
GROK2API_DATA_DIR	/data 优先	数据根目录
SECURE_COOKIES	HF 下 true	Cookie Secure
SWAGGER_ENABLED	false	Swagger

完整说明见仓库内 docs/HUGGINGFACE.md / docs/HF_DEPLOY_手把手.md。

健康检查

/healthz

上游项目

基于 chenyme/grok2api v3.0.7，并保留本仓库的 HF 启动适配（环境变量生成配置、7860/PORT、/data）。