search

lexoyo / Monitoshi

Website uptime monitoring
https://monitoshi.com
79 stars 19 forks source link

readme

Monitoshi, website uptime monitoring

About

Ping URLs and send email alerts when it is down or goes up again.

I have an instance online here, feel free to use it - I use it myself to monitor my websites.

How does it work?

You submit an URL to Monitoshi, along with your email adress, to receive a confirmation link by email. Then Monitoshi will send emails when the URL goes down or up again. In the emails you also have a link to remove your URL and email from Monitoshi's list.

Links

Roadmap is here and feature requests can be done here.

Badges

In the email you will receive upon creation of a new monitor, there will be the URL of a badge like this one:

silexlabs.org status by monitoshi

Use it with markdown to display if your service is up or down, on a status page or in the README of your project.

Install locally

Requirements

1- Checkout this repository (git clone https://github.com/lexoyo/Monitoshi.git && cd Monitoshi)

2- copy config-sample.js to sample.js, and edit this file to change at least the mail options to send emails. Monitoshi uses Nodemailer to send emails, and you have to define nodemailer's config in the nodemailer object of your config file. (Monitoshi does nodemailer.createTransport(config.nodemailer). Check nodemailer docs or Using Gmail section (gmail is really a poor solution, I use SMTP).

Ask me any questions about this in the github issues of the project.

For production, see bellow the "Other way to change the config".

3- run this to install dependecies:

    $ npm install

4- Then start the server with this command (mongodb needs to be running)

    $ node app

Alternatively you can use the excellent pm2 process manager to start the server:

    $ pm2 start .pm2.json

Other way to change the config

The MT_CONFIG environment variable may contain a config json string, like the provided sample config-sample.js but without line breaks. Alternatively you can provide the path of a json file (also like config-sample.js) in the environment variable MT_CONFIG_FILE. Last method you can use for the config: if you use Heroku for hosting, see how to set environment variables on your VM, and this useful plugin to handle config.

Use NUM_RUNNERS env var or "num_runners": 100, in the config to set the number of monitors running simultanneously, each one checking 1 website at a time.

Example of config

{
    "interval": 10000,
    "timeout": 10000,
    "attempts": 3
}

Contributions and road map

Let's talk about it in this thread.

Notes for developers

Routes

You can use monitoshi as is, reaching the routes listed bellow with a web browser or use it as an API with &format=json at the end of the URLs in order to have JSON responses instead of HTML messages.

Here are the app routes

License

license: GPL v2

Roadmap

todo: move these ideas to https://github.com/lexoyo/Monitoshi/issues/1

dev

emails

more features

com