https://github.com/tubbo/breakbeat
A status site for your company's services.
https://github.com/tubbo/breakbeat
Last synced: about 1 month ago
JSON representation
A status site for your company's services.
- Host: GitHub
- URL: https://github.com/tubbo/breakbeat
- Owner: tubbo
- Created: 2014-06-16T16:07:02.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T05:58:31.000Z (over 1 year ago)
- Last Synced: 2025-01-25T08:25:18.458Z (3 months ago)
- Language: CSS
- Homepage:
- Size: 83 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Breakbeat
An automatic status page application I made for TelVue. Useful for keeping customers
up-to-date on outages or poor performance of their services. Breakbeat
should live on a VPS outside of your infrastructure, so it can provide
monitoring from a perspective closer to a customer's. It's also so that
when our entire infrastructure fails, Breakbeat will still be able to
provide status updates to our customer base.
## Features
- "Pings" various connected services regularly to obtain up-to-the-minute
stats on the boxes they're running on, using `Net::HTTP` to make GET
requests to their base path.
- Admin UI for editing uptime messages and adding new reports.
### Roadmap
- Builds uptime statistics and graphs from the given data
## Setup
Install dependencies:
```bash
$ bundle install
```
Set up the DB:
```bash
$ rake db
```
Start the server:
```bash
$ rails server
```
## Usage
In production, when you want to create a user, run:
```bash
$ rake user USER_EMAIL='[email protected]' USER_PASSWORD='helloimindelaware'
```
Users can not be created from the API, but they can be updated. Since
users are for company staff only, you need box access in order to create
yourself a new user.
## Contributing
Write tests and submit a PR.