reustonium/uptime-sentry

uptime website monitoring application

Uptime Sentry

Website uptime monitor

Uptime Sentry is an open-sourced and free website uptime monitor. It runs on the docker engine for easy deployment.

This repository contains:

1. The front-end client application created with Vuejs.
2. The backend API created with Express.
3. A mongodb database for storing monitor data.

Table of Contents

• Background
• Prerequisites
• Running Uptime Sentry
• Running Uptime Sentry in Development Mode
• Usage
  • Adding a Monitor
• Contribute
• Change Log
• License

Background

Uptime Sentry's purpose is to provide a light-weight application for monitoring all of your web applications and services. Uptime Sentry was born from the need for monitoring applications living behind the firewall, in the DMZ, or generally anywhere else that Uptime Robot can't reach.

Prerequisites

• Docker
• Docker-Compose

Running Uptime Sentry

1. Begin by cloning the repository
   git clone https://github.com/reustonium/uptime-sentry.git

2. Start Uptime Sentry by calling the Docker Compose Up command.
   docker-compose up

3. Point your browser to localhost:8080

Running Uptime Sentry in Development Mode

Prerequisites include mongodb, nodejs, and a modern web browser.

1. Start mongodb
2. Start the Server

• Install yarn npm install -g yarn
• Install server dependencies cd server && yarn
• Start the server (from the \server directory) yarn server

3. Start the client

• Install client dependencies (from the \client directory) yarn
• Start the Client (from the \client directory) yarn dev

Usage

Adding a Monitor

Contributing

Please read CONTRIBUTING.md for more details.

TLDR

1. Fork this repository
2. Create a branch
3. Commit your changes
4. Push your commits to the branch
5. Submit a pull request

Check also the list of contributors who helped on this project.

Changelog

License

Uptime Sentry is licensed under the MIT license.