| --- |
| title: Grok2API HF Space |
| emoji: 🚀 |
| colorFrom: blue |
| colorTo: indigo |
| sdk: docker |
| app_port: 8000 |
| pinned: false |
| --- |
| |
| # Grok2API on Hugging Face Spaces |
|
|
| 这个目录是一套可直接放到 Hugging Face Docker Space 根目录的包装层。 |
|
|
| 它会在构建时拉取 `CountClaw/grok2api-hf` 主仓库，运行 `granian main:app`，并在启动前后同步 `data/**` 到 Hugging Face Dataset，方便保存 `config.toml`、`token.json` 等运行数据。 |
|
|
| ## 需要配置的 Secrets / Variables |
|
|
| - `HF_TOKEN`：可写入 Dataset 的 Hugging Face Token。不开启持久化时可不填。 |
| - `DATASET_ID`：用于持久化的 Dataset，例如 `your-name/grok2api-data`。请先在 Hugging Face 上创建好该 Dataset；不填则只使用 Space 本地临时磁盘。 |
| - `HF_SYNC_INTERVAL`：可选，数据回写间隔，单位秒，默认 `1800`。 |
|
|
| ## 部署说明 |
|
|
| 1. 新建一个 `Docker` 类型的 Hugging Face Space。 |
| 2. 把这个目录里的文件放到 Space 仓库根目录。 |
| 3. 如需改成你的代码仓库或分支，修改 `Dockerfile` 里的 `SOURCE_REPO` 和 `SOURCE_REF`。 |
| 4. 部署完成后访问 `/health` 检查服务，管理页可访问 `/admin`。 |
|
|
| ## 同步范围 |
|
|
| - 会同步：`data/**` |
| - 不会同步：`data/tmp/**`、`data/.locks/**`、日志和缓存临时文件 |
|
|
