# pardnchiu/go-web-monitor

> Go terminal website monitor by Pardn Chiu (邱敬幃): HEAD-first uptime checks, SSL certificate expiry countdown, and email alerts after 5 failures.

Maintained by 邱敬幃 Pardn Chiu (pardnchiu), Pardn Co., Ltd, Taiwan · Infrastructure Engineering. Source: https://github.com/pardnchiu/go-web-monitor

Full text in one file: [English](https://go-web-monitor.pardn.io/llms-full.txt) · [中文](https://go-web-monitor.pardn.io/zh/llms-full.txt)

## Overview

- [Home](https://go-web-monitor.pardn.io/index.md): Go terminal website monitor by Pardn Chiu (邱敬幃): HEAD-first uptime checks, SSL certificate expiry countdown, and email alerts after 5 failures.
- [Getting Started](https://go-web-monitor.pardn.io/getting-started.md): Install go-web-monitor from source with Go 1.21+, start the TUI, and add your first monitored website in under a minute.

## Concepts

- [Architecture](https://go-web-monitor.pardn.io/architecture.md): One-diagram overview of go-web-monitor: the cmd/tui entry, Monitor core, tview UI, SMTP mailer, util helpers, and JSON store.
- [Monitoring Cycle](https://go-web-monitor.pardn.io/monitoring-cycle.md): When go-web-monitor checks sites: startup, one-minute ticker, refresh, and add; concurrent goroutines and JSON write-back.
- [HTTP Probing](https://go-web-monitor.pardn.io/probing.md): How go-web-monitor probes a URL: https:// normalization, HEAD then GET on error or 404, 10-second timeout, and 200–399 online rule.
- [SSL Expiry](https://go-web-monitor.pardn.io/ssl-expiry.md): How go-web-monitor reads the leaf certificate on port 443, computes days to expiry, colors 30/7-day thresholds, and when it shows N/A.
- [Alert Rules](https://go-web-monitor.pardn.io/alerting.md): Offline alert rules in go-web-monitor: per-site failure counter, one email per 5 consecutive failures, alert content, and send conditions.

## Email

- [Email Alert Setup](https://go-web-monitor.pardn.io/smtp-setup.md): Configure go-web-monitor email alerts with smtp commands: host, port, credentials, recipients, test email, CC, and disabling alerts.
- [SMTP Connection](https://go-web-monitor.pardn.io/smtp-connection.md): How go-web-monitor connects to SMTP: 5-second TCP probe, implicit TLS on 465, STARTTLS on 587, PLAIN auth, and message headers.

## Reference

- [CLI Reference](https://go-web-monitor.pardn.io/cli-reference.md): Every go-web-monitor TUI command and key binding: add, del, smtp keys, test, refresh, back, quit, Esc, and Ctrl+C.
- [Config File](https://go-web-monitor.pardn.io/configuration.md): Field-by-field reference for .webMonitor.json: watch list snapshot, SMTP config defaults, file location, and safe manual edits.
- [Dashboard](https://go-web-monitor.pardn.io/dashboard.md): go-web-monitor TUI layout: Monitor table columns and colors, System panel uptime and counts, and when each area redraws.
- [Known Limitations](https://go-web-monitor.pardn.io/known-limitations.md): Confirmed limits in go-web-monitor: URL normalization on restart, SSL N/A cases, CC delivery, error display, and map races.

## 中文文件

- [首頁](https://go-web-monitor.pardn.io/zh/index.md): 邱敬幃（Pardn Chiu）開發的 Go 終端機網站監控工具：HEAD 優先探測、SSL 憑證到期倒數，連續 5 次離線寄出 Email 通知。
- [快速開始](https://go-web-monitor.pardn.io/zh/getting-started.md): 以 Go 1.21 從原始碼安裝 go-web-monitor、啟動 TUI，並新增第一個監控網站。
- [架構](https://go-web-monitor.pardn.io/zh/architecture.md): go-web-monitor 單張架構概覽：cmd/tui 入口、Monitor 核心、tview 介面、SMTP 寄信、util 工具與 JSON 儲存。
- [監控週期](https://go-web-monitor.pardn.io/zh/monitoring-cycle.md): go-web-monitor 的檢查時機：啟動、每分鐘、refresh 與 add；每站一個 goroutine 並行檢查並寫回 JSON。
- [HTTP 探測](https://go-web-monitor.pardn.io/zh/probing.md): go-web-monitor 如何探測網址：補 https://、HEAD 失敗或 404 改送 GET、10 秒逾時與 200–399 上線判定。
- [SSL 憑證到期](https://go-web-monitor.pardn.io/zh/ssl-expiry.md): go-web-monitor 如何讀取 443 埠葉憑證計算到期天數、30／7 天顏色門檻，以及顯示 N/A 的情況。
- [告警規則](https://go-web-monitor.pardn.io/zh/alerting.md): go-web-monitor 離線告警規則：每站失敗計數、連續 5 次離線寄一封 Email、告警信內容與寄送條件。
- [設定 Email 告警](https://go-web-monitor.pardn.io/zh/smtp-setup.md): 以 smtp 指令設定 go-web-monitor 的 Email 通知：主機、port、帳密、收件者、測試信、CC 與停用。
- [SMTP 連線](https://go-web-monitor.pardn.io/zh/smtp-connection.md): go-web-monitor 的 SMTP 連線方式：5 秒 TCP 探測、465 隱式 TLS、587 STARTTLS、PLAIN 認證與信件標頭。
- [命令列參考](https://go-web-monitor.pardn.io/zh/cli-reference.md): go-web-monitor 全部 TUI 指令與快捷鍵：add、del、smtp 設定鍵、test、refresh、quit 與 Ctrl+C。
- [設定檔](https://go-web-monitor.pardn.io/zh/configuration.md): .webMonitor.json 逐欄說明：監控清單快照、SMTP 預設值、檔案位置與安全的手動編輯方式。
- [監控面板](https://go-web-monitor.pardn.io/zh/dashboard.md): go-web-monitor TUI 版面：Monitor 表格欄位與顏色、System 面板可用率與統計，以及各區塊重繪時機。
- [已知限制](https://go-web-monitor.pardn.io/zh/known-limitations.md): go-web-monitor 已確認的限制：重啟後網址格式、SSL 顯示 N/A、CC 收不到信、錯誤顯示與 map 競態。

## Optional

- [Release Notes](https://go-web-monitor.pardn.io/released/index.md): pardnchiu/go-web-monitor changelog by version