Complete documentation for the Cloudflare Heartbeat Monitor.
- Quick Start Guide - Set up and deploy in 10 minutes
- Architecture Overview - System design, data flow, and component details
- Deployment Guide - GitHub Actions automated deployment
- Setup Checklist - Pre-deployment verification steps
- Terraform Guide - Infrastructure as code setup
- Contributing Guide - How to contribute to this project
- Workflows Documentation - CI/CD pipeline details
- Permissions Guide - GitHub Actions permissions explained
- Heartbeat Client Examples - Implementation guides for all platforms
- Bash, Python, Node.js
- Cron, systemd, Docker
- Main README - Project overview and features
- Cloudflare Workers Documentation
- Cloudflare KV Documentation
- Terraform Cloudflare Provider
📁 Project Structure
├── 📖 docs/ ← You are here
│ ├── QUICKSTART.md
│ ├── ARCHITECTURE.md
│ ├── DEPLOYMENT.md
│ ├── SETUP_CHECKLIST.md
│ └── PERMISSIONS.md
├── 🔧 .github/
│ ├── workflows/
│ ├── CONTRIBUTING.md
│ └── pull_request_template.md
├── 📦 examples/
│ ├── heartbeat-client.sh
│ ├── heartbeat-client.py
│ ├── heartbeat-client.js
│ └── systemd/
├── 🏗️ terraform/
│ ├── main.tf
│ └── README.md
└── 💻 src/
└── index.js
| Topic | Document |
|---|---|
| First time setup | Quick Start |
| Understanding the system | Architecture |
| Deploying to production | Deployment |
| Creating heartbeat clients | Examples |
| Infrastructure as code | Terraform |
| CI/CD workflows | Workflows |
| Contributing code | Contributing |
- Check the relevant documentation above
- Review the troubleshooting section in the Deployment Guide
- Look at example implementations
- Check GitHub issues
- Review Cloudflare Workers documentation