haocen/statuspage

Statuspage

这是一个可免费在GitHub上托管状态页面的生成器，利用GitHub Issues展示事件并通过标签标识严重程度。

核心功能

• 支持多语言自动翻译（基于webL10n）
• 可添加/移除监控系统
• 支持自定义样式、logo和页脚
• 提供升级工具以更新到最新版本
• 通过GitHub API token实现授权操作

使用场景

• 个人或团队托管服务状态页面，向用户展示服务运行情况
• 记录和展示服务故障、维护等事件及其严重程度
• 无需额外服务器，直接利用GitHub Pages托管状态页面

配置说明

安装

通过pip安装：

bash
pip install statuspage

（也提供macOS和Linux的二进制文件，详见安装文档）

创建GitHub API Token

1. 进入https://github.com/settings/tokens
2. 点击“Generate new token”
3. 勾选public_repo和write:repo_hook权限
4. 复制生成的token（离开页面后无法再次查看）

生成状态页面

运行以下命令创建新状态页面：

bash
statuspage create --token=<你的token>

根据提示输入仓库名称和需要监控的系统（如Website, CDN, API）

更新状态页面

当Issues有变化（如添加标签、评论或关闭）时，运行以下命令更新页面：

bash
statuspage update --token=<你的token> --name=<仓库名称>

添加/移除系统

• 添加系统：

bash
statuspage add_system --token=<token> --name=<仓库名称> --system=<要添加的系统>

• 移除系统：

bash
statuspage remove_system --token=<token> --name=<仓库名称> --system=<要移除的系统>

升级页面

安装最新版本后，运行以下命令升级页面：

bash
pip install statuspage --upgrade
statuspage upgrade --token=<token> --name=<仓库名称>
statuspage update --token=<token> --name=<仓库名称>

多语言支持

生成的状态页面会根据访问者的首选语言自动翻译，支持en、de、nl、pt、es、ru、fr、pl等语言。

自定义

如需修改样式、logo或页脚，详见自定义文档。

其他选项

如需为组织或私有仓库创建状态页面，详见选项文档。