README.md

Statup - Web and App Status Monitoring for Any Type of Project
View Wiki | Demo
Docker | EC2 | Heroku | Mac | Linux | Windows

Statup - Status Page & Monitoring Server

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.

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. You can even run Statup on a Raspberry Pi.

Custom SASS Styling

Statup will allow you to completely customize your Status Page using SASS styling with easy to use variables. The Docker image actually contains a prebuilt SASS binary so you won't even need to setup anything!

Mobile View is Gorgeous

Your status page will be optimized for mobile and desktop viewers. Statup has a full width edge to edge view, which you can also edit to meet your requirements.

3 Different Databases

This Status Page generator allows you to use MySQL, Postgres, or SQLite.

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.

Slack Integration

Everyone uses Slack and Statup should also. You can create an Incoming Webhook in Slack and insert the URL into the Settings page in Statup. Anytime a service fails, you're channel that you specified on Slack will receive a message. This is a brand new feature, right now it is sending basic text. With Slack Messaging format, I plan on creating a more detailed message for a cleaner look.

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 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.

statup export

Run on Docker

Use the Statup Docker Image to create a status page in seconds.

docker run -it -p 8080:8080 hunterlong/statup

There are multiple way to startup a Statup server. You want to make sure Statup is on it's own instance that is not on the same server as the applications you wish to monitor. It doesn't look good when your Status Page goes down, I recommend a small EC2 instance so you can set it, and forget it.

Docker Compose

In this folder there is a standard docker-compose file that include nginx, postgres, and Statup.

docker-compose up -d

Docker Compose with Automatic SSL

You can automatically start a Statup server with automatic SSL encryption using this docker-compose file. First point your domain's DNS to the Statup server, and then run this docker-compose command with DOMAIN and EMAIL. Email is for letsencrypt services.

LETSENCRYPT_HOST=mydomain.com \ 
    [email protected] \ 
    docker-compose -f docker-compose-ssl.yml up -d

Once your instance has started, it will take a moment to get your SSL certificate. Make sure you have a A or CNAME record on your domain that points to the IP/DNS of your server running Statup.

Run on EC2 Server

Running Statup on the smallest EC2 server is very quick using the AWS AMI Image: ami-7be8a103.

Create Security Groups

aws ec2 create-security-group --group-name StatupPublicHTTP --description "Statup HTTP Server on port 80 and 443"
# will response back a Group ID. Copy ID and use it for --group-id below.
aws ec2 authorize-security-group-ingress --group-id sg-7e8b830f --protocol tcp --port 80 --cidr 0.0.0.0/0
aws ec2 authorize-security-group-ingress --group-id sg-7e8b830f --protocol tcp --port 443 --cidr 0.0.0.0/0

Create EC2 without SSL

aws ec2 run-instances \ 
    --image-id ami-7be8a103 \ 
    --count 1 --instance-type t2.nano \ 
    --key-name MYKEYHERE \ 
    --security-group-ids sg-7e8b830f

Create EC2 with Automatic SSL Certification

wget https://raw.githubusercontent.com/hunterlong/statup/master/servers/ec2-ssl.sh
# Edit ec2-ssl.sh and insert your domain you want to use, then run command below.
# Use the Security Group ID that you used above for --security-group-ids
aws ec2 run-instances \ 
    --user-data file://ec2-ssl.sh \ 
    --image-id ami-7be8a103 \ 
    --count 1 --instance-type t2.nano \ 
    --key-name MYKEYHERE \ 
    --security-group-ids sg-7e8b830f

Prometheus Exporter

Statup includes a prometheus exporter so you can have even more monitoring power with your services. The prometheus exporter can be seen on /metrics, simply create another exporter in your prometheus config. Use your Statup API Secret for the Authorization Bearer header, the /metrics URL is dedicated for Prometheus and requires the correct API Secret has Authorization header.

scrape_configs:
  - job_name: 'statup'
    bearer_token: MY API SECRET HERE
    static_configs:
      - targets: ['statup:8080']