Skip to content

deploy.md

Latest commit

 

History

History
201 lines (129 loc) · 6.22 KB

deploy.md

File metadata and controls

201 lines (129 loc) · 6.22 KB
Raw

部署

  1. 手动部署 (建议有自己的服务器 / 本地部署使用)
  2. Huggingface 部署 (无服务器推荐)
  3. Vercel 部署 (限制较多, 不推荐使用)
  4. 一键部署 (未测试, 不推荐使用)
  5. Docker 部署 (使用服务器部署推荐)

快速跳转

手动部署

本方式理论上全平台通用, 安装了 Python 3.10+ 即可

优点: 数据文件 (data/data.json) 可持久化，不会因为重启而被删除

安装

  1. Clone 本仓库 (也可先 Fork)
git clone --depth 1 -b main https://github.com/sleepy-project/sleepy.git
  1. 安装依赖
pip install -r requirements.txt

推荐使用 uv 管理环境:

uv sync
  1. 编辑配置文件

配置文件变化史
data.json
-> config.json
-> config.jsonc
-> 环境变量 & .env
-> config.yaml & 环境变量 & .env
-> 环境变量 & data/.env & data/config.yaml & data/config.toml & data/config.json

在 data 目录下新建上面几种配置文件中的一种，并按照 此处 的说明编辑配置

启动

Warning

使用宝塔面板 (uwsgi) 等部署时，请确定只为本程序分配了 1 个进程, 如设置多个服务进程可能导致数据不同步!!!

有两种启动方式:

# 直接启动
python3 main.py
# 简易启动器
python3 start.py

默认服务 http 端口: 9010

Huggingface 部署

适合没有服务器部署的同学使用
有服务器也推荐，不怕被打
唯一的缺点: 不能使用自定义域名
可用 Cloudflared Tunnel 方式使用自定义域名，见 如何使用自定义域名

只需三步:

  1. 复制 Space wyf9/sleepy (点击直达)

如果没有弹出窗口, 请手动点击右上角三点 -> Duplicate this Space (如图)

huggingface-5

  1. 在复制页面设置 secret 和页面信息等环境变量 (配置说明)
  2. 点击部署，等待完成后点击右上角三点 -> Embed this space，即可获得你的部署地址 (类似于: https://wyf9-sleepy.hf.space)

Important

在创建时请务必选择 Space 类型为公开 (Public)，否则无法获取部署地址 (他人无法访问)!
Hugging Face Space 如 48h 未访问将会休眠，建议使用定时请求平台 (如 cron-job.org, Uptime Kuma 等) 定时请求 (你的部署地址)/none

卡在 Deploying?

Tip

适用于日志中程序已经启动, 但部署状态仍然为 Deploying 的情况
对所有的 Hugging Face 仓库都有效

解决方法
  1. 点击右上角三点 -> Duplicate this Space，复制 Space 并填写好和之前一样的环境变量
  2. 在 Settings 页面底部 Delete this Space 处删除旧 Space
  3. 在 Settings -> Rename or transfer this space 将新 Space 重命名为旧 Space 的名称

如何使用自定义域名

Warning

在 HF Space 中使用 Cloudflared 可能会被封号, 请自行承担风险.

  1. 到 Zero Trust Dashboard 创建一个 Tunnel

随便填一个名字后进入 安装并运行连接器，复制 Token:

huggingface-2

进入 路由隧道，按如下图片配置并保存:

huggingface-3

  1. 编辑 Space 的 Dockerfile，将底部的 CMD python3 main.py 删除，并添加:
# Install wget
RUN apt install wget -y

# Download Cloudflared script
RUN wget -O cfd.sh https://gist.github.com/wyf9/71ff358636154ab00d90602c3c818763/raw/cfd.sh

# Start
CMD bash cfd.sh
  1. 新建两个环境变量 (Settings -> Variables and secrets):
  • CFD_COMMAND (Variable): python3 main.py
  • CFD_TOKEN: 你的 Cloudflare Tunnel 密钥

设置完成后如图:

huggingface-4

  1. 重新构建 Space (Factory rebuild) 即可

定时请求仍然需要使用 Huggingface 提供的子域
详见: Gist

Vercel 部署

可以使用自定义域名，但限制较多 (如无法使用 SSE, 请求数 / 请求完成时间有限制等)
当前端检测到为 Vercel 部署时会回退到轮询方式更新

  1. Fork 本项目
  2. 打开 vercel.com/new，并按照提示授权访问 GitHub (如未注册则注册)
  3. 选择你的 Fork，点击 Import

vercel-1

  1. 在导入界面设置环境变量 (其他配置保持默认)，点击 Deploy 部署 (配置文档)

vercel-2

即可完成部署，默认分配 vercel.app 域名

  1. [可选] 绑定自定义域名: Settings -> Domains

vercel-3

  1. [可选] 添加更多环境变量: Settings -> Environment Variables

vercel-4

修改环境变量后需重新部署

Docker 部署

Docker Compose

  1. 克隆本仓库
git clone --depth 1 -b main https://github.com/sleepy-project/sleepy.git ./sleepy

  1. 修改 docker-compose.yml 文件中的环境变量等配置

  2. 启动

docker-compose up -d