{"id":20176654,"url":"https://github.com/sqall01/alertr","last_synced_at":"2025-04-06T10:14:40.612Z","repository":{"id":19479037,"uuid":"22724610","full_name":"sqall01/alertR","owner":"sqall01","description":"A client/server based multi-purpose alarm and monitoring system","archived":false,"fork":false,"pushed_at":"2023-05-22T21:40:33.000Z","size":14468,"stargazers_count":320,"open_issues_count":1,"forks_count":60,"subscribers_count":43,"default_branch":"master","last_synced_at":"2025-03-30T09:08:36.299Z","etag":null,"topics":["alarm","alarm-system","home-automation","home-automation-system","monitoring","monitoring-systems","python","python3"],"latest_commit_sha":null,"homepage":"https://alertr.de","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sqall01.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"github":"sqall01","patreon":"sqall","custom":["paypal.me/sqall"]}},"created_at":"2014-08-07T14:37:56.000Z","updated_at":"2025-03-27T20:51:42.000Z","dependencies_parsed_at":"2024-12-31T07:22:07.013Z","dependency_job_id":null,"html_url":"https://github.com/sqall01/alertR","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqall01%2FalertR","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqall01%2FalertR/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqall01%2FalertR/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqall01%2FalertR/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sqall01","download_url":"https://codeload.github.com/sqall01/alertR/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247464226,"owners_count":20942970,"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":["alarm","alarm-system","home-automation","home-automation-system","monitoring","monitoring-systems","python","python3"],"created_at":"2024-11-14T02:10:31.236Z","updated_at":"2025-04-06T10:14:40.592Z","avatar_url":"https://github.com/sqall01.png","language":"Python","funding_links":["https://github.com/sponsors/sqall01","https://patreon.com/sqall","paypal.me/sqall","https://www.patreon.com/sqall","https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=TVHGG76JVCSGC"],"categories":[],"sub_categories":[],"readme":"![AlertR Logo](docs/alertr_logo_black.png)\n\nAlertR is a client/server based multi-purpose alarm system, monitoring system and signaling system which targets developers, tinkers, privacy advocates, and all people that are interested in DIY solutions. Despite the obvious use as a home alarm system, it can also be used to help server administrators to monitor their services (or used in any other cases in which sensors are required). Because of the way it is designed, AlertR can be used in any scenario a sensor with the state `triggered` and `normal` has to be monitored. This can be a sensor for a home security or home automation system, but also computer services like a failing HDD drive in a RAID or the availability of a web server.\n\nThe vision for AlertR is to have a single service running that gathers all the information someone wants (like temperature data, service states, or bank account transfers) and provides the ability to react on them automatically. In addition, it should serve as single point to let the user look up aggregated information of his/her services. All this should be done in such a way that the user is always in control of his/her data and no one besides him/her is able to access them.\n\nThe project is well documented in the [Github Wiki](https://github.com/sqall01/alertR/wiki/) and a community page can be found on [reddit](https://www.reddit.com/r/AlertR/).\n\n\n# Table of Contents\n* [Version](#version)\n* [Media](#media)\n  * [Pictures](#media_pictures)\n  * [Videos](#media_videos)\n* [Installation](#installation)\n* [Update](#update)\n* [Further Notes](#further_notes)\n* [Supporting AlertR](#supporting_alertr)\n* [Licensing and Commercial Use](#licensing)\n* [Bugs and Feedback](#bugs_and_feedback)\n\n\n# Version\n\u003ca name=\"version\"/\u003e\n\nThe current stable version of AlertR is 0.800. The development of AlertR is done in the dev-branch. So if you want to see the next features or just check if the project is still alive, please see the commits in the dev-branch. If you want to see what has changed during the releases in each component, you can check the `CHANGELOG.md` file in the directory of the corresponding component.\n\n\n# Media\n\u003ca name=\"media\"/\u003e\n\nIf you have no idea what AlertR actually is or how you can use it, this section might give you some ideas.\n\n\n## Pictures\n\u003ca name=\"media_pictures\"/\u003e\n\nA picture of a [MagicMirror](https://magicmirror.builders/) showing AlertR system information.\n\n\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"docs/magicmirror.jpg\" /\u003e\n\u003c/div\u003e\n\u003cbr /\u003e\n\nThe following shows a screenshot of the [Android app](https://play.google.com/store/apps/details?id=de.alertr.alertralarmnotification) introduced in version 0.5.\n\n\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"docs/screenshot_android_app.png\" /\u003e\n\u003c/div\u003e\n\u003cbr /\u003e\n\nA screenshot of the console manager in version 0.4.\n\n\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"docs/manager_console_screenshot_v0.4.jpg\" /\u003e\n\u003c/div\u003e\n\u003cbr /\u003e\n\nAn overview of the infrastructure a basic AlertR setup has.\n\n\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"docs/alertR_infrastructure_basic.jpg\" /\u003e\n\u003c/div\u003e\n\u003cbr /\u003e\n\nNumber of active AlertR installations calculated from participants of the voluntary survey.\n\n\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"https://alertr.de/img/graphs/survey_numbers.php\" /\u003e\n\u003c/div\u003e\n\u003cbr /\u003e\n\nNumber of messages sent by the AlertR push service in the last 12 weeks.\n\n\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"https://alertr.de/img/graphs/push_numbers.php\" /\u003e\n\u003c/div\u003e\n\u003cbr /\u003e\n\n\n## Videos\n\u003ca name=\"media_videos\"/\u003e\n\nA short preview of the AlertR alarm and monitoring system in version 0.500. It shows the new AlertR Android app that is able to receive push notifications. Please activate the subtitles to see the description of what I am doing and what is happening.\n\n\u003cdiv align=\"center\"\u003e\n\u003ca href=\"https://www.youtube.com/watch?feature=player_embedded\u0026v=gafnnETwNYA\u0026yt:cc=on\" target=\"_blank\"\u003e\n\u003cimg src=\"https://img.youtube.com/vi/gafnnETwNYA/0.jpg\" width=\"640\" height=\"480\" border=\"10\" /\u003e\n\u003c/a\u003e\n\u003c/div\u003e\n\u003cbr /\u003e\n\nPart of one release was a rule engine, which allows you to set up rules that must be satisfied before an alarm is triggered. Since version 0.700 this rule engine was replaced with the ability to add instrumentation scripts which gives the user even more possibilities to customize alarm processing. Again, the subtitles have to be activated in order to understand what is happening.\n\n\u003cdiv align=\"center\"\u003e\n\u003ca href=\"https://www.youtube.com/watch?feature=player_embedded\u0026v=iP3uPX41QEg\u0026yt:cc=on\" target=\"_blank\"\u003e\n\u003cimg src=\"https://img.youtube.com/vi/iP3uPX41QEg/0.jpg\" width=\"640\" height=\"480\" border=\"10\" /\u003e\n\u003c/a\u003e\n\u003c/div\u003e\n\u003cbr /\u003e\n\nThe next video was published in December 2014 and shows version 0.200 of AlertR. It demonstrates the D-Bus and Kodi (aka XBMC) notification capabilities. Again, the subtitles have to be activated in order to understand what is happening.\n\n\u003cdiv align=\"center\"\u003e\n\u003ca href=\"https://www.youtube.com/watch?feature=player_embedded\u0026v=r7caH_UzKms\u0026yt:cc=on\" target=\"_blank\"\u003e\n\u003cimg src=\"https://img.youtube.com/vi/r7caH_UzKms/0.jpg\" width=\"640\" height=\"480\" border=\"10\" /\u003e\n\u003c/a\u003e\n\u003c/div\u003e\n\u003cbr /\u003e\n\nThe following video is a short introduction video of AlertR as a home alarm system. It was the first video showing AlertR. The subtitles have to be activated in order to understand what is happening.\n\n\u003cdiv align=\"center\"\u003e\n\u003ca href=\"https://www.youtube.com/watch?feature=player_embedded\u0026v=TxhOPqBhqX8\u0026yt:cc=on\" target=\"_blank\"\u003e\n\u003cimg src=\"https://img.youtube.com/vi/TxhOPqBhqX8/0.jpg\" width=\"640\" height=\"480\" border=\"10\" /\u003e\n\u003c/a\u003e\n\u003c/div\u003e\n\u003cbr /\u003e\n\n\n# Installation\n\u003ca name=\"installation\"/\u003e\n\nTo install an AlertR system, please use the installation script. A detailed description of how to install an AlertR instance is given in the [Installation](https://github.com/sqall01/alertR/wiki/Installation) section of the wiki.\n\n\n# Update\n\u003ca name=\"update\"/\u003e\n\nIf you have already a working AlertR system installed and a newer version is available, use the update script to update your AlertR instances. A detailed description of how to update an AlertR instance is given in the [Update](https://github.com/sqall01/alertR/wiki/Update) section of the wiki.\n\n\n# Further Notes\n\u003ca name=\"further_notes\"/\u003e\n\nIf you are interested in AlertR and its development, you can also read AlertR related articles in my personal [Blog](http://h4des.org/blog/index.php?/categories/22-alertR). To post your awesome projects, see recent news about AlertR, or ask a community for help you can use [reddit](https://www.reddit.com/r/AlertR/).\n\n\n# Supporting AlertR\n\u003ca name=\"supporting_alertr\"/\u003e\n\nIf you like this project you can help to support it by contributing to it. You can contribute by writing tutorials, creating and documenting exciting new ideas to use AlertR (for example on [reddit](https://www.reddit.com/r/AlertR/)), writing code for it, and so on. Contributors have to agree to the [Contributor License Agreement](https://gist.github.com/sqall01/b9460c19690d6a7397a9040142122cb4) before their contribution is accepted.\n\nIf you do not know how to do any of it or do not have the time, you can support the project by [donating](https://alertr.de/donations.php) or support me on [Patreon](https://www.patreon.com/sqall). Since services such as the push notification service have a monthly upkeep, the donation helps to keep these services free for everyone.\n\n### Patreon\n[![Patreon](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/sqall)\n\n### Paypal\n[![Donate](https://www.paypalobjects.com/en_US/DE/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=TVHGG76JVCSGC)\n\n\n# Licensing and Commercial Use\n\u003ca name=\"licensing\"/\u003e\n\nAlertR is free and open source Software and always will be. This means everyone can use it freely. It is licensed under the _GNU Affero General Public License v3.0_ which allows you to also commercially use it. However, if you do, you have to disclose all changes to the Software also as open source. This is also the case if you provide network services with AlertR.\n            \nIf you do not wish to open source your changes I can offer this Software under a different license (__Dual Licensing__). Please contact me to talk about the conditions.\n\n\n# Bugs, Feedback and Contact\n\u003ca name=\"bugs_and_feedback\"/\u003e\n\nFor questions, bugs and discussions please use the [Github Issues](https://github.com/sqall01/alertR/issues). All other means of contacting me can be found on my [personal website](https://pawlowski.dev/).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsqall01%2Falertr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsqall01%2Falertr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsqall01%2Falertr/lists"}