TinyStatus安装与配置指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00392/article/details/146801300

TinyStatus安装与配置指南

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

1. 项目基础介绍

TinyStatus 是一个简单且可定制的状态页生成器，允许用户监控不同服务的状态，并将它们显示在一个简洁、响应式的网页上。这个项目是用 Python 编写的，适合需要监控服务状态的站长或开发者。

2. 项目使用的关键技术和框架

Python 3.x: TinyStatus 使用 Python 3.x 版本进行开发，这是一种广泛使用的编程语言，拥有强大的社区支持和丰富的库。
YAML: 项目使用 YAML 格式来配置服务检查，这是一种直观的数据序列化格式，易于阅读和编辑。
HTML/CSS: 生成状态页和状态历史页面使用 HTML 和 CSS，保证了页面的显示效果和响应式设计。

3. 安装和配置准备工作

在开始安装之前，请确保您的系统中已经安装了以下软件：

Python 3.11 或更高版本
pip（Python 包管理器）

如果没有安装，您可以通过以下命令安装 Python 和 pip：

sudo apt update
sudo apt install python3 python3-pip

注意：请根据您的操作系统选择合适的安装命令。

详细的安装步骤

克隆仓库或下载源代码：

使用 Git 命令克隆仓库到本地：
```
git clone https://github.com/harsxv/tinystatus.git
```
或者直接从 GitHub 下载源代码压缩包。
安装依赖：

进入项目目录，然后使用 pip 安装项目所需的依赖：
```
cd tinystatus
pip3 install -r requirements.txt
```

配置环境：

在项目根目录下创建一个 .env 文件，并自定义以下变量：

MONITOR_CONTINOUSLY=True
CHECK_INTERVAL=30
MAX_HISTORY_ENTRIES=100
LOG_LEVEL=INFO
CHECKS_FILE=checks.yaml
INCIDENTS_FILE=incidents.md
TEMPLATE_FILE=index.html.theme
HISTORY_TEMPLATE_FILE=history.html.theme
STATUS_HISTORY_FILE=history.json
HTML_OUTPUT_DIRECTORY=/var/www/htdocs/status/

根据您的需求调整这些变量。

配置服务检查：

编辑 checks.yaml 文件，添加或修改您想要监控的服务。

例如：

- title: "Group 1"
  checks:
    - name: "GitHub Home"
      type: "http"
      host: "https://github.com"
      url: "https://docs.github.com/en"
      expected_code: 200

可选：自定义外观：

如果需要，您可以修改 index.html.theme 和 history.html.theme 中的 CSS，来自定义状态页的外观。
运行 TinyStatus 脚本：

运行以下命令来生成状态页和相关文件：
```
python3 tinystatus.py
```
脚本会生成 index.html（主状态页）、history.html（状态历史页）和 history.json（状态历史和时间戳数据）。
持续更新状态页：

为了让状态页持续更新，您可以将脚本在后台运行：
- 在类 Unix 系统（Linux、macOS）上：
```
nohup python3 tinystatus.py &
```
- 在 Windows 上，您可以使用任务计划程序来在启动时运行脚本。
部署状态页：

使用您偏好的网页服务器（如 Apache、NGINX，或简单的 Python HTTP 服务器用于测试）来服务生成的 HTML 文件。