From 10cae6bba64595176d4aec10ac0e9c0cdcb46bfe Mon Sep 17 00:00:00 2001 From: Adam Boutcher Date: Fri, 13 Aug 2021 10:33:20 +0100 Subject: [PATCH] Updated README to statping-ng in some places --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index de709f44..1bdb32ec 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,19 @@

- Statping - Web and App Status Monitoring for Any Type of Project
-View Wiki | Demo | iPhone | Android
API | Docker | EC2 | Mac | Linux | Windows + Statping-ng - Web and App Status Monitoring for Any Type of Project
+View Wiki | Demo | iPhone | Android
API | Docker | EC2 | Mac | Linux | Windows

-# Statping - Status Page & Monitoring Server +# Statping-ng - Status Page & Monitoring Server An easy to use Status Page for your websites and applications. Statping will automatically fetch the application and render a beautiful status page with tons of features for you to build an even better status page. This Status Page generator allows you to use MySQL, Postgres, or SQLite on multiple operating systems. -![Master Release](https://github.com/statping/statping/workflows/Master%20Release/badge.svg?branch=master) [![GoDoc](https://godoc.org/github.com/golang/gddo?status.svg)](https://godoc.org/github.com/statping/statping) [![Slack](https://slack.statping.com/badge.svg)](https://slack.statping.com) [![](https://images.microbadger.com/badges/image/statping/statping.svg)](https://microbadger.com/images/statping/statping) [![Docker Pulls](https://img.shields.io/docker/pulls/statping/statping.svg)](https://hub.docker.com/r/statping/statping/builds/) +![Master Release](https://github.com/aboutcher/statping-ng/workflows/Master%20Release/badge.svg?branch=master) [![GoDoc](https://godoc.org/github.com/golang/gddo?status.svg)](https://godoc.org/github.com/adamboutcher/statping-ng) [![Slack](https://slack.statping.com/badge.svg)](https://slack.statping.com) [![](https://images.microbadger.com/badges/image/adamboutcher/statping-ng.svg)](https://microbadger.com/images/adamboutcher/statping-ng) [![Docker Pulls](https://img.shields.io/docker/pulls/statping/statping.svg)](https://hub.docker.com/r/statping/statping/builds/)

A Future-Proof Status Page

-Statping strives to remain future-proof and remain intact if a failure is created. Your Statping 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. +Statping-ng strives to remain future-proof and remain intact if a failure is created. Your Statping 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.
(dashboard login is `admin`, password `admin`)


@@ -23,9 +23,9 @@ Statping strives to remain future-proof and remain intact if a failure is create Statping 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 Statping binary installed. You can even run Statping on a Raspberry Pi.

-        -        -        +        +        +                      @@ -50,7 +50,7 @@ The Statping app is available on the App Store and Google Play for free. The app

## Run on Any Server -Whether you're a Docker fan-boy or a [AWS EC2](https://github.com/statping/statping/wiki/AWS-EC2) master, Statping gives you multiple options to simply get running. Our Amazon AMI image is only 8Gb and will automatically update to the most stable version of Statping. +Whether you're a Docker fan-boy or a [AWS EC2](https://github.com/aboutcher/statping-ng/wiki/AWS-EC2) master, Statping gives you multiple options to simply get running. Our Amazon AMI image is only 8Gb and will automatically update to the most stable version of Statping. Running on an EC2 server might be the most cost effective way to host your own Statping 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! Statping has multiple docker-compose.yml files to work with. Statping can automatically create a SSL Certification for your status page.



