mirror of https://github.com/statping/statping
package name change
Hunter Long
parent
fcf92a9197
commit
67f26be052
|
|
@ -1,4 +1,4 @@
|
|||
Running Statping on the smallest EC2 server is very quick using the AWS AMI Image. When the AMI image boots it will automatically run the [init.sh](https://github.com/hunterlong/statup/blob/master/servers/init.sh) script to update Docker containers and remove unused containers/images. The server will also re-download the init.sh script to make sure it is up-to-date with the latest updates and bug fixes.
|
||||
Running Statping on the smallest EC2 server is very quick using the AWS AMI Image. When the AMI image boots it will automatically run the [init.sh](https://github.com/hunterlong/statping/blob/master/servers/init.sh) script to update Docker containers and remove unused containers/images. The server will also re-download the init.sh script to make sure it is up-to-date with the latest updates and bug fixes.
|
||||
|
||||
# AMI Image
|
||||
Choose the correct AMI Image ID based on your AWS region.
|
||||
|
|
@ -39,7 +39,7 @@ aws ec2 run-instances \
|
|||
## Create EC2 with Automatic SSL Certification
|
||||
This is an awesome way to do things, start a Statping server with an SSL cert that will automatically regenerate when its near expiration time. You'll need to point your domain's A record (IP address) or CNAME (public DNS endpoint) to use this feature.
|
||||
```bash
|
||||
wget https://raw.githubusercontent.com/hunterlong/statup/master/servers/ec2-ssl.sh
|
||||
wget https://raw.githubusercontent.com/hunterlong/statping/master/servers/ec2-ssl.sh
|
||||
```
|
||||
|
||||
```bash
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ Building from the Go Language source code is pretty easy if you already have Go
|
|||
|
||||
### Git n' Go Get
|
||||
```bash
|
||||
git clone https://github.com/hunterlong/statup.git
|
||||
git clone https://github.com/hunterlong/statping.git
|
||||
cd statup
|
||||
go get -v
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
Have a feature you want to implement into Statping!? Awesome! Follow this guide to see how you can test, compile and build Statping for production use. I recommend you use `make` with this process, it will save you time and it will auto include many customized parameters to get everything working correctly.
|
||||
|
||||
# Dependencies
|
||||
Statping has a couple of required dependencies when testing and compiling the binary. The [Makefile](https://github.com/hunterlong/statup/blob/master/Makefile) will make these tasks a lot easier. Take a look at the Makefile to see what commands are ran. Run the command below to get setup right away.
|
||||
Statping has a couple of required dependencies when testing and compiling the binary. The [Makefile](https://github.com/hunterlong/statping/blob/master/Makefile) will make these tasks a lot easier. Take a look at the Makefile to see what commands are ran. Run the command below to get setup right away.
|
||||
```bash
|
||||
make dev-deps
|
||||
```
|
||||
|
|
|
|||
14
Docker.md
14
Docker.md
|
|
@ -1,19 +1,19 @@
|
|||
# Latest Docker Image
|
||||
The `latest` Docker image uses Alpine Linux to keep it ultra small.
|
||||
```bash
|
||||
docker run -it -p 8080:8080 hunterlong/statup
|
||||
docker run -it -p 8080:8080 hunterlong/statping
|
||||
```
|
||||
|
||||
# Development Docker Image
|
||||
If you want to run Statping that was build from the source, use the `dev` Docker image.
|
||||
```bash
|
||||
docker run -it -p 8080:8080 hunterlong/statup:dev
|
||||
docker run -it -p 8080:8080 hunterlong/statping:dev
|
||||
```
|
||||
|
||||
# Cypress Testing Docker Image
|
||||
This Docker image will pull the latest version of Statping and test the web interface with [Cypress](https://www.cypress.io/).
|
||||
```bash
|
||||
docker run -it -p 8080:8080 hunterlong/statup:cypress
|
||||
docker run -it -p 8080:8080 hunterlong/statping:cypress
|
||||
```
|
||||
|
||||
#### Or use Docker Compose
|
||||
|
|
@ -53,7 +53,7 @@ services:
|
|||
|
||||
statup:
|
||||
container_name: statup
|
||||
image: hunterlong/statup:latest
|
||||
image: hunterlong/statping:latest
|
||||
restart: always
|
||||
networks:
|
||||
- internet
|
||||
|
|
@ -94,14 +94,14 @@ networks:
|
|||
```
|
||||
Or a simple wget...
|
||||
```bash
|
||||
wget https://raw.githubusercontent.com/hunterlong/statup/master/servers/docker-compose.yml
|
||||
wget https://raw.githubusercontent.com/hunterlong/statping/master/servers/docker-compose.yml
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
#### Docker Compose with Automatic SSL
|
||||
You can automatically start a Statping server with automatic SSL encryption using this docker-compose file. First point your domain's DNS to the Statping server, and then run this docker-compose command with DOMAIN and EMAIL. Email is for letsencrypt services.
|
||||
```bash
|
||||
wget https://raw.githubusercontent.com/hunterlong/statup/master/servers/docker-compose-ssl.yml
|
||||
wget https://raw.githubusercontent.com/hunterlong/statping/master/servers/docker-compose-ssl.yml
|
||||
|
||||
LETSENCRYPT_HOST=mydomain.com \
|
||||
LETSENCRYPT_EMAIL=info@mydomain.com \
|
||||
|
|
@ -150,7 +150,7 @@ services:
|
|||
|
||||
statup:
|
||||
container_name: statup
|
||||
image: hunterlong/statup:latest
|
||||
image: hunterlong/statping:latest
|
||||
restart: always
|
||||
networks:
|
||||
- internet
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ You can use MySQL, Postgres, or SQLite as a database for your Statping status pa
|
|||
Statping is an extremely easy to setup website monitoring tool without fussing with dependencies or packages. Simply download and install the precompile binary for your operating system. Statping works on Windows, Mac, Linux, Docker, and even the Raspberry Pi.
|
||||
|
||||
# Plugins
|
||||
Statping is an awesome Status Page generator that allows you to create your own plugins with Golang Plugins! You don't need to request a PR or even tell us about your plugin. Plugin's are compiled and then send as a binary to the Statping `/plugins` folder. Test your plugins using the `statup test plugin` command, checkout the [Plugin Wiki](https://github.com/hunterlong/statup/wiki/Statping-Plugins) to see detailed information about creating plugins.
|
||||
Statping is an awesome Status Page generator that allows you to create your own plugins with Golang Plugins! You don't need to request a PR or even tell us about your plugin. Plugin's are compiled and then send as a binary to the Statping `/plugins` folder. Test your plugins using the `statup test plugin` command, checkout the [Plugin Wiki](https://github.com/hunterlong/statping/wiki/Statping-Plugins) to see detailed information about creating plugins.
|
||||
|
||||
# No Maintence
|
||||
Many other website monitoring applications will collect data until the server fails because of hard drive is 100% full. Statping will automatically delete records to make sure your server will stay UP for years. The EC2 AMI Image is a great way to host your status page without worrying about it crashing one day. Statping will automatically upgrade its software when you reboot your computer.
|
||||
|
|
|
|||
2
Home.md
2
Home.md
|
|
@ -38,7 +38,7 @@ Creating a custom notifier is pretty easy as long as you follow the requirements
|
|||
|
||||
## User Created 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.
|
||||
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
|
||||
Plugin are created in Golang using the [statup/plugin](https://github.com/hunterlong/statping/tree/master/plugin) golang package. The plugin package has a list of
|
||||
interfaces/events to accept into your own plugin application.
|
||||
|
||||
## Exporting Static HTML
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
# Mac
|
||||
```
|
||||
brew tap hunterlong/statup
|
||||
brew tap hunterlong/statping
|
||||
brew install statup
|
||||
```
|
||||
2
Mac.md
2
Mac.md
|
|
@ -1,7 +1,7 @@
|
|||
# Installing on Mac
|
||||
Statping includes an easy to use [Homebrew Formula](https://github.com/hunterlong/homebrew-statup) to quick get your Status Page up and running locally. Statping on brew is automatically generated for each new release to master. Install with the commands below,
|
||||
```bash
|
||||
brew tap hunterlong/statup
|
||||
brew tap hunterlong/statping
|
||||
brew install statup
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Here's a simple list of Makefile commands you can run using `make`. The [Makefile](https://github.com/hunterlong/statup/blob/master/Makefile) may change often, so i'll try to keep this Wiki up-to-date.
|
||||
Here's a simple list of Makefile commands you can run using `make`. The [Makefile](https://github.com/hunterlong/statping/blob/master/Makefile) may change often, so i'll try to keep this Wiki up-to-date.
|
||||
|
||||
- Ubuntu `apt-get install build-essential`
|
||||
- MacOSX `sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer`
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
Below is a full example of a Statping notifier which will give you a good example of how to create your own. Insert your new notifier inside the `/notifiers` folder once your ready!
|
||||
|
||||
[](https://godoc.org/github.com/hunterlong/statup/core/notifier)
|
||||
[](https://godoc.org/github.com/hunterlong/statping/core/notifier)
|
||||
|
||||
```go
|
||||
package notifiers
|
||||
|
|
@ -8,8 +8,8 @@ package notifiers
|
|||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"github.com/hunterlong/statup/types"
|
||||
"github.com/hunterlong/statup/core/notifier"
|
||||
"github.com/hunterlong/statping/types"
|
||||
"github.com/hunterlong/statping/core/notifier"
|
||||
"time"
|
||||
)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
You can check if the Statping binary you downloaded is authentic by running a few commands.
|
||||
|
||||
### Steps to Authenticate
|
||||
1. Download the Statping `tar.gz` file from [Latest Releases](https://github.com/hunterlong/statup/releases/latest) and extract the Statping binary and the `statup.asc` file.
|
||||
1. Download the Statping `tar.gz` file from [Latest Releases](https://github.com/hunterlong/statping/releases/latest) and extract the Statping binary and the `statup.asc` file.
|
||||
2. Run command: `gpg --verify statping.asc`
|
||||
3. You should see `Good signature from "Hunter Long <info@statping.com>" [ultimate]`.
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ statup
|
|||
```
|
||||
|
||||
# Windows
|
||||
[Download the latest `statup-windows-x64.zip`](https://github.com/hunterlong/statup/releases/latest) un-zip and run the `statup` binary.
|
||||
[Download the latest `statup-windows-x64.zip`](https://github.com/hunterlong/statping/releases/latest) un-zip and run the `statup` binary.
|
||||
|
||||
# Linux
|
||||
```shell
|
||||
|
|
@ -21,11 +21,11 @@ statup
|
|||
```
|
||||
# Docker
|
||||
```shell
|
||||
docker run -it -p 8080:8080 hunterlong/statup
|
||||
docker run -it -p 8080:8080 hunterlong/statping
|
||||
```
|
||||
|
||||
# Raspberry Pi
|
||||
[Download the latest `statup-linux-arm7.tar.gz`](https://github.com/hunterlong/statup/releases/latest) and un-zip and run the `statup` binary.
|
||||
[Download the latest `statup-linux-arm7.tar.gz`](https://github.com/hunterlong/statping/releases/latest) and un-zip and run the `statup` binary.
|
||||
|
||||
# AWS
|
||||
Checkout the AWS installation on EC2 server on the [https://github.com/hunterlong/statup/wiki/AWS-EC2](AWS Wiki).
|
||||
Checkout the AWS installation on EC2 server on the [https://github.com/hunterlong/statping/wiki/AWS-EC2](AWS Wiki).
|
||||
|
|
@ -1,24 +1,24 @@
|
|||
Since Statping is built in Go Language we can use the [Go Plugin](https://golang.org/pkg/plugin/) feature to create dynamic plugins that run on load. Statping has an event anytime anything happens, you can create your own plugins and do any type of function. To implement your own ideas into Statping, use the plugin using the [statup/plugin](https://github.com/hunterlong/statup/blob/master/plugin/main.go) package.
|
||||
Since Statping is built in Go Language we can use the [Go Plugin](https://golang.org/pkg/plugin/) feature to create dynamic plugins that run on load. Statping has an event anytime anything happens, you can create your own plugins and do any type of function. To implement your own ideas into Statping, use the plugin using the [statup/plugin](https://github.com/hunterlong/statping/blob/master/plugin/main.go) package.
|
||||
```
|
||||
go get github.com/hunterlong/statup/plugin
|
||||
go get github.com/hunterlong/statping/plugin
|
||||
```
|
||||
|
||||
## Example Plugin
|
||||
Start off with the [Example Statping Plugin](https://github.com/hunterlong/statup_plugin) that includes all the interfaces and some custom options for you to expand on. You can include any type of function in your own plugin!
|
||||
Start off with the [Example Statping Plugin](https://github.com/hunterlong/statping_plugin) that includes all the interfaces and some custom options for you to expand on. You can include any type of function in your own plugin!
|
||||
|
||||
<p align="center">
|
||||
<img width="95%" src="https://img.cjx.io/statuppluginrun.gif">
|
||||
</p>
|
||||
|
||||
## Building Plugins
|
||||
Plugins don't need a push request and they can be private! You'll need to compile your plugin to the Golang `.so` binary format. Once you've built your plugin, insert it into the `plugins` folder in your Statping directory and reboot the application. Clone the [Example Statping Plugin](https://github.com/hunterlong/statup_plugin) repo and try to build it yourself!
|
||||
Plugins don't need a push request and they can be private! You'll need to compile your plugin to the Golang `.so` binary format. Once you've built your plugin, insert it into the `plugins` folder in your Statping directory and reboot the application. Clone the [Example Statping Plugin](https://github.com/hunterlong/statping_plugin) repo and try to build it yourself!
|
||||
|
||||
#### Build Requirements
|
||||
- You must have `main.go`
|
||||
- You must create the Plugin variable on `init()`
|
||||
|
||||
```bash
|
||||
git clone https://github.com/hunterlong/statup_plugin
|
||||
git clone https://github.com/hunterlong/statping_plugin
|
||||
cd statup-plugin
|
||||
go build -buildmode=plugin -o example.so
|
||||
```
|
||||
|
|
@ -36,7 +36,7 @@ statup test plugins
|
|||
Your plugin should be able to parse and receive events before distributing it. The test tools creates a temporary database (SQLite) that your plugin can interact with. Statping uses [upper.io/db.v3](https://upper.io/db.v3) for database interactions. The database is passed to your plugin `OnLoad(db sqlbuilder.Database)`, so you can use the `db` variable passed here.
|
||||
|
||||
## Statping Plugin Interface
|
||||
Please remember Golang plugin's are very new and Statping plugin package may change and 'could' brake your plugin. Checkout the [statup/plugin package](https://github.com/hunterlong/statup/blob/master/plugin/main.go) to see the most current interfaces.
|
||||
Please remember Golang plugin's are very new and Statping plugin package may change and 'could' brake your plugin. Checkout the [statup/plugin package](https://github.com/hunterlong/statping/blob/master/plugin/main.go) to see the most current interfaces.
|
||||
```go
|
||||
type PluginActions interface {
|
||||
GetInfo() Info
|
||||
|
|
@ -96,7 +96,7 @@ func (p pkg) OnLoad(db sqlbuilder.Database) {
|
|||
|
||||
|
||||
## Interacting with Database
|
||||
The Example Statping Plugin includes a variable `Database` that will allow you to interact with the Statping database. Checkout [database.go](https://github.com/hunterlong/statup_plugin/blob/master/database.go) to see a full example of Create, Read, Update and then Deleting a custom Communication entry into the database.
|
||||
The Example Statping Plugin includes a variable `Database` that will allow you to interact with the Statping database. Checkout [database.go](https://github.com/hunterlong/statping_plugin/blob/master/database.go) to see a full example of Create, Read, Update and then Deleting a custom Communication entry into the database.
|
||||
```go
|
||||
// Insert a new communication into database
|
||||
// once inserted, return the Communication
|
||||
|
|
@ -111,7 +111,7 @@ func (c *Communication) Create() *Communication {
|
|||
```
|
||||
|
||||
## Custom HTTP Routes
|
||||
Plugin's can include their own HTTP route to accept GET/POST requests. Route are loaded after Statping loads all of it's Routes. Checkout [routes.go](https://github.com/hunterlong/statup_plugin/blob/master/routes.go) on the example plugin to see a full example of how to use it.
|
||||
Plugin's can include their own HTTP route to accept GET/POST requests. Route are loaded after Statping loads all of it's Routes. Checkout [routes.go](https://github.com/hunterlong/statping_plugin/blob/master/routes.go) on the example plugin to see a full example of how to use it.
|
||||
```go
|
||||
// You must have a Routes() method in your plugin
|
||||
func (p *pkg) Routes() []plugin.Routing {
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
<p align="center">
|
||||
<a href="https://statping.com">Statping.com</a> | <a href="https://demo.statping.com">Demo</a> | <a href="https://hub.docker.com/r/hunterlong/statup">Docker</a> | <a href="https://github.com/hunterlong/statup/wiki/Notifiers">Notifiers</a> | <a href="https://github.com/hunterlong/statup/wiki/API">API</a>
|
||||
<a href="https://statping.com">Statping.com</a> | <a href="https://demo.statping.com">Demo</a> | <a href="https://hub.docker.com/r/hunterlong/statping">Docker</a> | <a href="https://github.com/hunterlong/statping/wiki/Notifiers">Notifiers</a> | <a href="https://github.com/hunterlong/statping/wiki/API">API</a>
|
||||
</p>
|
||||
|
|
@ -60,18 +60,18 @@ Docker: [hunterlong/statping](https://cloud.docker.com/repository/docker/hunterl
|
|||
|
||||
[](https://codebeat.co/projects/github-com-hunterlong-statup-master)
|
||||
|
||||
[](https://codeclimate.com/github/hunterlong/statup/maintainability)
|
||||
[](https://codeclimate.com/github/hunterlong/statping/maintainability)
|
||||
|
||||
[](https://sourcegraph.com/github.com/hunterlong/statping)
|
||||
|
||||
[](https://github.com/hunterlong/statping/releases/latest)
|
||||
|
||||
[](https://hub.docker.com/r/hunterlong/statup/builds/)
|
||||
[](https://hub.docker.com/r/hunterlong/statping/builds/)
|
||||
|
||||
[](https://goreportcard.com/report/github.com/hunterlong/statping)
|
||||
|
||||
[](https://coveralls.io/github/hunterlong/statping?branch=master)
|
||||
|
||||
[](https://libraries.io/github/hunterlong/statup)
|
||||
[](https://libraries.io/github/hunterlong/statping)
|
||||
|
||||
[[Deployment]]
|
||||
Loading…
Reference in New Issue