Skip to content

docs: 主题可以填 GitHub 仓库地址安装，上传要选 theme.tar.gz 而不是 Source code #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stqfdyr merged 1 commit into from
Oct 2, 2026
Merged

docs: 主题可以填 GitHub 仓库地址安装，上传要选 theme.tar.gz 而不是 Source code #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions src/content/dev/theme.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
└── index.html
```

发布时打成 `theme.tar.gz`，解开就是这个目录。
发布时打成 `theme.tar.gz`，解开就是这个目录。放进 GitHub release 时文件名保持 `theme.tar.gz`：面板的
「从 GitHub 安装」和一键更新只认仓库最新正式 release（不含预发布和草稿）里这个名字的文件。

发布前用 `gzip -t` 检查一遍，没有输出就是完整的：

Expand All @@ -41,7 +42,7 @@ hub 1.3.0 及更早的版本不做这项检查，所以以前装得上的包，
| `url` | 是 | 源码地址。指向 GitHub 仓库时，面板的一键更新从它的 release 取 `theme.tar.gz` |
| `config` | 可不写 | 数组，站长可调的设置，面板按它画表单。见下文[主题设置](#主题设置) |

少写一个字段时，在面板上传会被拒绝，并指出缺的是哪个；直接放进 hub 的 `--themes` 目录的，主题不会
少写一个字段时，在面板安装会被拒绝，并指出缺的是哪个；直接放进 hub 的 `--themes` 目录的，主题不会
出现在列表里，hub 日志里有一条警告。

### 上限
Expand Down Expand Up @@ -428,16 +429,25 @@ agent 只有 Linux 版。在 macOS 上开发时节点会一直显示离线，要
[设置](#主题设置)的主题，卡片上多一个设置按钮，保存后公开页刷新即生效。设置存在 hub 的数据库里，
更新、重装、删掉再装回主题都不会丢，数据库备份里也有。

安装有两种方式：在面板上传 `theme.tar.gz`，或把主题目录直接放进 hub 的 `--themes` 目录（一键脚本部署是
`/opt/monitor/data/themes/`）。卡片上的「从 GitHub 更新」从 `theme.json` 里 `url` 指向的 GitHub 仓库取
最新 release，tag 与已装版本相同时不下载。
安装有三种方式：

- 在**主题**页填主题的 GitHub 仓库地址，点「从 GitHub 安装」，hub 下载它最新 release 里的 `theme.tar.gz`。
不用先把包下到自己电脑上，也就不会因为没下载完而装不上
- 在**主题**页上传下载好的 `theme.tar.gz`。要下 release 里名为 `theme.tar.gz` 的文件，不是 Source code
- 把主题目录直接放进 hub 的 `--themes` 目录（一键脚本部署是 `/opt/monitor/data/themes/`）

前两种都是同名主题整体替换。hub 访问不了 GitHub 时，「从 GitHub 安装」和下面的更新都需要在**设置**页填
GitHub 代理，见[hub 连不上 GitHub](/reference/faq#hub-连不上-github)；能访问时不用填。

卡片上的「从 GitHub 更新」从 `theme.json` 里 `url` 指向的 GitHub 仓库取最新 release，tag 与已装版本相同时
不下载。

内置默认主题同样可以就地更新，不用升级 hub：更新会把新版装进 `themes/default/`，此后使用磁盘上的这份，
卡片上的「内置」标记随之消失；删掉它就回到二进制里的那份。二进制里的默认主题删不掉也改不了，磁盘上的主题
出问题时总能回落到它。

<Note warn>
上传的主题是在访客浏览器里运行的第三方代码，和 hub 同源。安装时的检查只防止写到目录外和占满磁盘，
安装的主题是在访客浏览器里运行的第三方代码，和 hub 同源。安装时的检查只防止写到目录外和占满磁盘，
不检查里面的 JS。只装信得过的来源。
</Note>

Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

### hub 连不上 GitHub

hub 从 GitHub release 取 agent 二进制转发给节点，主题更新也从那里取。hub 所在机器访问不了 GitHub 时，
hub 从 GitHub release 取 agent 二进制转发给节点，主题的安装与更新也从那里取。hub 所在机器访问不了 GitHub 时，
在**设置**页的 **GitHub 代理**填一个镜像地址，节点侧不用改。

<Note warn>
Expand Down
Loading