github
/
statping
mirror of https://github.com/statping/statping
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Home (markdown)

master
Hunter Long 2018-06-24 20:49:14 -07:00
parent 53bfe2f5dd
commit f0cb3f9aae
1 changed files with 42 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
Home.md

@ -1,5 +1,44 @@
<p align="center">
<h1 align="center">Statup</h1>
<h4 align="center">A Simple Status Page for any type of application, easy installation with many server options.</h4>
<img src="https://s3-us-west-2.amazonaws.com/gitimgs/statupimgcov.png">
</p>
</p>
# Statup - Status Page
An easy to use Status Page for your websites and applications. Statup will automatically fetch the application and render a beautiful status page with tons of features for you to build an even better status page.
## A Future-Proof Status Page
Statup strives to remain future-proof and remain intact if a failure is created. Your Statup service should not be running on the same instance you're trying to monitor. If your server crashes your Status Page should still remaining online to notify your users of downtime.
## Lightweight and Fast
Statup is a very lightweight application and is available for Linux, Mac, and Windows. The Docker image is only ~16Mb so you know that this application won't be filling up your hard drive space. The Status binary for all other OS's is ~17Mb at most.
## 3 Different Databases
This Status Page generator allows you to use MySQL, Postgres, or SQLite.
<p align="center">
<img width="100" src="https://s3-us-west-2.amazonaws.com/gitimgs/postgres.png">
<img width="100" src="https://s3-us-west-2.amazonaws.com/gitimgs/mysql.png">
<img width="100" src="https://s3-us-west-2.amazonaws.com/gitimgs/sqlite.png">
</p>
## No Requirements
Statup is built in Go Language so all you need is the precompile binary based on your operating system. You won't need to install anything extra once you have the Statup binary installed.
## Run on Any Server
Whether you're a Docker fan-boy or a AWS EC2 master, Statup gives you multiple options to simply get running. Our Amazon AMI image (`ami-7be8a103`) is only 8Gb and will automatically update to the most stable version of Statup.
Running on an EC2 server might be the most cost effective way to host your own Statup Status Page. The server runs on the smallest EC2 instance (t2.nano) AWS has to offer, which only costs around $4.60 USD a month for your dedicated Status Page.
Want to run it on your own Docker server? Awesome! Statup has multiple docker-compose.yml files to work with. Statup can automatically create a SSL Certification for your status page.
## Email Nofitications
Statup includes email notification via SMTP if your services go offline.
## User Created Plugins
Statup isn't just another Status Page for your applications, it's a framework that allows you to create your own plugins to interact with every element of your status page.
Plugin are created in Golang using the [statup/plugin](https://github.com/hunterlong/statup/tree/master/plugin) golang package. The plugin package has a list of
interfaces/events to accept into your own plugin application.
## Exporting Static HTML
If you want to use Statup as a CLI application without running a server, you can export your status page to a static HTML.
This export tool is very useful for people who want to export their HTML and upload/commit it to Github Pages or an FTP server.
```dash
statup export
```