{"id":13554788,"url":"https://github.com/lexoyo/Monitoshi","last_synced_at":"2025-04-03T07:32:50.576Z","repository":{"id":26121904,"uuid":"29566421","full_name":"lexoyo/Monitoshi","owner":"lexoyo","description":"Website uptime monitoring","archived":false,"fork":false,"pushed_at":"2023-02-27T15:40:24.000Z","size":799,"stargazers_count":79,"open_issues_count":13,"forks_count":19,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-11-01T13:05:07.351Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://monitoshi.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lexoyo.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-01-21T02:15:04.000Z","updated_at":"2023-11-27T21:12:52.000Z","dependencies_parsed_at":"2024-08-01T12:36:57.391Z","dependency_job_id":null,"html_url":"https://github.com/lexoyo/Monitoshi","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lexoyo%2FMonitoshi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lexoyo%2FMonitoshi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lexoyo%2FMonitoshi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lexoyo%2FMonitoshi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lexoyo","download_url":"https://codeload.github.com/lexoyo/Monitoshi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222935625,"owners_count":17060398,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T12:02:54.887Z","updated_at":"2024-11-04T03:31:18.150Z","avatar_url":"https://github.com/lexoyo.png","language":"JavaScript","readme":"# Monitoshi, website uptime monitoring\n\n## About\n\nPing URLs and send email alerts when it is down or goes up again.\n\nI have [an instance online here](https://monitoshi.lexoyo.me/), feel free to use it - I use it myself to monitor my websites.\n\n### How does it work?\n\nYou 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.\n\n### Links\n\n[Roadmap is here](https://github.com/lexoyo/Monitoshi/issues/1) and [feature requests can be done here](https://github.com/lexoyo/Monitoshi/issues/).\n\n### Badges\n\nIn the email you will receive upon creation of a new monitor, there will be the URL of a badge like this one:\n\n![silexlabs.org status by monitoshi](http://monitoshi.lexoyo.me/badge/1477987707192-1847)\n\nUse it with markdown to display if your service is up or down, on a status page or in the README of your project.\n\n## Install locally\n\nRequirements\n\n* [Node.js](http://nodejs.org/)\n* [MongoDB](https://www.mongodb.org/) installed and running (`npm run serve` or `mongod --dbpath ./data`)\n\n1- Checkout this repository (`git clone https://github.com/lexoyo/Monitoshi.git \u0026\u0026 cd Monitoshi`)\n\n2- copy `config-sample.js` to `sample.js`, and edit this file to **change at least the mail options to send emails**. Monitoshi uses [Nodemailer](https://nodemailer.com/) 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](https://nodemailer.com/) or [Using Gmail section](https://nodemailer.com/using-gmail/) (gmail is really a poor solution, I use SMTP).\n\nAsk me any questions about this in the github issues of the project.\n\nFor production, see bellow the \"Other way to change the config\".\n\n3- run this to install dependecies:\n\n```\n    $ npm install\n```\n\n4- Then start the server with this command (mongodb needs to be running)\n\n```\n    $ node app\n```\n\nAlternatively you can use the excellent [pm2 process manager](http://pm2.keymetrics.io/) to start the server:\n\n```\n    $ pm2 start .pm2.json\n```\n\n### Other way to change the config\n\nThe `MT_CONFIG` environment variable may contain a config json string, like the provided sample [config-sample.js](https://github.com/lexoyo/Monitoshi/blob/master/config-sample.js) but without line breaks. Alternatively you can provide the path of a json file (also like [config-sample.js](https://github.com/lexoyo/Monitoshi/blob/master/config-sample.js)) in the environment variable `MT_CONFIG_FILE`. Last method you can use for the config: if you use [Heroku](https://www.heroku.com) for hosting, see [how to set environment variables on your VM](https://devcenter.heroku.com/articles/config-vars), and this [useful plugin to handle config](https://github.com/ddollar/heroku-config).\n\nUse `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.\n\n### Example of config\n\n```\n{\n    \"interval\": 10000,\n    \"timeout\": 10000,\n    \"attempts\": 3\n}\n```\n\n## Contributions and road map\n\nLet's [talk about it in this thread](https://github.com/lexoyo/Monitoshi/issues/1).\n\n## Notes for developers\n\n### Routes\n\nYou can use monitoshi as is, reaching the routes listed bellow with a web browser or use it as an API with `\u0026format=json` at the end of the URLs in order to have JSON responses instead of HTML messages.\n\nHere are the app routes\n\n* POST /monitor =\u003e add a monitor\n* GET /monitor/:id/enable =\u003e enable a monitor, has to be called after a new monitor is added\n* GET /monitor/:id/disable =\u003e disable a monitor, for tests\n* GET /monitor/:id/del =\u003e remove a monitor, for tests\n* GET /monitor/[MONITOSHI_ADMIN_PASS] =\u003e debug only (when the env var `MONITOSHI_ADMIN_PASS` is defined), displays all monitors\n\n## License\n\nlicense: GPL v2\n\n## Roadmap\n\ntodo: move these ideas to https://github.com/lexoyo/Monitoshi/issues/1\n\ndev\n\n* cleanup index.js, create Router, use email aert...\n* check if exist before add\n* badge \"http://...........com is UP\"\n* remove unconfirmed monitors\n* on \"/\" display how many urls are tracked and the medium tracking interval\n* list all URLs monitored by a given email adress\n* Concurrent HTTP requests in node.js - doduck http://doduck.com/concurrent-requests-node-js/\n* monitoshi.org ?\n* embed on monitoshi's home page\n* embed in silex?\n\nemails\n\n* better design\n* footer with links: to the badge, github issues, home page, list of monitored urls\n* call to contribution or ads for free software\n\nmore features\n\n* captcha\n* webhook, ifttt ...\n* Trace route https://www.npmjs.com/package/traceroute\n* handle post requests, ftp ...\n* host instances in multiple locations\n\n___\n\ncom\n\n* pub pour silex dans les mails (du même auteur que monitoshi), ou pour d'autres projets foss...\n* partage FB / Twitter /...? Pour supporter le projet ? Garantir ping 30 min ?\n","funding_links":[],"categories":["JavaScript","others"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flexoyo%2FMonitoshi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flexoyo%2FMonitoshi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flexoyo%2FMonitoshi/lists"}