{"id":13582045,"url":"https://github.com/dadevel/alertmanager-signal-receiver","last_synced_at":"2025-04-06T11:32:29.437Z","repository":{"id":41087232,"uuid":"256805232","full_name":"dadevel/alertmanager-signal-receiver","owner":"dadevel","description":"Signal Messenger Support for Prometheus Alertmanager","archived":true,"fork":false,"pushed_at":"2024-02-28T20:00:11.000Z","size":229,"stargazers_count":23,"open_issues_count":4,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-05T21:45:41.341Z","etag":null,"topics":["alertmanager-webhook","signal"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dadevel.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":"2020-04-18T16:50:44.000Z","updated_at":"2024-10-10T22:06:07.000Z","dependencies_parsed_at":"2024-06-19T01:43:27.684Z","dependency_job_id":"b95b87bf-2024-4ca0-8255-e997e123e5dd","html_url":"https://github.com/dadevel/alertmanager-signal-receiver","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dadevel%2Falertmanager-signal-receiver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dadevel%2Falertmanager-signal-receiver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dadevel%2Falertmanager-signal-receiver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dadevel%2Falertmanager-signal-receiver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dadevel","download_url":"https://codeload.github.com/dadevel/alertmanager-signal-receiver/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247478102,"owners_count":20945256,"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":["alertmanager-webhook","signal"],"created_at":"2024-08-01T15:02:24.118Z","updated_at":"2025-04-06T11:32:29.079Z","avatar_url":"https://github.com/dadevel.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# Alertmanager Signal Receiver\n\nA Prometheus Alertmanager Webhook Receiver that forwards alerts to a group in [Signal](https://signal.org/).\n\nHeavily based on [prometheus-am-executor](https://github.com/imgix/prometheus-am-executor/).\n\n## Setup\n\nCreate a volume for signal-cli.\n\n~~~ bash\ndocker volume create signal-data\n~~~\n\nStart a temporary container with access to signal-cli.\n\n~~~ bash\ndocker run -it --rm -v signal-data:/app/data --entrypoint bash ghcr.io/dadevel/signal-receiver\n~~~\n\nRegister a new phone number.\n\n~~~ bash\nsignal-cli --config ./data --username $YOUR_PHONE_NUMBER register\nsignal-cli --config ./data --username $YOUR_PHONE_NUMBER verify $CODE_RECEIVED_VIA_SMS\n~~~\n\nCreate a new group (prints base64-encoded group id on success).\n\n~~~ bash\nsignal-cli --config ./data --username $YOUR_PHONE_NUMBER updateGroup --name Alerts --description 'Alertmanager notifications' --set-permission-send-messages only-admins --member $SOMEONES_PHONE_NUMBER $ANOTHER_PHONE_NUMBER\n~~~\n\nSend a test message.\n\n~~~ bash\nsignal-cli --config ./data --username $YOUR_PHONE_NUMBER send --group $GROUP_ID_FROM_ABOVE --message 'Hello World!'\n~~~\n\nNow that signal-cli is ready to go you can exit the temporary container and finally start the webhook receiver.\n\n~~~ sh\ndocker run -d -p 9709 -v signal-data:/app/data -e SIGNAL_RECEIVER_PHONE_NUMBER=$YOUR_PHONE_NUMBER -e SIGNAL_RECEIVER_GROUP_ID=$YOUR_GROUP_ID ghcr.io/dadevel/signal-receiver\n~~~\n\nTest it.\n\n~~~ sh\ncurl -i -d @- http://localhost:9709/alert \u003c\u003c EOF\n{\n  \"receiver\": \"default\",\n  \"status\": \"firing\",\n  \"alerts\": [\n    {\n      \"status\": \"firing\",\n      \"labels\": {\n        \"alertname\": \"HelloWorld\",\n        \"instance\": \"localhost:1234\",\n        \"job\": \"broken\",\n        \"monitor\": \"world-monitor\"\n      },\n      \"annotations\": {},\n      \"startsAt\": \"2016-04-07T18:08:52.804+02:00\",\n      \"endsAt\": \"0001-01-01T00:00:00Z\",\n      \"generatorURL\": \"\"\n    },\n    {\n      \"status\": \"firing\",\n      \"labels\": {\n        \"alertname\": \"HelloWorld\",\n        \"instance\": \"localhost:5678\",\n        \"job\": \"broken\",\n        \"monitor\": \"world-monitor\"\n      },\n      \"annotations\": {},\n      \"startsAt\": \"2016-04-07T18:08:52.804+02:00\",\n      \"endsAt\": \"0001-01-01T00:00:00Z\",\n      \"generatorURL\": \"\"\n    }\n  ],\n  \"groupLabels\": {\n    \"alertname\": \"HelloWorld\"\n  },\n  \"commonLabels\": {\n    \"alertname\": \"HelloWorld\",\n    \"job\": \"broken\",\n    \"monitor\": \"world-monitor\"\n  },\n  \"commonAnnotations\": {},\n  \"externalURL\": \"http://localhost:9093\",\n  \"version\": \"4\",\n  \"groupKey\": 9777663806026785000\n}\nEOF\n~~~\n\n## Configure\n\n| Environment variable               | Description                                                    |\n|------------------------------------|----------------------------------------------------------------|\n| `SIGNAL_RECEIVER_PHONE_NUMBER`     | phone number of signal account to send messages from, required |\n| `SIGNAL_RECEIVER_GROUP_ID`         | signal group id to send messages to, required                  |\n| `SIGNAL_RECEIVER_DATA_DIR`         | storage location used by `signal-cli`, defaults to `./data`    |\n| `SIGNAL_RECEIVER_LISTEN_ADDRESS`   | address and port to listen on, defaults to `:9709`             |\n| `SIGNAL_RECEIVER_VERBOSE`          | enable verbose logging, off by default                         |\n| `SIGNAL_RECEIVER_MESSAGE_TEMPLATE` | go template for messages, see source code for default value    |\n\nExample configurations for Prometheus and Alertmanager can be found in the [examples](./examples) directory.\n\n## Build\n\nBuild the binary.\n\n~~~ bash\ngo build -o ./alertmanager-signal-receiver ./cmd/main.go\n~~~\n\nThe `Dockerfile` is available under [github.com/dadevel/dockerfiles](https://github.com/dadevel/dockerfiles/tree/main/signal-receiver).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdadevel%2Falertmanager-signal-receiver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdadevel%2Falertmanager-signal-receiver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdadevel%2Falertmanager-signal-receiver/lists"}