mirror of https://github.com/statping/statping
package name change
Hunter Long
parent
c3813bc52e
commit
df3cd76a1d
10
API.md
10
API.md
|
|
@ -1,11 +1,11 @@
|
|||
Statup includes a RESTFUL API so you can view, update, and edit your services with easy to use routes. You can currently view, update and delete services, view, create, update users, and get detailed information about the Statup instance. To make life easy, try out a Postman or Swagger JSON file and use it on your Statup Server.
|
||||
Statping includes a RESTFUL API so you can view, update, and edit your services with easy to use routes. You can currently view, update and delete services, view, create, update users, and get detailed information about the Statping instance. To make life easy, try out a Postman or Swagger JSON file and use it on your Statping Server.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://documenter.getpostman.com/view/1898229/RzZDhGuD">Postman</a> | <a href="https://github.com/hunterlong/statup/blob/master/source/tmpl/postman.json">Postman JSON Export</a> | <a href="https://github.com/hunterlong/statup/blob/master/dev/swagger.json">Swagger Export</a>
|
||||
</p>
|
||||
|
||||
## Authentication
|
||||
Authentication uses the Statup API Secret to accept remote requests. You can find the API Secret in the Settings page of your Statup server. To send requests to your Statup API, include a Authorization Header when you send the request. The API will accept any one of the headers below.
|
||||
Authentication uses the Statping API Secret to accept remote requests. You can find the API Secret in the Settings page of your Statping server. To send requests to your Statping API, include a Authorization Header when you send the request. The API will accept any one of the headers below.
|
||||
|
||||
- HTTP Header: `Authorization: API SECRET HERE`
|
||||
- HTTP Header: `Authorization: Bearer API SECRET HERE`
|
||||
|
|
@ -72,7 +72,7 @@ Response:
|
|||
```
|
||||
|
||||
## Users
|
||||
The users API endpoint will show you users that are registered inside your Statup instance.
|
||||
The users API endpoint will show you users that are registered inside your Statping instance.
|
||||
|
||||
### View All Users
|
||||
- Endpoint: `/api/users`
|
||||
|
|
@ -204,9 +204,9 @@ Response:
|
|||
```json
|
||||
{
|
||||
"name": "Awesome Status",
|
||||
"description": "An awesome status page by Statup",
|
||||
"description": "An awesome status page by Statping",
|
||||
"footer": "This is my custom footer",
|
||||
"domain": "https://demo.statup.io",
|
||||
"domain": "https://demo.statping.com",
|
||||
"version": "v0.56",
|
||||
"migration_id": 1536768413,
|
||||
"created_at": "2018-09-12T09:06:53.905374829-07:00",
|
||||
|
|
|
|||
10
AWS-EC2.md
10
AWS-EC2.md
|
|
@ -1,4 +1,4 @@
|
|||
Running Statup 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/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.
|
||||
|
||||
# AMI Image
|
||||
Choose the correct AMI Image ID based on your AWS region.
|
||||
|
|
@ -8,7 +8,7 @@ Choose the correct AMI Image ID based on your AWS region.
|
|||
- us-west-2 `ami-7be8a103`
|
||||
|
||||
# EC2 Server Features
|
||||
Running your Statup server on a small EC2 instance is perfect for most users. Below you'll find some commands to get up and running in seconds.
|
||||
Running your Statping server on a small EC2 instance is perfect for most users. Below you'll find some commands to get up and running in seconds.
|
||||
- Super cheap on the t2.nano (~$4.60 monthly)
|
||||
- Small usage, 8gb of hard drive
|
||||
- Automatic SSL certificate if you require it
|
||||
|
|
@ -20,7 +20,7 @@ Running your Statup server on a small EC2 instance is perfect for most users. Be
|
|||
## Create Security Groups
|
||||
Using the AWS CLI you can copy and paste the commands below to auto create everything for you. The server opens port 80 and 443.
|
||||
```bash
|
||||
aws ec2 create-security-group --group-name StatupPublicHTTP --description "Statup HTTP Server on port 80 and 443"
|
||||
aws ec2 create-security-group --group-name StatpingPublicHTTP --description "Statping HTTP Server on port 80 and 443"
|
||||
# will response back a Group ID. Copy ID and use it for --group-id below.
|
||||
```
|
||||
```bash
|
||||
|
|
@ -37,7 +37,7 @@ aws ec2 run-instances \
|
|||
--security-group-ids sg-7e8b830f
|
||||
```
|
||||
## Create EC2 with Automatic SSL Certification
|
||||
This is an awesome way to do things, start a Statup 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.
|
||||
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
|
||||
```
|
||||
|
|
@ -62,6 +62,6 @@ aws ec2 run-instances \
|
|||
- 8gb SSD Memory
|
||||
- 0.5gb RAM
|
||||
- Docker with Docker Compose installed
|
||||
- Running Statup, NGINX, and Postgres
|
||||
- Running Statping, NGINX, and Postgres
|
||||
- boot scripts to automatically clean unused containers.
|
||||
|
||||
|
|
|
|||
|
|
@ -8,14 +8,14 @@ go get -v
|
|||
```
|
||||
|
||||
### Install go.rice
|
||||
Statup uses go.rice to compile HTML, JS, and CSS files into it's single binary output.
|
||||
Statping uses go.rice to compile HTML, JS, and CSS files into it's single binary output.
|
||||
```
|
||||
go get github.com/GeertJohan/go.rice
|
||||
go get github.com/GeertJohan/go.rice/rice
|
||||
```
|
||||
|
||||
### Build Statup Binary
|
||||
Statup uses go.rice to compile HTML, JS, and CSS files into it's single binary output.
|
||||
### Build Statping Binary
|
||||
Statping uses go.rice to compile HTML, JS, and CSS files into it's single binary output.
|
||||
```
|
||||
rice embed-go
|
||||
go build -o statup .
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
It may be useful to load your environment using a `.env` file in the root directory of your Statup server. The .env file will be automatically loaded on startup and will overwrite all values you have in config.yml.
|
||||
It may be useful to load your environment using a `.env` file in the root directory of your Statping server. The .env file will be automatically loaded on startup and will overwrite all values you have in config.yml.
|
||||
|
||||
If you have the `DB_CONN` environment variable set Statup will bypass all values in config.yml and will require you to have the other DB_* variables in place. You can pass in these environment variables without requiring a .env file.
|
||||
If you have the `DB_CONN` environment variable set Statping will bypass all values in config.yml and will require you to have the other DB_* variables in place. You can pass in these environment variables without requiring a .env file.
|
||||
|
||||
## `.env` File
|
||||
```bash
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
Have a feature you want to implement into Statup!? Awesome! Follow this guide to see how you can test, compile and build Statup 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.
|
||||
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
|
||||
Statup 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/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.
|
||||
```bash
|
||||
make dev-deps
|
||||
```
|
||||
|
|
@ -12,7 +12,7 @@ List of requirements for compiling assets, building binary, and testing.
|
|||
- [Cypress](https://www.cypress.io/) (only used for UI testing, `make cypress-install`)
|
||||
|
||||
# Compiling Assets
|
||||
This Golang project uses [rice](https://github.com/GeertJohan/go.rice) to compile static assets into a single file. The file `source/rice-box.go` is never committed to the Github repo, it is automatically created on build. Statup also requires `sass` to be installed on your local OS. To compile all the static assets run the command below:
|
||||
This Golang project uses [rice](https://github.com/GeertJohan/go.rice) to compile static assets into a single file. The file `source/rice-box.go` is never committed to the Github repo, it is automatically created on build. Statping also requires `sass` to be installed on your local OS. To compile all the static assets run the command below:
|
||||
|
||||
```bash
|
||||
make compile
|
||||
|
|
@ -20,9 +20,9 @@ make compile
|
|||
After this is complete, you'll notice the `source/rice-box.go` file has been generated. You can now continue to build, and test.
|
||||
|
||||
# Testing
|
||||
Statup includes multiple ways to Test the application, you can run the `make` command, or the normal `go test` command. To see the full experience of your updates, you can even run Cypress tests which is in the `.dev/test` folder.
|
||||
Statping includes multiple ways to Test the application, you can run the `make` command, or the normal `go test` command. To see the full experience of your updates, you can even run Cypress tests which is in the `.dev/test` folder.
|
||||
|
||||
Statup will run all tests in `cmd` folder on MySQL, Postgres, and SQLite databases. You can run `make databases` to automatically create MySQL and Postgres with Docker.
|
||||
Statping will run all tests in `cmd` folder on MySQL, Postgres, and SQLite databases. You can run `make databases` to automatically create MySQL and Postgres with Docker.
|
||||
|
||||
###### Go Unit Testing:
|
||||
```bash
|
||||
|
|
@ -40,7 +40,7 @@ make test-all
|
|||
```
|
||||
|
||||
# Build
|
||||
Statup will build on all operating systems except Windows 32-bit. I personally use [xgo](https://github.com/karalabe/xgo) to cross-compile on multiple systems using Docker. Follow the commands below to build on your local system.
|
||||
Statping will build on all operating systems except Windows 32-bit. I personally use [xgo](https://github.com/karalabe/xgo) to cross-compile on multiple systems using Docker. Follow the commands below to build on your local system.
|
||||
|
||||
###### Build for local operating system:
|
||||
```bash
|
||||
|
|
@ -48,7 +48,7 @@ make build
|
|||
```
|
||||
|
||||
# Compile for Production
|
||||
Once you've tested and built locally, you can compile Statup for all available operating systems using the command below. This command will require you to have Docker.
|
||||
Once you've tested and built locally, you can compile Statping for all available operating systems using the command below. This command will require you to have Docker.
|
||||
|
||||
```bash
|
||||
make build-all
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
# How Statup is Deployed
|
||||
Statup is a pretty cool server for monitoring your services. The way we deploy might be a little cooler though. Statup is using the most bleeding edge technology to release updates and distribute binary files automatically.
|
||||
# How Statping is Deployed
|
||||
Statping is a pretty cool server for monitoring your services. The way we deploy might be a little cooler though. Statping is using the most bleeding edge technology to release updates and distribute binary files automatically.
|
||||
|
||||
## Deployment Flow
|
||||
Statup has a pretty advanced deployment process that many people will find to be a little too complexed. Below is a flow of how this application is developed and deployed.
|
||||
Statping has a pretty advanced deployment process that many people will find to be a little too complexed. Below is a flow of how this application is developed and deployed.
|
||||
|
||||
- Source code commits get pushed to Github
|
||||
- Travis-CI begins to build the binary application
|
||||
- Go Language builds all binaries with xgo and Docker.
|
||||
- New binaries are compress and released to Github Releases.
|
||||
- Triggers a build on Docker Hub `latest` release, the version tag is triggered when tag is set.
|
||||
- Triggers Travis build for Statup Homebrew repo to recreate the Formula for brew.
|
||||
- Triggers Travis build for Statping Homebrew repo to recreate the Formula for brew.
|
||||
- Travis recreates statup.repo Formula and commits back to master.
|
||||
|
||||
|
|
|
|||
10
Docker.md
10
Docker.md
|
|
@ -5,19 +5,19 @@ docker run -it -p 8080:8080 hunterlong/statup
|
|||
```
|
||||
|
||||
# Development Docker Image
|
||||
If you want to run Statup that was build from the source, use the `dev` 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
|
||||
```
|
||||
|
||||
# Cypress Testing Docker Image
|
||||
This Docker image will pull the latest version of Statup and test the web interface with [Cypress](https://www.cypress.io/).
|
||||
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
|
||||
```
|
||||
|
||||
#### Or use Docker Compose
|
||||
This Docker Compose file inlcudes NGINX, Postgres, and Statup.
|
||||
This Docker Compose file inlcudes NGINX, Postgres, and Statping.
|
||||
|
||||
### Docker Compose with NGINX and Postgres
|
||||
Once you initiate the `docker-compose.yml` file below go to http://localhost and you'll be forwarded to the /setup page.
|
||||
|
|
@ -71,7 +71,7 @@ services:
|
|||
DB_PASS: password123
|
||||
DB_DATABASE: statup
|
||||
NAME: EC2 Example
|
||||
DESCRIPTION: This is a Statup Docker Compose instance
|
||||
DESCRIPTION: This is a Statping Docker Compose instance
|
||||
|
||||
postgres:
|
||||
container_name: postgres
|
||||
|
|
@ -99,7 +99,7 @@ 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.
|
||||
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
|
||||
|
||||
|
|
|
|||
12
Features.md
12
Features.md
|
|
@ -1,19 +1,19 @@
|
|||
Statup is a great Status Page that can be deployed with 0 effort.
|
||||
Statping is a great Status Page that can be deployed with 0 effort.
|
||||
|
||||
# 3 Different Databases
|
||||
You can use MySQL, Postgres, or SQLite as a database for your Statup status page. The server will automatically upgrade your database tables depending on which database you have.
|
||||
You can use MySQL, Postgres, or SQLite as a database for your Statping status page. The server will automatically upgrade your database tables depending on which database you have.
|
||||
|
||||
# Easy to Startup
|
||||
Statup 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. Statup works on Windows, Mac, Linux, Docker, and even the Raspberry Pi.
|
||||
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
|
||||
Statup 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 Statup `/plugins` folder. Test your plugins using the `statup test plugin` command, checkout the [Plugin Wiki](https://github.com/hunterlong/statup/wiki/Statup-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/statup/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. Statup 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. Statup will automatically upgrade its software when you reboot your computer.
|
||||
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.
|
||||
|
||||
# Email & Slack Notifications
|
||||
Receive email notifications if your website or application goes offline. Statup includes SMTP connections so you can use AWS SES, or any other SMTP emailing service. Go in the Email Settings in Settings to configure these options.
|
||||
Receive email notifications if your website or application goes offline. Statping includes SMTP connections so you can use AWS SES, or any other SMTP emailing service. Go in the Email Settings in Settings to configure these options.
|
||||
|
||||
# Prometheus Exporter
|
||||
If you want a deeper view of your applications status, you can use Grafana and Prometheus to graph all types of data about your services.
|
||||
24
Home.md
24
Home.md
|
|
@ -3,14 +3,14 @@
|
|||
<img width="70%" src="https://img.cjx.io/statuptokenbalance.gif">
|
||||
</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.
|
||||
# Statping - Status Page
|
||||
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.
|
||||
|
||||
## 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.
|
||||
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.
|
||||
|
||||
## 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.
|
||||
Statping 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.
|
||||
|
|
@ -22,27 +22,27 @@ This Status Page generator allows you to use MySQL, Postgres, or SQLite.
|
|||
</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.
|
||||
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.
|
||||
|
||||
## 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.
|
||||
Whether you're a Docker fan-boy or a AWS EC2 master, Statping 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 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.
|
||||
|
||||
## Notifications
|
||||
Statup includes multiple Notifiers to alert you when your services are offline. You can also create your own notifier and send a Push Request to this repo!
|
||||
Statping includes multiple Notifiers to alert you when your services are offline. You can also create your own notifier and send a Push Request to this repo!
|
||||
<p align="center">
|
||||
<img width="80%" src="https://s3-us-west-2.amazonaws.com/gitimgs/statupnotifier.png">
|
||||
</p>
|
||||
Creating a custom notifier is pretty easy as long as you follow the requirements. A notifier will automatically be installed into the users Statup database, and form values will save without any hassles. 💃
|
||||
Creating a custom notifier is pretty easy as long as you follow the requirements. A notifier will automatically be installed into the users Statping database, and form values will save without any hassles. 💃
|
||||
|
||||
## 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.
|
||||
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
|
||||
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.
|
||||
If you want to use Statping 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
|
||||
|
|
|
|||
12
Linux.md
12
Linux.md
|
|
@ -1,5 +1,5 @@
|
|||
# Installing on Linux
|
||||
Installing Statup on Linux is a 1 line command. It's that easy.
|
||||
Installing Statping on Linux is a 1 line command. It's that easy.
|
||||
```
|
||||
bash <(curl -s https://assets.statup.io/install.sh)
|
||||
statup version
|
||||
|
|
@ -7,11 +7,11 @@ statup version
|
|||
[](https://snapcraft.io/statup)
|
||||
|
||||
## Systemd Service
|
||||
Setting up a systemd service is a great way to make sure your Statup server will automatically reboot when needed. You can use the file below for your service. You should have Statup already installed by this step.
|
||||
Setting up a systemd service is a great way to make sure your Statping server will automatically reboot when needed. You can use the file below for your service. You should have Statping already installed by this step.
|
||||
###### /etc/systemd/system/statup.service
|
||||
```
|
||||
[Unit]
|
||||
Description=Statup Server
|
||||
Description=Statping Server
|
||||
After=network.target
|
||||
After=systemd-user-sessions.service
|
||||
After=network-online.target
|
||||
|
|
@ -32,10 +32,10 @@ systemctl enable statup.service
|
|||
|
||||
systemctl start statup
|
||||
```
|
||||
You're Statup server will now automatically restart when your server restarts.
|
||||
You're Statping server will now automatically restart when your server restarts.
|
||||
|
||||
## Raspberry Pi
|
||||
You can even run Statup on your Raspberry Pi by installing the precompiled binary from [Latest Releases](https://github.com/hunterlong/statup/releases/latest). For the Raspberry Pi 3 you'll want to download the `statup-linux-arm7.tar.gz` file. Be sure to change `VERSION` to the latest version in Releases, and include the 'v'.
|
||||
You can even run Statping on your Raspberry Pi by installing the precompiled binary from [Latest Releases](https://github.com/hunterlong/statup/releases/latest). For the Raspberry Pi 3 you'll want to download the `statup-linux-arm7.tar.gz` file. Be sure to change `VERSION` to the latest version in Releases, and include the 'v'.
|
||||
|
||||
```
|
||||
VERSION=$(curl -s "https://github.com/hunterlong/statup/releases/latest" | grep -o 'tag/[v.0-9]*' | awk -F/ '{print $2}')
|
||||
|
|
@ -48,4 +48,4 @@ statup version
|
|||
```
|
||||
|
||||
## Alpine Linux
|
||||
The Docker image is using the Statup Alpine binary since it's so incredibly small. You can run it on your own alpine image by downloading `statup-linux-alpine.tar.gz` from [Latest Releases](https://github.com/hunterlong/statup/releases/latest).
|
||||
The Docker image is using the Statping Alpine binary since it's so incredibly small. You can run it on your own alpine image by downloading `statup-linux-alpine.tar.gz` from [Latest Releases](https://github.com/hunterlong/statup/releases/latest).
|
||||
2
Mac.md
2
Mac.md
|
|
@ -1,5 +1,5 @@
|
|||
# Installing on Mac
|
||||
Statup includes an easy to use [Homebrew Formula](https://github.com/hunterlong/homebrew-statup) to quick get your Status Page up and running locally. Statup on brew is automatically generated for each new release to master. Install with the commands below,
|
||||
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 install statup
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ make run
|
|||
make test
|
||||
make coverage
|
||||
make docs
|
||||
# Building Statup
|
||||
# Building Statping
|
||||
make build-all
|
||||
make build-alpine
|
||||
make docker
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Statup has a free mobile app so you can monitor your websites and applications without the need of a computer. It's currently in **beta** on Google Play and the App Store, try it out!
|
||||
Statping has a free mobile app so you can monitor your websites and applications without the need of a computer. It's currently in **beta** on Google Play and the App Store, try it out!
|
||||
|
||||
<p align="center">
|
||||
<a href="https://play.google.com/store/apps/details?id=com.statup"><img src="https://img.cjx.io/google-play.svg"></a>
|
||||
|
|
@ -14,12 +14,12 @@ Statup has a free mobile app so you can monitor your websites and applications w
|
|||
- [x] Enable/disable and update **Notification** settings
|
||||
- [x] **Push Notifications** when a service is online or offline
|
||||
- [x] View **Logs** in real time
|
||||
- [x] **Settings** screen with useful information about your Statup instance.
|
||||
- [x] **Settings** screen with useful information about your Statping instance.
|
||||
- [ ] View, create and edit **Checkin's**
|
||||
- [ ] Change Statup Settings (CDN, timezone, footer, etc)
|
||||
- [ ] Change Statping Settings (CDN, timezone, footer, etc)
|
||||
- [ ] Show logs for outgoing Notifications
|
||||
|
||||
The mobile app connects to your Statup API to view, edit, and delete values.
|
||||
The mobile app connects to your Statping API to view, edit, and delete values.
|
||||
|
||||
<p align="center">
|
||||
<img width="40%" src="https://user-images.githubusercontent.com/7519499/48435584-b7ed5c00-e731-11e8-818a-8faf28a2fb54.gif">
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Below is a full example of a Statup 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!
|
||||
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)
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
<img width="80%" src="https://s3-us-west-2.amazonaws.com/gitimgs/statupnotifiers.png">
|
||||
</p>
|
||||
|
||||
Statup includes multiple Notifiers to alert you when your services are offline. You can also create your own notifier and send a Push Request to this repo! Creating a custom notifier is pretty easy as long as you follow the requirements. A notifier will automatically be installed into the users Statup database, and form values will save without any hassles. 💃
|
||||
Statping includes multiple Notifiers to alert you when your services are offline. You can also create your own notifier and send a Push Request to this repo! Creating a custom notifier is pretty easy as long as you follow the requirements. A notifier will automatically be installed into the users Statping database, and form values will save without any hassles. 💃
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/hunterlong/statup/wiki/Notifier-Example">Example Code</a> | <a href="https://github.com/hunterlong/statup/wiki/Notifier-Events">Events</a> | <a href="https://github.com/hunterlong/statup/tree/master/notifiers">View Notifiers</a><br>
|
||||
|
|
@ -16,7 +16,7 @@ Statup includes multiple Notifiers to alert you when your services are offline.
|
|||
- Should have a form for user to input their variables/keys. `Form: []notifier.NotificationForm`
|
||||
|
||||
## Notifier Interface (required)
|
||||
Statup has the `Notifier` interface which you'll need to include in your notifier. Statup includes many other events/triggers for your notifier, checkout <a href="https://github.com/hunterlong/statup/wiki/Notifier-Events">Notifier Events</a> to see all of them.
|
||||
Statping has the `Notifier` interface which you'll need to include in your notifier. Statping includes many other events/triggers for your notifier, checkout <a href="https://github.com/hunterlong/statup/wiki/Notifier-Events">Notifier Events</a> to see all of them.
|
||||
```go
|
||||
// Notifier interface is required to create a new Notifier
|
||||
type Notifier interface {
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
You can check if the Statup binary you downloaded is authentic by running a few commands.
|
||||
You can check if the Statping binary you downloaded is authentic by running a few commands.
|
||||
|
||||
### Steps to Authenticate
|
||||
1. Download the Statup `tar.gz` file from [Latest Releases](https://github.com/hunterlong/statup/releases/latest) and extract the Statup binary and the `statup.asc` file.
|
||||
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.
|
||||
2. Run command: `gpg --verify statup.asc`
|
||||
3. You should see `Good signature from "Hunter Long <info@statup.io>" [ultimate]`.
|
||||
3. You should see `Good signature from "Hunter Long <info@statping.com>" [ultimate]`.
|
||||
|
||||
# Statup Public Key
|
||||
# Statping Public Key
|
||||
You can also download the key with the command below:
|
||||
```
|
||||
wget -O statup.gpg https://raw.githubusercontent.com/hunterlong/statup/master/dev/statup.gpg
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
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.
|
||||
Statping 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 Statping API Secret for the Authorization Bearer header, the `/metrics` URL is dedicated for Prometheus and requires the correct API Secret has `Authorization` header.
|
||||
|
||||
# Grafana Dashboard
|
||||
Statup has a [Grafana Dashboard](https://grafana.com/dashboards/6950) that you can quickly implement if you've added your Statup service to Prometheus. Import Dashboard ID: `6950` into your Grafana dashboard and watch the metrics come in!
|
||||
Statping has a [Grafana Dashboard](https://grafana.com/dashboards/6950) that you can quickly implement if you've added your Statping service to Prometheus. Import Dashboard ID: `6950` into your Grafana dashboard and watch the metrics come in!
|
||||
|
||||
<p align="center"><img width="80%" src="https://img.cjx.io/statupgrafana.png"></p>
|
||||
|
||||
## Basic Prometheus Exporter
|
||||
If you have Statup and the Prometheus server in the same Docker network, you can use the yaml config below.
|
||||
If you have Statping and the Prometheus server in the same Docker network, you can use the yaml config below.
|
||||
```yaml
|
||||
scrape_configs:
|
||||
- job_name: 'statup'
|
||||
|
|
@ -37,9 +37,9 @@ statup_service_latency{id="1" name="Google"} 12
|
|||
statup_service_online{id="1" name="Google"} 1
|
||||
statup_service_status_code{id="1" name="Google"} 200
|
||||
statup_service_response_length{id="1" name="Google"} 10777
|
||||
statup_service_failures{id="2" name="Statup.io"} 0
|
||||
statup_service_latency{id="2" name="Statup.io"} 3
|
||||
statup_service_online{id="2" name="Statup.io"} 1
|
||||
statup_service_status_code{id="2" name="Statup.io"} 200
|
||||
statup_service_response_length{id="2" name="Statup.io"} 2
|
||||
statup_service_failures{id="2" name="Statping.com"} 0
|
||||
statup_service_latency{id="2" name="Statping.com"} 3
|
||||
statup_service_online{id="2" name="Statping.com"} 1
|
||||
statup_service_status_code{id="2" name="Statping.com"} 200
|
||||
statup_service_response_length{id="2" name="Statping.com"} 2
|
||||
```
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
Statup is built for many different operating systems, choose yours below.
|
||||
Statping is built for many different operating systems, choose yours below.
|
||||
|
||||
# MacOS
|
||||
```shell
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
If you want to use Statup as a CLI application without running a server, you can export your status page to a static HTML.
|
||||
If you want to use Statping 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
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
You might have a server that won't allow you to run command that run longer for 60 seconds, or maybe you just want to export your status page to a static HTML file. Using the Statup exporter you can easily do this with 1 command.
|
||||
You might have a server that won't allow you to run command that run longer for 60 seconds, or maybe you just want to export your status page to a static HTML file. Using the Statping exporter you can easily do this with 1 command.
|
||||
|
||||
```
|
||||
statup export
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
Since Statup 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. Statup has an event anytime anything happens, you can create your own plugins and do any type of function. To implement your own ideas into Statup, 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/statup/blob/master/plugin/main.go) package.
|
||||
```
|
||||
go get github.com/hunterlong/statup/plugin
|
||||
```
|
||||
|
||||
## Example Plugin
|
||||
Start off with the [Example Statup 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/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!
|
||||
|
||||
<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 Statup directory and reboot the application. Clone the [Example Statup 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/statup_plugin) repo and try to build it yourself!
|
||||
|
||||
#### Build Requirements
|
||||
- You must have `main.go`
|
||||
|
|
@ -22,10 +22,10 @@ git clone https://github.com/hunterlong/statup_plugin
|
|||
cd statup-plugin
|
||||
go build -buildmode=plugin -o example.so
|
||||
```
|
||||
###### Insert `example.so` into the `plugins` directory and reload Statup
|
||||
###### Insert `example.so` into the `plugins` directory and reload Statping
|
||||
|
||||
## Testing Statup Plugins
|
||||
Statup includes a couple tools to help you on your Plugin journey, you can use `statup test plugins` command to test all plugins in your `/plugins` folder. This test will attempt to parse your plugin details, and then it will send events for your plugin to be fired.
|
||||
## Testing Statping Plugins
|
||||
Statping includes a couple tools to help you on your Plugin journey, you can use `statup test plugins` command to test all plugins in your `/plugins` folder. This test will attempt to parse your plugin details, and then it will send events for your plugin to be fired.
|
||||
```
|
||||
statup test plugins
|
||||
```
|
||||
|
|
@ -33,10 +33,10 @@ statup test plugins
|
|||
<img width="85%" src="https://img.cjx.io/statupplugintester.gif">
|
||||
</p>
|
||||
|
||||
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. Statup 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.
|
||||
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.
|
||||
|
||||
## Statup Plugin Interface
|
||||
Please remember Golang plugin's are very new and Statup 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.
|
||||
## 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.
|
||||
```go
|
||||
type PluginActions interface {
|
||||
GetInfo() Info
|
||||
|
|
@ -61,14 +61,14 @@ type PluginActions interface {
|
|||
```
|
||||
|
||||
## Event Parameters
|
||||
All event interfaces for the Statup Plugin will return a `map[string]interface{}` type, this is because the plugin package will most likely update and change in the future, but using this type will allow your plugin to continue even after updates.
|
||||
All event interfaces for the Statping Plugin will return a `map[string]interface{}` type, this is because the plugin package will most likely update and change in the future, but using this type will allow your plugin to continue even after updates.
|
||||
|
||||
## Example of an Event
|
||||
Knowing what happens during an event is important for your plugin. For example, lets have an event that echo something when a service has a Failure status being issued. Checkout some example below to see how this golang plugin action works.
|
||||
|
||||
```go
|
||||
func (p pkg) OnSuccess(data map[string]interface{}) {
|
||||
fmt.Println("Statup Example Plugin received a successful service hit! ")
|
||||
fmt.Println("Statping Example Plugin received a successful service hit! ")
|
||||
fmt.Println("Name: ", data["Name"])
|
||||
fmt.Println("Domain: ", data["Domain"])
|
||||
fmt.Println("Method: ", data["Method"])
|
||||
|
|
@ -88,7 +88,7 @@ func OnFailure(service map[string]interface{}) {
|
|||
```go
|
||||
func (p pkg) OnLoad(db sqlbuilder.Database) {
|
||||
fmt.Println("=============================================================")
|
||||
fmt.Printf(" Statup Example Plugin Loaded using %v database\n", db.Name())
|
||||
fmt.Printf(" Statping Example Plugin Loaded using %v database\n", db.Name())
|
||||
fmt.Println("=============================================================")
|
||||
}
|
||||
```
|
||||
|
|
@ -96,7 +96,7 @@ func (p pkg) OnLoad(db sqlbuilder.Database) {
|
|||
|
||||
|
||||
## Interacting with Database
|
||||
The Example Statup Plugin includes a variable `Database` that will allow you to interact with the Statup 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/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.
|
||||
```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 Statup 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/statup_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,4 +1,4 @@
|
|||
Statup includes a simple to use installation shell script that will help you install locally, Docker, and even onto a AWS EC2 instance.
|
||||
Statping includes a simple to use installation shell script that will help you install locally, Docker, and even onto a AWS EC2 instance.
|
||||
|
||||
<p align="center">
|
||||
<img width="90%" src="https://img.cjx.io/statuper1.png">
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
If you want to test your updates with the current golang testing units, you can follow the guide below to run a full test process. Each test for Statup will run in MySQL, Postgres, and SQlite to make sure all database types work correctly.
|
||||
If you want to test your updates with the current golang testing units, you can follow the guide below to run a full test process. Each test for Statping will run in MySQL, Postgres, and SQlite to make sure all database types work correctly.
|
||||
|
||||
## Create Docker Databases
|
||||
The easiest way to run the tests on all 3 databases is by starting temporary databases servers with Docker. Docker is available for Linux, Mac and Windows. You can download/install it by going to the [Docker Installation](https://docs.docker.com/install/) site.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
# Installing on Windows
|
||||
Currently, Statup only works on Windows 64-bit computers. Just download the exe file from [Latest Releases](https://github.com/hunterlong/statup/releases/latest) and run it in your command prompt. It will create a HTTP server on port 8080, so you can visit `http://localhost:8080` to see your Statup Status Page.
|
||||
Currently, Statping only works on Windows 64-bit computers. Just download the exe file from [Latest Releases](https://github.com/hunterlong/statup/releases/latest) and run it in your command prompt. It will create a HTTP server on port 8080, so you can visit `http://localhost:8080` to see your Statping Status Page.
|
||||
|
||||
## Known Issues with Windows
|
||||
Unfortunately, Statup only works on Windows 64-bit processors. If you have more than 4gb of ram, there's a good chance you already have a 64-bit processor. Download the [Latest Releases](https://github.com/hunterlong/statup/releases/latest) of Statup, extract the ZIP file, then double click on the `statup.exe` file. You can use a SQLite database for a quick setup, or connect to a local/remote Postgres or MySQL database server.
|
||||
Unfortunately, Statping only works on Windows 64-bit processors. If you have more than 4gb of ram, there's a good chance you already have a 64-bit processor. Download the [Latest Releases](https://github.com/hunterlong/statup/releases/latest) of Statping, extract the ZIP file, then double click on the `statup.exe` file. You can use a SQLite database for a quick setup, or connect to a local/remote Postgres or MySQL database server.
|
||||
|
|
@ -1,3 +1,3 @@
|
|||
<p align="center">
|
||||
<a href="https://statup.io">Statup.io</a> | <a href="https://demo.statup.io">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/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>
|
||||
</p>
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
# Overview
|
||||
|
||||
[[Start Statup]]
|
||||
[[Start Statping]]
|
||||
|
||||
[[Features]]
|
||||
|
||||
|
|
@ -32,7 +32,7 @@
|
|||
|
||||
# Extras
|
||||
|
||||
[[Statup Plugins]]
|
||||
[[Statping Plugins]]
|
||||
|
||||
[[Config with .env File]]
|
||||
|
||||
|
|
@ -46,7 +46,7 @@
|
|||
|
||||
# Contact
|
||||
|
||||
Email: `info@statup.io`
|
||||
Email: `info@statping.com`
|
||||
|
||||
[](https://gitter.im/statup-app/general) `statup-app`
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue