{"id":20541069,"url":"https://github.com/netways/notify-brevisone","last_synced_at":"2026-01-07T15:13:30.302Z","repository":{"id":38361245,"uuid":"357478856","full_name":"NETWAYS/notify-brevisone","owner":"NETWAYS","description":"Notification Plugin for Brevis One SMS Gateways","archived":false,"fork":false,"pushed_at":"2025-02-03T15:08:59.000Z","size":3945,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-03-27T22:11:57.719Z","etag":null,"topics":["icinga","notifications","plugin"],"latest_commit_sha":null,"homepage":"https://shop.netways.de/produkt-kategorie/alarmierung/sms-server/brevis-one/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NETWAYS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2021-04-13T08:27:02.000Z","updated_at":"2025-02-03T15:08:55.000Z","dependencies_parsed_at":"2023-02-19T06:16:07.193Z","dependency_job_id":"6d3172fd-7b3a-40f3-bf87-6328c7dd77bf","html_url":"https://github.com/NETWAYS/notify-brevisone","commit_stats":{"total_commits":48,"total_committers":6,"mean_commits":8.0,"dds":0.6458333333333333,"last_synced_commit":"927e511de694147bf3b7d0f3bd1b9cc811a1bcd8"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NETWAYS%2Fnotify-brevisone","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NETWAYS%2Fnotify-brevisone/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NETWAYS%2Fnotify-brevisone/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NETWAYS%2Fnotify-brevisone/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NETWAYS","download_url":"https://codeload.github.com/NETWAYS/notify-brevisone/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248848499,"owners_count":21171388,"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":["icinga","notifications","plugin"],"created_at":"2024-11-16T01:19:12.021Z","updated_at":"2026-01-07T15:13:30.273Z","avatar_url":"https://github.com/NETWAYS.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# notify-brevisone\n\nNotification Plugin for [brevis.one] SMS Gateways to send SMS messages or ring a contact.\n\nDocumentation for your gateway can be found under [docs.brevis.one](https://docs.brevis.one/current/en/).\n\n## Installation\n\nDownload the current binary from GitHub and install it with Icinga 2. See [releases](https://github.com/NETWAYS/notify-brevisone/releases).\n\n    curl -L -o notify-brevisone https://github.com/NETWAYS/notify-brevisone/releases/download/v0.1.0/notify-brevisone_0.1.0_Linux_x86_64\n    chmod 755 notify-brevisone\n    cp notify-brevisone /etc/icinga2/scripts/\n\n    /etc/icinga2/scripts/notify-brevisone --help\n\nYou can use the provided config under [examples] for a standard `NotificationCommand`,\nwhen included properly in icinga2, Director can learn it via a Kickstart.\n\n    curl -L -o /etc/icinga2/conf.d/brevisone.conf https://raw.githubusercontent.com/NETWAYS/notify-brevisone/main/examples/icinga2/commands.conf\n\nOf course, you can adjust the command to your needs.\n\n## Usage\n\n```\n./notify-brevisone --help\nUsage of notify-brevisone\n\nNotifications via a brevis.one gateway.\nSends SMS or rings at a given number\n\nArguments:\n  -g, --gateway string       IP/address of the brevis.one gateway (required)\n  -u, --username string      API user name (required)\n  -p, --password string      API user password (required)\n      --insecure             Skip verification of the TLS certificates (is needed for the default self signed certificate)\n      --no-tls                Do NOT use TLS to connect to the gateway (default false)\n      --use-legacy-http-api   Use old HTTP API (required on older firmware versions, default false)\n  -T, --target string        Target contact, group or phone number (required)\n      --target-type string   Target type, one of: number, contact or contactgroup (default \"number\")\n  -R, --ring                 Add ring mode (also ring the target after sending SMS)\n      --type string          Icinga $notification.type$ (required)\n  -H, --host string          Icinga $host.name$ (required)\n  -S, --service string       Icinga $service.name$ (required for service notifications)\n  -s, --state string         Icinga $host.state$ or $service.state$ (required)\n  -o, --output string        Icinga $host.output or $service.output$ (required)\n  -C, --comment string       Icinga $notification.comment$ (optional)\n  -a, --author string        Icinga $notification.author$ (optional)\n      --date string          Icinga $icinga.long_date_time$ (optional)\n  -t, --timeout int          Abort the check after n seconds (default 30)\n  -d, --debug                Enable debug mode\n  -v, --verbose              Enable verbose mode\n  -V, --version              Print version and exit\n\n```\n\nTo use this plugin the brevis.one gateway has to be configured properly:\n\n- The REST-API must be activated\n- Contacts and Contactgroups can be used for notifications (see the `targetType` argument) if configured\n- The credentials must be given to the plugin (`username` and `password`)\n- Ensure sending SMS works on the gateway before trying with the plugin\n- The device uses a self-signed certificate per default, if you do not intend to replace it,\n  adding the `--insecure` flag allows you to ignore this (although this is not recommended)\n\n## Examples\nAn example for a (custom) service notification with a preconfigured contact:\n```\n./notify-brevisOne \\\n\t'--gateway''192.168.0.2' \\\n\t'--username' 'admin' \\\n\t'--password' 'admin' \\\n\t'--target' 'myUser' \\\n\t'--target-type' 'contact' \\\n\t'--comment' 'asfsdf' \\\n\t'--date' '2021-04-14 15:29:06 +0200' \\\n\t'--host' 'myHost' \\\n\t'--service' 'fake' \\\n\t'--type' 'CUSTOM' \\\n\t'--author' 'aRandomMonitor' \\\n\t'--output' 'Hello World' \\\n\t'--state' 'WARNING'\n```\nsends the message: `2021-04-14 15:29:06 +0200/CUSTOM: fake @ myHost - WARNING \"asfsdf\" by aRandomMonitor Hello World`\n\nAn example for a (recovery) Host notification with a phone number directly\n```\n./notify-brevisOne \\\n\t'--gateway''192.168.0.2' \\\n\t'--username' 'admin' \\\n\t'--password' 'admin' \\\n\t'--target' '01189998819991197253' \\\n\t'--date' '2021-04-14 15:29:06 +0200' \\\n\t'--host' 'myHost' \\\n\t'--type' 'RECOVERY' \\\n\t'--output' 'It pings again!' \\\n\t'--state' 'OK'\n```\nsends the message: `2021-04-14 15:29:06 +0200/RECOVERY: myHost - OK It pings again!`\n\n## Building manually\n\nAfter cloning the repository, execute the following in the directory:\n\n```\ngo build -o notify-brevisone .\n```\n\nWe recommend using the releases under: https://github.com/NETWAYS/notify-brevisone/releases\n\n## License\n\n[brevis.one] is a trademark of BASIS Europe Distribution GmbH\n\nCopyright (C) 2021 [NETWAYS GmbH](mailto:info@netways.de)\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n\n[brevis.one]: https://brevis.one/\n[examples]: https://github.com/NETWAYS/notify-brevisone/tree/main/examples/icinga2\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetways%2Fnotify-brevisone","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetways%2Fnotify-brevisone","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetways%2Fnotify-brevisone/lists"}