163 lines
12 KiB
Markdown
163 lines
12 KiB
Markdown
<h1 align="center" style="text-align:center">
|
|
<img alt="Statping-ng" src="https://raw.githubusercontent.com/statping-ng/statping-ng/dev/frontend/public/img/banner.png" width="60%" style="width:60%"/>
|
|
</h1>
|
|
<p align="center" style="text-align:center">
|
|
<strong>Statping-ng</strong> - <em>Web and App Status Monitoring for Any Type of Project</em>
|
|
</p>
|
|
<p align="center" style="text-align:center">
|
|
<a href="https://statping-ng.github.io" >Website</a> |
|
|
<a href="https://github.com/statping-ng/statping-ng/wiki" >Wiki</a>
|
|
<br/>
|
|
<a href="https://github.com/statping-ng/statping-ng/wiki/Linux" >Linux</a> |
|
|
<a href="https://github.com/statping-ng/statping-ng/wiki/Windows" >Windows</a> |
|
|
<a href="https://github.com/statping-ng/statping-ng/wiki/Mac" >Mac</a> |
|
|
<a href="https://github.com/statping-ng/statping-ng/wiki/Docker" >Containers</a>
|
|
</p>
|
|
|
|
<h2> Statping-ng - <em>Status Page & Monitoring Server</em></h2>
|
|
<p>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.
|
|
</p><p>
|
|
Statping-ng aims to be an updated drop-in replacement of statping after development stopped on the original fork.
|
|
</p>
|
|
|
|
<p align="center" style="text-align:center">
|
|
<a href="https://github.com/statping-ng/statping-ng/blob/stable/LICENSE"><img alt="License" src="https://img.shields.io/github/license/statping-ng/statping-ng?color=success&style=for-the-badge&logo" /></a>
|
|
</p><p align="center" style="text-align:center">
|
|
<img alt="Last Commit" src="https://img.shields.io/github/last-commit/statping-ng/statping-ng?style=for-the-badge&logo=github" />
|
|
<img alt="Dev Build Status" src="https://img.shields.io/github/actions/workflow/status/statping-ng/statping-ng/build.yml?branch=dev&label=Dev&style=for-the-badge&logo=github" />
|
|
<img alt="Unstable Build Status" src="https://img.shields.io/github/actions/workflow/status/statping-ng/statping-ng/build.yml?branch=unstable&label=Unstable&style=for-the-badge&logo=github" />
|
|
<img alt="Stable Build Status" src="https://img.shields.io/github/actions/workflow/status/statping-ng/statping-ng/build.yml?branch=stable&label=Stable&style=for-the-badge&logo=github" />
|
|
</p><p align="center" style="text-align:center">
|
|
<a href="https://hub.docker.com/r/adamboutcher/statping-ng"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/adamboutcher/statping-ng?style=for-the-badge&logo=docker&logoColor=white" /></a>
|
|
<a href="https://hub.docker.com/r/adamboutcher/statping-ng"><img alt="Docker Image Size" src="https://img.shields.io/docker/image-size/adamboutcher/statping-ng/latest?style=for-the-badge&logo=docker&logoColor=white" /></a>
|
|
</p><p align="center" style="text-align:center">
|
|
<img alt="Go Version" src="https://img.shields.io/github/go-mod/go-version/statping-ng/statping-ng?style=for-the-badge" />
|
|
<a href="https://goreportcard.com/badge/github.com/statping-ng/statping-ng"><img alt="Go Report" src="https://goreportcard.com/badge/github.com/statping-ng/statping-ng?style=for-the-badge" /></a>
|
|
</p>
|
|
|
|
<hr/>
|
|
<h2 align="center" style="text-align:center">About Statping-ng</h2>
|
|
|
|
<img style="margin-right:10px;float:left;width:320px;height:235px;" align="left" width="320" height="235" src="https://statping-ng.github.io/assets/external/statupsiterun.gif" />
|
|
<h3>A Future-Proof Status Page</h3>
|
|
<p>
|
|
Statping-ng strives to remain future-proof and remain intact if a failure is created. Your Statping-ng 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.
|
|
</p>
|
|
<p>
|
|
<a href="https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/statping-ng/statping-ng/stable/dev/pwd-stack.yml"><img alt="Try Statping-ng via Play with Docker" src="https://statping-ng.github.io/assets/external/docker-pwd.png" height="25px" style="height:25px" /></a> - Login is <kbd>admin</kbd>, password <kbd>admin</kbd>.
|
|
</p>
|
|
<div style="clear:both;"><br/><br/></div>
|
|
|
|
|
|
<h3>No Requirements - Run on Any Server</h3>
|
|
<p>
|
|
Statping-ng is built in Go Language so all you need is the pre-compiled binary based on your operating system. You won't need to install anything extra once you have the Statping binary installed. Windows, Linux or Mac, We compile to all the popular systems, including Raspberry Pi!
|
|
</p>
|
|
<p align="center" style="text-align:center">
|
|
<a href="https://github.com/statping-ng/statping-ng/wiki/Linux"><img alt="Linux" src="https://statping-ng.github.io/assets/external/linux.png" style="width:5%;margin-right:5px;" width=5% /></a>
|
|
<a href="https://github.com/statping-ng/statping-ng/wiki/Windows"><img alt="Windows" src="https://statping-ng.github.io/assets/external/windows.png" style="width:5%;margin-right:5px;" width=5% /></a>
|
|
<a href="https://github.com/statping-ng/statping-ng/wiki/Mac"><img alt="Apple Mac" src="https://statping-ng.github.io/assets/external/apple.png" style="width:5%;margin-right:5px;" width=5% /></a>
|
|
<a href="https://github.com/statping-ng/statping-ng/wiki/Docker"><img alt="Containers" src="https://statping-ng.github.io/assets/external/dockericon.png" style="width:5%;margin-right:5px;" width=5% /></a>
|
|
<a href="https://statping-ng.github.io/assets/external/android.png)](https://play.google.com/store/apps/details?id=com.statping"><img alt="Android Play Store" src="https://statping-ng.github.io/assets/external/android.png" style="width:5%;margin-right:5px;" width=5% /></a>
|
|
<a href="https://itunes.apple.com/us/app/apple-store/id1445513219"><img alt="Apple Apps Store" src="https://statping-ng.github.io/assets/external/appstore.png" style="width:5%;margin-right:5px;" width=5% /></a>
|
|
</p>
|
|
<br/>
|
|
<div style="clear:both;"><br/><br/></div>
|
|
|
|
|
|
<img style="margin-left:10px;float:right;width:320px;height:235px;" align="right" width="320" height="235" src="https://statping-ng.github.io/assets/external/slack-notifer.png" />
|
|
<h3>Lightweight and Fast</h3>
|
|
<p>
|
|
Statping-ng is a very lightweight application and is available for Linux, Mac, and Windows. The Docker image is only ~20Mb 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.
|
|
</p>
|
|
<div style="clear:both;"><br/><br/><br/></div>
|
|
|
|
|
|
<h3>Want easy containers?</h3>
|
|
<p>
|
|
No Worries, we provide docker containers for many different system architectures, with multiple docker-compose files to suit your needs, you can even bring your own SSL Certificate or automatically leverage <a href="https://letsencrypt.org/">Lets Encrypt</a> to keep things secure. But it's can be as simple as a docker run!
|
|
</p>
|
|
<div style="clear:both;"><br/><br/></div>
|
|
|
|
|
|
<img style="margin-left:10px;float:right;width:320px;height:235px;" align="right" width="320" height="235" src="https://statping-ng.github.io/assets/external/statping_theme.gif" />
|
|
<h3>Custom SASS Styling</h3>
|
|
Statping-ng will allow you to completely customize your Status Page using SASS styling with easy to use variables. The container image actually contains a pre-built SASS binary so you won't even need to setup anything!
|
|
<div style="clear:both;"><br/><br/><br/></div>
|
|
|
|
|
|
<img style="margin-right:10px;float:left;width:320px;height:235px;" align="left" width="320" height="235" src="https://statping-ng.github.io/assets/external/statping_iphone_bk.png" />
|
|
<h3>Compatible with the Statping App</h3>
|
|
<p>
|
|
Statping-ng is 100% compatible with the statping app which is available on the Apple App Store and Google Play for free. The app will allow you to view services, receive notifications when a service is offline, update groups, users, services, messages, and more! Start your own Statping-ng server and then connect it to the app by scanning the QR code in settings.</p>
|
|
<p align="center" style="text-align:center">
|
|
<a href="https://play.google.com/store/apps/details?id=com.statping"><img src="https://statping-ng.github.io/assets/external/google-play.svg"></a>
|
|
<a href="https://itunes.apple.com/us/app/apple-store/id1445513219"><img src="https://statping-ng.github.io/assets/external/app-store-badge.svg"></a>
|
|
</p>
|
|
<p align="center" style="text-align:center"><small>The mobile app is not maintained by statping-ng and includes in-app purchases to the developer of statping.</small></p>
|
|
<div style="clear:both;"><br/><br/></div>
|
|
|
|
<h3>Notifications - Slack, Email, Twilio and more</h3>
|
|
<p>Statping-ng includes email notification via SMTP and Slack integration using <a href="https://api.slack.com/incoming-webhooks">Incoming Webhook</a>. Insert the webhook URL into the Settings page in Statping-ng and enable the Slack integration. Anytime a service fails, the channel that you specified on Slack will receive a message.</p>
|
|
<p>View the <a href="https://github.com/statping-ng/statping-ng/wiki/Statping-Plugins">Plugin Wiki</a> to see detailed information about Golang Plugins. Statping-ng 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. <a href="https://github.com/statping-ng/statping-ng/wiki/Notifiers">Notifier's</a> can also be create with only 1 golang file.</p>
|
|
<div style="clear:both;"><br/><br/><br/></div>
|
|
|
|
|
|
<img style="margin-left:10px;float:right;width:320px;height:235px;" width="320" height="235" align="right" src="https://statping-ng.github.io/assets/external/statping_settings.gif" />
|
|
<h2>Easy to use Dashboard</h2>
|
|
<p>
|
|
Having a straight forward dashboard makes Statping-ng that much better. Quickly and Easy view statuses. Monitor your websites and applications with a basic HTTP GET request, or add a POST request with your own JSON to post to the endpoint.</p>
|
|
<div style="clear:both;"><br/><br/><br/><br/></div>
|
|
|
|
|
|
<img style="margin:35px 0;width:100%;height:250px;" align="center" width="100%" height="250" src="https://statping-ng.github.io/assets/external/statupsc2.png" />
|
|
|
|
|
|
|
|
<h2 align="center" style="text-align:center">Quick Start</h2>
|
|
<p>Here's a few quick start guides to get you going, fast.</p>
|
|
|
|
<h3>Docker</h3>
|
|
<p>Use the <a href="https://hub.docker.com/r/adamboutcher/statping-ng">Statping Docker Image</a> to create a status page in seconds. Checkout the <a href="https://github.com/statping-ng/statping-ng/wiki/Docker">Docker Wiki</a> to view more details on how to get started using Docker.
|
|
</p>
|
|
|
|
```bash
|
|
docker run -it -p 8080:8080 adamboutcher/statping-ng
|
|
```
|
|
|
|
<h3>Docker Compose</h3>
|
|
<p>In the root (base) folder there is a standard docker-compose file that includes nginx, postgres, and Statping-ng.</p>
|
|
|
|
```bash
|
|
docker-compose up -d
|
|
```
|
|
|
|
<h3>Docker Compose with Automatic SSL</h3>
|
|
<p>You can automatically start a Statping-ng server with automatic SSL encryption using this docker-compose file. First point your domain's DNS to the Statping-ng server, and then run this docker-compose command with DOMAIN and EMAIL. Email is for <a href="https://letsencrypt.org/">letsencrypt</a> services.</p>
|
|
|
|
```bash
|
|
LETSENCRYPT_HOST=mydomain.com \
|
|
LETSENCRYPT_EMAIL=info@mydomain.com \
|
|
docker-compose -f docker-compose-ssl.yml up -d
|
|
```
|
|
|
|
<p>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 Statping-ng.</p>
|
|
|
|
<h3>Prometheus Exporter</h3>
|
|
<p>Statping-ng includes a <a href="https://github.com/statping-ng/statping-ng/wiki/Prometheus-Exporter">Prometheus Exporter</a> so you can have even more monitoring power with your services. The Prometheus exporter can be seen on <kbd>/metrics</kbd>, simply create another exporter in your prometheus config. Use your Statping-ng API Secret for the Authorization Bearer header, the <kbd>/metrics</kbd> URL is dedicated for Prometheus and requires the correct API Secret has <kbd>Authorization</kbd> header.</p>
|
|
|
|
```yaml
|
|
scrape_configs:
|
|
- job_name: 'statping'
|
|
bearer_token: 'MY API SECRET HERE'
|
|
static_configs:
|
|
- targets: ['statping:8080']
|
|
```
|
|
|
|
<h2>Contributing</h2>
|
|
<p>Statping-ng accepts Push Requests to the <kbd>dev</kbd> branch!</p>
|
|
<p>Feel free to add your own features and notifiers.You probably want to checkout the <a href="https://github.com/statping-ng/statping-ng/wiki/Notifiers">Notifier Wiki</a> to get a better understanding on how to create your own notification methods for failing/successful services.</p>
|
|
<p>Testing on Statping-ng will test each function on MySQL, Postgres, and SQLite. I recommend running MySQL and Postgres Docker containers for testing.</p>
|
|
<p>You can find multiple docker-compose files in the <kbd>dev</kbd> directory.</p>
|