@@ -65,7 +65,7 @@ Statping includes email notification via SMTP and Slack integration using [Incom



User Created Notifiers

-View the [Plugin Wiki](https://github.com/statping/statping/wiki/Statping-Plugins) to see detailed information about Golang Plugins. Statping 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. [Notifier's](https://github.com/statping/statping/wiki/Notifiers) can also be create with only 1 golang file. +View the [Plugin Wiki](https://github.com/aboutcher/statping-ng/wiki/Statping-Plugins) to see detailed information about Golang Plugins. Statping 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. [Notifier's](https://github.com/aboutcher/statping-ng/wiki/Notifiers) can also be create with only 1 golang file.



@@ -78,7 +78,7 @@ Having a straight forward dashboard makes Statping that much better. Monitor you



## Run on Docker -Use the [Statping Docker Image](https://hub.docker.com/r/statping/statping) to create a status page in seconds. Checkout the [Docker Wiki](https://github.com/statping/statping/wiki/Docker) to view more details on how to get started using Docker. +Use the [Statping Docker Image](https://hub.docker.com/r/statping/statping) to create a status page in seconds. Checkout the [Docker Wiki](https://github.com/aboutcher/statping-ng/wiki/Docker) to view more details on how to get started using Docker. ```bash docker run -it -p 8080:8080 statping/statping ``` @@ -103,7 +103,7 @@ Once your instance has started, it will take a moment to get your SSL certificat



## Prometheus Exporter -Statping includes a [Prometheus Exporter](https://github.com/statping/statping/wiki/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 Statping API Secret for the Authorization Bearer header, the `/metrics` URL is dedicated for Prometheus and requires the correct API Secret has `Authorization` header. +Statping includes a [Prometheus Exporter](https://github.com/aboutcher/statping-ng/wiki/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 Statping API Secret for the Authorization Bearer header, the `/metrics` URL is dedicated for Prometheus and requires the correct API Secret has `Authorization` header. ```yaml scrape_configs: - job_name: 'statping' @@ -114,7 +114,7 @@ scrape_configs:



## Run on EC2 Server -Running Statping on the smallest EC2 server is very quick using the AWS AMI Image. Checkout the [AWS Wiki](https://github.com/statping/statping/wiki/AWS-EC2) to see a step by step guide on how to get your EC2 Statping service online. +Running Statping on the smallest EC2 server is very quick using the AWS AMI Image. Checkout the [AWS Wiki](https://github.com/aboutcher/statping-ng/wiki/AWS-EC2) to see a step by step guide on how to get your EC2 Statping service online.



##### Create Security Groups @@ -156,9 +156,9 @@ aws ec2 run-instances \ ``` ## Contributing -Statping accepts Push Requests to the `dev` branch! Feel free to add your own features and notifiers. You probably want to checkout the [Notifier Wiki](https://github.com/statping/statping/wiki/Notifiers) to get a better understanding on how to create your own notification methods for failing/successful services. Testing on Statping will test each function on MySQL, Postgres, and SQLite. I recommend running MySQL and Postgres Docker containers for testing. You can find multiple docker-compose files in the dev directory. +Statping accepts Push Requests to the `dev` branch! Feel free to add your own features and notifiers. You probably want to checkout the [Notifier Wiki](https://github.com/aboutcher/statping-ng/wiki/Notifiers) to get a better understanding on how to create your own notification methods for failing/successful services. Testing on Statping will test each function on MySQL, Postgres, and SQLite. I recommend running MySQL and Postgres Docker containers for testing. You can find multiple docker-compose files in the dev directory. -![Dev Release](https://github.com/statping/statping/workflows/Dev%20Release/badge.svg?branch=dev) +![Dev Release](https://github.com/aboutcher/statping-ng/workflows/Dev%20Release/badge.svg?branch=dev) [![Go Report Card](https://goreportcard.com/badge/github.com/statping/statping)](https://goreportcard.com/report/github.com/statping/statping) [![Build Status](https://travis-ci.com/statping/statping.svg?branch=master)](https://travis-ci.com/statping/statping) [![Cypress.io tests](https://img.shields.io/badge/cypress.io-tests-green.svg?style=flat-square)](https://dashboard.cypress.io/#/projects/bi8mhr/runs) [![Docker Pulls](https://img.shields.io/docker/pulls/statping/statping.svg)](https://hub.docker.com/r/statping/statping/builds/) [![Godoc](https://godoc.org/github.com/statping/statping?status.svg)](https://godoc.org/github.com/statping/statping)[![Coverage Status](https://coveralls.io/repos/github/statping/statping/badge.svg?branch=master)](https://coveralls.io/github/statping/statping?branch=master)