跳至主要內容

部署

SleepyProject2025/7/21大约 3 分钟

部署

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

快速跳转

手动部署

本方式理论上全平台通用, 安装了 Python >= 3.6 即可 (建议: 3.10+)

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

安装

  1. Clone 本仓库 (建议先 Fork / Use this template)
git clone --depth=1 -b main https://github.com/sleepy-project/sleepy.git
  1. 安装依赖
pip install -r requirements.txt
  1. 编辑配置文件

在项目目录创建 .env 文件:

sleepy_main_host = "0.0.0.0" # 监听地址
sleepy_main_port = "9010" # 端口号
sleepy_secret = "改成别人猜不出来的密钥" # 密钥，相当于密码
sleepy_page_user = "你的名字" # 将显示在网页中
sleepy_page_favicon = "./static/favicon.ico" # 网站图标, 可替换 static/favicon.ico 自定义 (也可以用其他格式的, 自己改路径)
sleepy_page_more_text = "欢迎来到我的状态页!" # 说两句? (也可以留空)
sleepy_page_using_first = true # 使用中设备优先显示

更多配置项详见 此处

启动

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

有两种启动方式:

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

默认服务 http 端口: 9010

Huggingface 部署

适合没有服务器部署的同学使用

有服务器也推荐，不怕被打

唯一的缺点: 不能使用自定义域名

只需三步:

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

重要

在创建时请务必选择 Space 类型为公开 (Public)，否则无法获取部署地址 (他人无法访问)!

Hugging Face Space 如 48h 未访问将会休眠，建议使用定时请求平台 (如 cron-job.org, Uptime Kuma 等) 定时请求 Space /none

卡在 Deploying?

提示

适用于日志中程序已经启动, 但部署状态仍然为 Deploying 的情况

对所有的 Hugging Face 仓库都有效

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

Vercel 部署

可以使用自定义域名，但限制较多 (如无法使用 SSE, 请求数 / 请求完成时间有限制等)

当前端检测到为 Vercel 部署时会回退到轮询方式更新

  1. Fork 本项目
  2. 打开 vercel.com/new，并按照提示授权访问 GitHub (如未注册则注册)
  3. 选择你的 Fork，点击 Import
vercel-1
vercel-1
  1. 在导入界面设置环境变量 (其他配置保持默认)，点击 Deploy 部署 [配置示例]
vercel-2
vercel-2

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

  1. [可选] 绑定自定义域名: Settings -> Domains
vercel-3
vercel-3
  1. [可选] 添加更多环境变量: Settings -> Environment Variables
vercel-4
vercel-4

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

一键部署 (未测试)

注意

完全由 AI 生成, 未经任何测试, 不要使用此方式!!!

Linux

运行命令：

bash <(curl -s https://ghproxy.com/https://raw.githubusercontent.com/sleepy-project/sleepy/main/scripts/install.sh)

如果你的服务器不在中国大陆，可以去掉 ghproxy.com/ 部分：

bash <(curl -s https://raw.githubusercontent.com/sleepy-project/sleepy/main/scripts/install.sh)

Windows

运行命令：

Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
irm https://ghproxy.com/https://raw.githubusercontent.com/sleepy-project/sleepy/main/scripts/install.ps1 | iex

如果你的服务器不在中国大陆，可以去掉 ghproxy.com/ 部分：

Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
irm https://raw.githubusercontent.com/sleepy-project/sleepy/main/scripts/install.ps1 | iex
Copyright © 2025 SleepyProject