hf-framework / AGENTS.md
airsltd's picture
添加 Git 远程仓库配置说明
c375a0a
# AGENTS.md
## 项目概述
基于 Hugging Face Space 部署的模块化服务框架,通过 Caddy 实现路由反向代理。
## 技术栈
- **基础镜像**: Ubuntu 22.04
- **路由层**: Caddy 2
- **运行端口**: 7860 (Hugging Face Space 默认端口)
- **部署方式**: 单容器 Docker (HF Space Docker)
- **进程通信**: 容器内 localhost
## 核心文件
- `Dockerfile` — 单容器构建(Ubuntu → 安装 Caddy → 运行各模块 install.sh → CMD)
- `start.sh` — 入口脚本(遍历 /modules/*/start.sh 后台启动,最后 exec Caddy 前台运行)
- `caddy/Caddyfile` — Caddy 路由配置(反向代理到 localhost:PORT)
## 模块规范
- 每个模块在 `modules/` 下独立目录
- `install.sh` — 构建时安装依赖(apt/pip/npm 等),可选
- `start.sh` — 进程启动入口,必需
- `requirements.txt` — Python 模块依赖,可选(由 install.sh 自行处理)
- Caddy 路由在 `caddy/Caddyfile` 中手动配置
## 常用命令
```bash
docker build -t hf-framework .
docker run -p 7860:7860 hf-framework
```
## Git Remote
- 标准: `git@hf.co:spaces/airsltd/hf-framework`
- Airsltd 账号推送: `git@hf.co-airsltd:spaces/airsltd/hf-framework`
(需要在 ~/.ssh/config 中配置 hf.co-airsltd 主机别名)