Popularity
1.8
-
Activity
9.0
-
17
1
0

Programming language: Java
Tags: Monitoring     Status Pages    
Latest version: v0.8.2
Add another 'Status Pages' Tool

README

Performance & availability monitoring app Built on Spring Boot & Quasar Frameworks Check out the demo

Netcheck lets you monitor the availability and performance of your websites or web services by running on your own servers/machines or hosting providers of your preference. It is inspired by services like Pingdom and Statuscake

This git repository is for the api/backend side of the app. For an easy way to control the app and check the state and performance of your websites check out the Netcheck Frontend Repository and its instructions on how to run it.

WARNING: The app is still under heavy development and quite rough around the edges. Feel free to report any bugs you may encounter, provide feedback or request features you would love to see in the future through the github issues page.

Quick Start

The fastest way to run Netcheck is through docker, and the provided docker-compose.yml file to get all the required dependancies up and running

Running a private instance locally with OpenJDK

Coming soon™

  • Follow the official documentation to install Docker and docker-compose.
  • copy database.env.example to database.env and change the credentials for the db to something more appropriate. This env file is going to be used both by the postgress docker container to init the db as well as the netcheck app in order to connect to it.
  • copy .env.example to .env. The default values are enough for connecting to the db in the previous step. If you want Notifications support through pushover change the SETTINGS_NOTIFICATIONS_PUSHOVER_ENABLED to true and fill the SETTINGS_NOTIFICATIONS_PUSHOVER_APITOKEN and SETTINGS_NOTIFICATIONS_PUSHOVER_USERIDTOKEN with the values you are going to get from Pushover after creating a new app.
  • Execute docker-compose up -d to bring everything up.
  • Visit http://127.0.0.1:8080/docs/v1/ from your favorite browser to check what you can do with the api or bring up the Netcheck frontend by following the instructions in the README file

Running publicly through traefik reverse proxy

Coming soon™

Features: ⚡️ Built on Spring Boot (backend - this repo) and Quasar (Frontend) ⚡️ Support live checking of domains through HTTP and HTTPS ⚡️ Support scheduled checks with predefined check frequency of 5,10 or 15 minutes ⚡️ HTTPS Certificate validation checks ⚡️ Metric Generation for uptime and response times ⚡️ State change notification system (currently supports Pushover)

Other key features coming: ⚡️ Authentication ⚡️ Multi user support ⚡️ Additional notification providers (Pushbullet, Telegram, Discord, Slack, Kafka, etc) ⚡️ Custom endpoint checks ⚡️ Custom request headers on checks ⚡ Additional check implementations ⚡️ Multi location support for the scheduled checks

What is Netcheck Designed For?

Netcheck is designed for realtime monitoring and performance metric collection of websites through scheduled checks. It is similar to 3rd party services like Pingdom, DownDetector and StatusCake.

Netcheck may not include the vast feature set the aforementioned services provide, but it gives you full control over your data and doesn't lock you in to a single provider. And since it is self hosted it can also run exclusively on your intranet/cluster and check non publicly available services.


*Note that all licence references and agreements mentioned in the netcheck README section above are relevant to that project's source code only.