TinyStatus 使用教程

TinyStatus 使用教程

tinystatus Tiny status page generated by a Python script 项目地址: https://gitcode.com/gh_mirrors/tin/tinystatus

1. 项目目录结构及介绍

TinyStatus 是一个简单且可定制的状态页生成器，它可以帮助你监控各种服务的状态，并在一个干净、响应式的网页上显示它们。以下是项目的目录结构及各部分的介绍：

tinystatus/
├── .github/                # GitHub 相关配置文件
├── assets/                 # 静态资源文件夹，如CSS、JavaScript和图片
├── .gitignore              # Git 忽略文件列表
├── Dockerfile              # Docker 容器配置文件
├── LICENSE                 # 项目许可证文件
├── README.md               # 项目自述文件
├── checks.yaml             # 服务检查配置文件
├── history.html.theme      # 状态历史页面的模板文件
├── incidents.md            # 已知事件或维护计划文件
├── index.html.theme        # 状态页面模板文件
├── requirements.txt        # 项目依赖文件
├── tinystatus.py           # TinyStatus 主程序

2. 项目的启动文件介绍

项目的启动文件是 tinystatus.py。这个 Python 脚本负责生成状态页面和状态历史页面，并可以配置为连续更新状态。以下是运行该脚本的一些基本命令：

# 运行 TinyStatus 脚本
python tinystatus.py

# 在后台连续运行 TinyStatus 脚本（适用于 Unix-like 系统）
nohup python tinystatus.py &

在 Windows 系统上，你可以使用任务计划程序来在启动时运行脚本。

3. 项目的配置文件介绍

项目的配置主要通过 .env 文件和环境变量来管理。以下是一些主要的配置项：

• MONITOR_CONTINUOUSLY: 布尔值，决定是否连续监控服务状态。
• CHECK_INTERVAL: 整数，定义检查服务状态的时间间隔（单位：秒）。
• MAX_HISTORY_ENTRIES: 整数，定义保存状态历史记录的最大条目数。
• LOG_LEVEL: 字符串，定义日志输出的详细程度（如 INFO, DEBUG 等）。
• CHECKS_FILE: 字符串，定义服务检查配置文件的路径。
• INCIDENTS_FILE: 字符串，定义事件文件的路径。
• TEMPLATE_FILE: 字符串，定义状态页面模板文件的路径。
• HISTORY_TEMPLATE_FILE: 字符串，定义状态历史页面模板文件的路径。
• STATUS_HISTORY_FILE: 字符串，定义状态历史数据文件的路径。
• HTML_OUTPUT_DIRECTORY: 字符串，定义生成 HTML 文件的输出目录。

此外，checks.yaml 文件用于定义要监控的服务及其检查类型（如 HTTP、ping、端口等），而 incidents.md 文件可以用来记录任何已知的事件或维护计划。你还可以通过编辑 index.html.theme 和 history.html.theme 文件来自定义状态页面和状态历史页面的外观。

tinystatus Tiny status page generated by a Python script 项目地址: https://gitcode.com/gh_mirrors/tin/tinystatus