{"id":13585408,"url":"https://github.com/ix-ai/alertmanager-notifier","last_synced_at":"2025-04-07T09:34:42.954Z","repository":{"id":37929742,"uuid":"238859570","full_name":"ix-ai/alertmanager-notifier","owner":"ix-ai","description":"A notifier for alertmanager, written in python. It supports multiple notification channels and new ones can be easily added","archived":false,"fork":false,"pushed_at":"2024-05-21T07:18:51.000Z","size":167,"stargazers_count":18,"open_issues_count":0,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-05-22T08:41:06.833Z","etag":null,"topics":["alertmanager","alertmanager-notifier","docker-image","gotify","notifier","telegram"],"latest_commit_sha":null,"homepage":"https://ix.ai/alertmanager-notifier","language":"Python","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/ix-ai.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-02-07T06:39:07.000Z","updated_at":"2024-07-23T23:33:46.036Z","dependencies_parsed_at":"2024-05-21T08:37:23.897Z","dependency_job_id":"c77dbf60-5722-4be5-a2c9-8b73b614dac9","html_url":"https://github.com/ix-ai/alertmanager-notifier","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ix-ai%2Falertmanager-notifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ix-ai%2Falertmanager-notifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ix-ai%2Falertmanager-notifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ix-ai%2Falertmanager-notifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ix-ai","download_url":"https://codeload.github.com/ix-ai/alertmanager-notifier/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223277855,"owners_count":17118658,"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","alertmanager-notifier","docker-image","gotify","notifier","telegram"],"created_at":"2024-08-01T15:04:55.578Z","updated_at":"2024-11-06T03:31:04.003Z","avatar_url":"https://github.com/ix-ai.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# alertmanager-notifier\n\n[![Pipeline Status](https://gitlab.com/ix.ai/alertmanager-notifier/badges/master/pipeline.svg)](https://gitlab.com/ix.ai/alertmanager-notifier/)\n[![Docker Stars](https://img.shields.io/docker/stars/ixdotai/alertmanager-notifier.svg)](https://hub.docker.com/r/ixdotai/alertmanager-notifier/)\n[![Docker Pulls](https://img.shields.io/docker/pulls/ixdotai/alertmanager-notifier.svg)](https://hub.docker.com/r/ixdotai/alertmanager-notifier/)\n[![Gitlab Project](https://img.shields.io/badge/GitLab-Project-554488.svg)](https://gitlab.com/ix.ai/alertmanager-notifier/)\n\nA notifier for [alertmanager](https://github.com/prometheus/alertmanager), written in python. It supports multiple notification channels and new ones can be easily added.\n\n## Deprecation\n\n**Telegram Deprecation**: Starting with the version 0.5.0 of `alertmanager-notifier`, Telegram support is dropped. As such, the documentation has been updated to reflect it.\n\n## Running a simple test\n\n```sh\ndocker run --rm -it \\\n    -p 8899:8899 \\\n    -e GOTIFY_URL=\"https://gotify\" \\\n    -e GOTIFY_TOKEN=\"your gotify token\" \\\n    -e EXCLUDE_LABELS=\"yes\" \\\n    --name alertmanager-notifier \\\n    registry.gitlab.com/ix.ai/alertmanager-notifier:latest\n```\n\nRun the test agains the bot:\n\n```sh\ncurl -X POST -d '{\"externalURL\": \"http://foo.bar/\", \"receiver\": \"alertmanager-notifier-webhook\", \"alerts\": [{\"status\":\"Testing alertmanager-notifier\", \"labels\":{}, \"annotations\":{}, \"generatorURL\": \"http://foo.bar\"}]}' -H \"Content-Type: application/json\" localhost:8899/alert\n```\n\n## Configure alertmanager\n\n```yml\nroute:\n  receiver: 'alertmanager webhook'\n  routes:\n    - receiver: 'alertmanager-notifier-webhook'\n\nreceivers:\n  - name: 'alertmanager-notifier-webhook'\n    webhook_configs:\n      - url: http://alertmanager-notifier:8899/alert\n```\n\n## Supported environment variables\n\n| **Variable**        | **Default**      | **Description**                                                                                                            |\n|:--------------------|:----------------:|:---------------------------------------------------------------------------------------------------------------------------|\n| `GOTIFY_URL`        | -                | the URL of the [Gotify](https://gotify.net/) server |\n| `GOTIFY_TOKEN`      | -                | the APP token for Gotify |\n| `GOTIFY_TEMPLATE`   | `markdown.md.j2` | allows you to specify another (HTML) template, in case you've mounted it under `/templates` |\n| `EXCLUDE_LABELS`    | `yes`            | set this to `no` to include the labels from the notifications |\n| `LOGLEVEL`          | `INFO`           | [Logging Level](https://docs.python.org/3/library/logging.html#levels) |\n| `GELF_HOST`         | -                | If set, the exporter will also log to this [GELF](https://docs.graylog.org/en/3.0/pages/gelf.html) capable host on UDP |\n| `GELF_PORT`         | `12201`          | Ignored, if `GELF_HOST` is unset. The UDP port for GELF logging |\n| `PORT`              | `8899`           | the port for incoming connections |\n| `ADDRESS`           | `*`              | the address for the bot to listen on |\n\n**NOTE**: If no notifier is configured, the `Null` notifier will be used and the notification will only be logged\n\n## Gotify Priority\n\nGotify supports message priorities, that are also mapped to Android Importance (see [gotify/android#18](https://github.com/gotify/android/issues/18)).\n\nIf you set the *annotation* `priority` to your alert, with a number as value, this will be passed through to gotify.\n\n**Note**: Since alertmanager supports sending multiple alerts in one message, alertmanager-notifier will always use the **highest** priority value for gotify from the batch.\n\n## Templating\n\n**alertmanager-notifier** supports jinja templating. take a look in the [templates/](templates/) folder for examples for that. If you want to use your own template, mount it as a volume in docker and set the `*_TEMPLATE` environment variable. The mount path should be under `/templates/` (for example `/templates/my-amazing-template`).\n\n## Tags and Arch\n\nThe images are multi-arch, with builds for amd64, arm64, armv7 and armv6.\n\n* `vN.N.N` - for example v0.0.1\n* `latest` - always pointing to the latest version\n* `dev-master` - the last build on the master branch\n\n### Images\n\n* Gitlab Registry: `registry.gitlab.com/ix.ai/alertmanager-notifier` - [gitlab.com/ix.ai/alertmanager-notifier](https://gitlab.com/ix.ai/alertmanager-notifier)\n* GitHub Registry: `ghcr.io/ix-ai/alertmanager-notifier` [github.com/ix-ai/alertmanager-notifier](https://github.com/ix-ai/alertmanager-notifier)\n* Docker Hub: `ixdotai/alertmanager-notifier` - [hub.docker.com/r/ixdotai/alertmanager-notifier](https://hub.docker.com/r/ixdotai/alertmanager-notifier)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fix-ai%2Falertmanager-notifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fix-ai%2Falertmanager-notifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fix-ai%2Falertmanager-notifier/lists"}