https://github.com/konishon/uptime

https://github.com/konishon/uptime

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/konishon/uptime
• Owner: konishon
• License: mit
• Created: 2022-11-03T11:21:40.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-11-03T11:21:50.000Z (over 2 years ago)
• Last Synced: 2025-01-15T10:38:47.941Z (5 months ago)
• Language: Markdown
• Size: 566 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: history/LICENSE
  • License: LICENSE

Awesome Lists containing this project

README

        
# [![Upptime](https://raw.githubusercontent.com/upptime/upptime.js.org/master/static/img/logo.svg)](https://upptime.js.org)

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

> I find Upptime an incredible clever usage of \[GitHub Actions]. You essentially get a free configurable uptime monitor for whatever you want. – [CSS Tricks](https://css-tricks.com/upptime/)

Upptime is used by [**1,000+**](https://github.com/topics/upptime) people and teams to ensure they know when their endpoints go down.

[![Uptime CI](https://github.com/upptime/upptime/workflows/Uptime%20CI/badge.svg)](https://github.com/upptime/upptime/actions?query=workflow%3A%22Uptime+CI%22)

[![Response Time CI](https://github.com/upptime/upptime/workflows/Response%20Time%20CI/badge.svg)](https://github.com/upptime/upptime/actions?query=workflow%3A%22Response+Time+CI%22)

[![Graphs CI](https://github.com/upptime/upptime/workflows/Graphs%20CI/badge.svg)](https://github.com/upptime/upptime/actions?query=workflow%3A%22Graphs+CI%22)

[![Static Site CI](https://github.com/upptime/upptime/workflows/Static%20Site%20CI/badge.svg)](https://github.com/upptime/upptime/actions?query=workflow%3A%22Static+Site+CI%22)

[![Summary CI](https://github.com/upptime/upptime/workflows/Summary%20CI/badge.svg)](https://github.com/upptime/upptime/actions?query=workflow%3A%22Summary+CI%22)

## [📈 Live Status](https://demo.upptime.js.org):  **🟧 Partial outage**

| URL | Status | History | Response Time | Uptime |

| --- | ------ | ------- | ------------- | ------ |

|  [Google](https://www.google.com) | 🟩 Up | [google.yml](https://github.com/upptime/upptime/commits/HEAD/history/google.yml) |  157ms




 | 100.00%





|  [Wikipedia](https://en.wikipedia.org) | 🟩 Up | [wikipedia.yml](https://github.com/upptime/upptime/commits/HEAD/history/wikipedia.yml) |  255ms




 | 100.00%





|  [Hacker News](https://news.ycombinator.com) | 🟩 Up | [hacker-news.yml](https://github.com/upptime/upptime/commits/HEAD/history/hacker-news.yml) |  203ms




 | 100.00%





|  [Test Broken Site](https://thissitedoesnotexist.koj.co) | 🟥 Down | [test-broken-site.yml](https://github.com/upptime/upptime/commits/HEAD/history/test-broken-site.yml) |  0ms




 | 0.00%





## ⭐ 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 is 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 is 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._

[![Screenshot of status website](https://raw.githubusercontent.com/upptime/upptime.js.org/master/static/img/screenshot-status.png)](https://upptime.js.org)

## 👩‍💻 [Documentation](https://upptime.js.org)

1. [How it works](https://upptime.js.org/docs)

1. [Getting started](https://upptime.js.org/docs/get-started)

1. [Configuration](https://upptime.js.org/docs/configuration)

1. [Triggers](https://upptime.js.org/docs/triggers)

1. [Notifications](https://upptime.js.org/docs/notifications)

1. [Badges](https://upptime.js.org/docs/badges)

1. [Packages](https://upptime.js.org/docs/packages)

1. [Contributing](https://upptime.js.org/docs/contributing)

1. [Frequently Asked Questions](https://upptime.js.org/docs/faq)

### 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](https://github.com/koj-co/upptime/issues/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 committed to GitHub, so it's available in the commit history of each file ([example commit history](https://github.com/koj-co/upptime/commits/master/history/wikipedia.yml)). 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](./LICENSE) © [Koj](https://koj.co)

- Data in the `./history` directory: [Open Database License](https://opendatacommons.org/licenses/odbl/1-0/)



  

    

  





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