---
title: Sub
emoji: "🏃"
colorFrom: red
colorTo: gray
sdk: docker
pinned: false
app_port: 7860
---

# Sub2API 在 Hugging Face Spaces（Docker）

此目录用于在 Hugging Face Spaces 以 Docker 方式运行 Sub2API。

## 使用方式
1. 在 Space 设置中选择 `Docker`。
2. Space 只读取仓库根目录的 `README.md` 与 `Dockerfile`，如需直接用于 Space，请将本目录的文件放到根目录。
3. 在 Space 的 `Settings -> Variables/Secrets` 中填写下方环境变量。
4. Space 会自动注入 `PORT`，脚本会直接使用。

## 必填环境变量（无默认值）
- DATABASE_URL
- REDIS_URL

## 环境变量示例
- `DATABASE_URL=postgresql://USER:PASSWORD@HOST:PORT/DBNAME?sslmode=require&channel_binding=require`
- `REDIS_URL=rediss://:PASSWORD@HOST:PORT/0`

## 脚本行为
- 启动脚本会把 `DATABASE_URL` / `REDIS_URL` 解析为应用实际需要的 `DATABASE_*` / `REDIS_*` 变量。
- 不要在 HF 变量里加引号（否则解析会失败）。

## 建议配置（无默认值）
- JWT_SECRET
- TOTP_ENCRYPTION_KEY
- ADMIN_EMAIL
- ADMIN_PASSWORD

## 可选环境变量（含默认值）
- PORT=7860
- SERVER_HOST=0.0.0.0
- SERVER_PORT=7860
- SERVER_MODE=release
- RUN_MODE=standard
- AUTO_SETUP=true
- TZ=Asia/Shanghai
- DATA_DIR=/tmp/sub2api

## 说明
- Hugging Face Docker Space 默认端口是 7860，可通过 `app_port` 覆盖。([huggingface.co](https://huggingface.co/docs/hub/spaces-sdks-docker?utm_source=openai))
- 空间里通常需要把可写目录放在 `/tmp`；如启用持久化存储，可使用 `/data`。([huggingface.co](https://huggingface.co/docs/hub/spaces-storage?utm_source=openai))([discuss.huggingface.co](https://discuss.huggingface.co/t/permission-denied-for-writing-files-within-spaces/29799?utm_source=openai))
- 应用侧实际使用 `DATABASE_*` / `REDIS_*` 变量（见官方 compose 示例）。([github.com](https://github.com/Wei-Shaw/sub2api/blob/main/docker-compose.yml?utm_source=openai))