Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ngn13/statpage
minimal status page application
https://github.com/ngn13/statpage
statpage status-monitor status-monitoring status-page status-pages
Last synced: about 1 month ago
JSON representation
minimal status page application
- Host: GitHub
- URL: https://github.com/ngn13/statpage
- Owner: ngn13
- License: gpl-3.0
- Created: 2023-11-17T15:52:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-10T23:33:31.000Z (6 months ago)
- Last Synced: 2024-07-11T02:18:06.662Z (6 months ago)
- Topics: statpage, status-monitor, status-monitoring, status-page, status-pages
- Language: Go
- Homepage:
- Size: 2.05 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# statpage | minimal status page application
I use statpage for my own services, so [here is a live demo I guess](https://stats.ngn.tf)
## 📑 Features
- No JavaScript
- Fully customizable and configurable
- Supports status checks for HTTP, HTTPS, TCP and TLS services
- Easy deployment with docker
## 🚀 Setup
### Docker
```bash
mkdir -p statpage/config statpage/data
cd statpage
# copy and edit the example configuration file before
# starting the container - see the configuration section
docker run -d -v $PWD/data:/app/data \
-v $PWD/config:/app/config \
-p 80:8877 \
--name statpage \
ghcr.io/ngn13/statpage:latest
```
Example configuration can be found [here](config/config.json.example)
### Building from source
If you don't want to install statpage with docker, then you will
need to compile it from the source as I do not release any binaries:
```bash
git clone https://github.com/ngn13/statpage.git
cd statpage
go build
```
After that just run: `./statpage`
## ⚙️ Configuration
An example configuration file can be found at [config.json.example](config/config.json.example).
Copy this file to `config/config.json` to get started with the configuration.
> [!NOTE]
> However you will need to restart the application if you edit the `interval` or the `address`
> config options. The other options do not require a restart.
### General config options
- `title`: Title for the status page, this will also be displayed on the header.
- `address`: The interface and the port that statpage will listen on
- `contact`: Contact URL that will be displayed at the bottom of the page
- `interval`: Service check interval
- `reset`: When there is as much check results as `reset`, a new result will drop the oldest result in the list
- `time`: Enable/disable showing response times
- `services`: List of services to check
### Service config options
- `name`: Service name
- `address`: Service address, **NOT THE URL**. If you want to check `https://example.com:9191`,
`address` would be `example.com:9191`.
- `type`: Service type. Options are: `HTTP`, `HTTPS`, `TCP` and `TLS`
- `data`: Data that will be sent. If you are using `HTTP` or `HTTPS` as the `type` then this
would be the path. If you are using `TCP` or `TLS` as the `type` then this would be the raw
data to send
- `link`: Link to the service that will be displayed. If you don't want to add a link, then leave
this one empty, aka set it to `""`
- `rule`: Rule for the service check
### Rule config options
- `contains`: The service status will be `up` if the service response contains this data.
- `not_contains`: The service status will be `down` if the service response contains this data.
You can use both of these options at the same time, keep in mind that `not_contains` have priority
over `contains`
## ✨ Customization
If you want to customize the status page, check out [theme.css.example](config/theme.css.example)
file to get started.
## 📃 Licenses
This project is licensed under GNU General Public License version 3 (GPLv3). Please see
[LICENSE.txt](LICENSE.txt) for more information.
License for [NerdFonts](https://github.com/ryanoasis/nerd-fonts), which is the font used in
the application, can be found [here](https://github.com/ryanoasis/nerd-fonts/blob/master/LICENSE).