{"id":22942047,"url":"https://github.com/async3619/cage-telegram-helper","last_synced_at":"2025-07-26T13:14:07.409Z","repository":{"id":64603184,"uuid":"576822291","full_name":"async3619/cage-telegram-helper","owner":"async3619","description":"notification message relay server for Cage","archived":false,"fork":false,"pushed_at":"2022-12-15T13:14:19.000Z","size":315,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-25T05:15:23.476Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/async3619.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-12-11T04:48:34.000Z","updated_at":"2022-12-11T05:08:57.000Z","dependencies_parsed_at":"2023-01-29T03:15:56.247Z","dependency_job_id":null,"html_url":"https://github.com/async3619/cage-telegram-helper","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/async3619%2Fcage-telegram-helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/async3619%2Fcage-telegram-helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/async3619%2Fcage-telegram-helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/async3619%2Fcage-telegram-helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/async3619","download_url":"https://codeload.github.com/async3619/cage-telegram-helper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246709912,"owners_count":20821298,"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-12-14T13:46:26.335Z","updated_at":"2025-04-01T21:18:08.681Z","avatar_url":"https://github.com/async3619.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cbr /\u003e\n  🦜\n  \u003cbr /\u003e\n  Cage Telegram Helper\n  \u003csup\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n  \u003c/sup\u003e    \n\u003c/h1\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://registry.hub.docker.com/r/async3619/cage-telegram-helper\"\u003e\n        \u003cimg alt=\"Docker Image Version (latest by date)\" src=\"https://img.shields.io/docker/v/async3619/cage-telegram-helper?label=docker\u0026style=flat-square\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/async3619/cage-telegram-helper/blob/main/LICENSE\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/license/async3619/cage-telegram-helper.svg?style=flat-square\" alt=\"MIT License\" /\u003e\n    \u003c/a\u003e\n    \u003cbr /\u003e\n    \u003csup\u003enotification message relay server for \u003ca href=\"https://github.com/async3619/cage\"\u003eCage\u003c/a\u003e\u003c/sup\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n\u003c/div\u003e\n\n## Introduction\n\nThis is Telegram notification message relaying server for [Cage](https://github.com/async3619/cage) project. this will relay notification messages from your Cage instance to Telegram Bot to send message to your telegram account.\n\nIn most cases, you will not need this since Cage already provides hosted version of this server out of the box. but if you want to use Telegram notification with your own Telegram Bot, you will need this.\n\n## Usage\n\nFirstly, you should create your own telegram bot. you can follow [this guide](https://core.telegram.org/bots/features#botfather) to create your own bot. after you created your bot, you will get a token for your bot. you will need this token to configure this server.\n\n```bash\ndocker run -d --name cage-telegram-helper \\\n    -e TELEGRAM_BOT_TOKEN=\u003cYOUR BOT TOKEN HERE\u003e \\\n    -p 8080:3000 \\\n    async3619/cage-telegram-helper\n```\n\nor you can use docker-compose:\n\n```yaml\nversion: \"3.9\"\n\nservices:\n    cage-telegram-helper:\n        image: async3619/cage-telegram-helper\n        container_name: cage-telegram-helper\n        environment:\n            - TELEGRAM_BOT_TOKEN=\u003cYOUR BOT TOKEN HERE\u003e\n        ports:\n            - 8080:3000\n```\n\nonce you started this server, your bot will be able to provide you a token that you can use to configure your Cage instance:\n\n```text\nYou: /start\n\nBot: Now you can configure your cage instance with this token:\n\u003cYOUR CAGE-TELEGRAM TOKEN HERE\u003e\n```\n\nthen you should configure your Cage instance to use this server. you can do this by adding `url` property to your `config.json` file:\n\n```json5\n{\n    // ...\n    \"notifiers\": {\n        \"telegram\": {\n            \"type\": \"telegram\",\n            \"url\": \"http://localhost:8080\",\n            \"token\": \"\u003cYOUR CAGE-TELEGRAM TOKEN HERE\u003e\"\n        }\n    },\n    // ...\n}\n```\nnow you all set. you can start to use your Cage instance with Telegram notification.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasync3619%2Fcage-telegram-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasync3619%2Fcage-telegram-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasync3619%2Fcage-telegram-helper/lists"}