upptime/README.md

Upptime (https://upptime.js.org) is the open-source uptime monitor and status page, powered entirely by GitHub Actions and Issues. It's made with 💚 by your friends at Koj.

📈 Live Status: 🟧 Partial outage

URL	Status	History	Response Time	Uptime
Google	🟩 Up	google.yml	87ms	100.00%
Wikipedia	🟩 Up	wikipedia.yml	147ms	100.00%
Hacker News	🟩 Up	hacker-news.yml	414ms	100.00%
Broken Site	🟥 Down	broken-site.yml	0ms	0.00%
Test for HEAD	🟩 Up	test-for-head.yml	20ms	100.00%
Secret Site	🟩 Up	secret-site.yml	38ms	100.00%

This README is also available in 🇧🇷 Brazilian Portuguese

⭐ How it works

• GitHub Actions is used as an uptime monitor
  • Every 5 minutes, a workflow visits your website to make sure it's up
  • Response time is recorded every 6 hours and committed to git
  • Graphs of response time are generated every day
• GitHub Issues are used for incident reports
  • An issue is opened if an endpoint is down
  • People from your team are assigned to the issue
  • Incidents reports are posted as issue comments
  • Issues are locked so non-members cannot comment on them
  • Issues are closed automatically when your site comes back up
  • Slack notifications are sent on updates
• GitHub Pages are used for the status website
  • A simple, beautiful, and accessible PWA is generated
  • Built with Svelte and Sapper
  • Fetches data from this repository using the GitHub API

Upptime is not affiliated to or endorsed by GitHub.

💝 Who's using Upptime

👩‍💻 Documentation

1. How it works
2. Getting started
3. Configuration
4. Triggers
5. Notifications
6. Badges
7. Packages
8. Contributing
9. Frequently Asked Questions

Concepts

Issues as incidents

When the GitHub Actions workflow detects that one of your URLs is down, it automatically opens a GitHub issue (example issue #15). You can add incident reports to this issue by adding comments. When your site comes back up, the issue will be closed automatically as well.

Commits for response time

Four times per day, another workflow runs and records the response time of your websites. This data is commited to GitHub, so it's available in the commit history of each file (example commit history). Then, the GitHub API is used to graph the response time history of each endpoint and to track when a site went down.

📄 License

• Code: MIT © Koj
• Data in the ./history directory: Open Database License

_{An open source project by Koj.
Furnish your home in style, for as low as CHF175/month →}