{"id":24711438,"url":"https://github.com/rappytv/rappynotify","last_synced_at":"2025-03-22T06:44:29.141Z","repository":{"id":188988785,"uuid":"679839233","full_name":"RappyTV/RappyNotify","owner":"RappyTV","description":"API to send messages to my phone","archived":false,"fork":false,"pushed_at":"2024-01-15T13:12:07.000Z","size":38,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-27T07:14:36.871Z","etag":null,"topics":["api","notify","telegram"],"latest_commit_sha":null,"homepage":"https://msg.rappytv.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RappyTV.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-08-17T18:27:58.000Z","updated_at":"2023-09-04T06:34:18.000Z","dependencies_parsed_at":"2023-08-17T19:40:56.752Z","dependency_job_id":"593b9fb8-80d7-46f9-aba7-cb586dcc8c89","html_url":"https://github.com/RappyTV/RappyNotify","commit_stats":null,"previous_names":["rappytv/rappynotify"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RappyTV%2FRappyNotify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RappyTV%2FRappyNotify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RappyTV%2FRappyNotify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RappyTV%2FRappyNotify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RappyTV","download_url":"https://codeload.github.com/RappyTV/RappyNotify/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244918591,"owners_count":20531686,"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":["api","notify","telegram"],"created_at":"2025-01-27T07:14:40.303Z","updated_at":"2025-03-22T06:44:29.121Z","avatar_url":"https://github.com/RappyTV.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RappyNotify\nThis is a simple Telegram message gateway.\n\n## Setup\n\n### Installation\n\n1. Clone this repository\n2. Run `npm install`\n3. Create a `config.json` based on the `config.json.example` file\n4. Configure your custom instance of `RappyNotify`\n5. Run `node index.js`\n\n### Configuration\n\nThe `config.json` file contains the following options:\n\n| Option | Description |\n| --- | --- |\n| `token` | The Telegram bot token |\n| `port` | The port to run the server on |\n| `logIPs` | Whether or not to log IPs in the console |\n| `timeFormat` | The format of the time in the console |\n| `adminToken` * | Authorization token required to perform actions like `POST` `/refresh` |\n| `users` | An array of users |\n| `users[x].id` | The user's internal ID (not the telegram id!) |\n| `users[x].aliases` | An array of aliases for the user |\n| `users[x].private` | Decides if the user info can be shown on `GET` `/:user` |\n| `users[x].conversation` | The ID of the conversation to send messages to |\n| `users[x].auth` | An object containing authentication options for the user |\n| `users[x].auth.active` | Whether or not an auth key is needed to send messages to the user |\n| `users[x].auth.key` | The key the user needs to enter to send messages |\n| `groups` | An array of groups |\n| `groups[x].id` | The group's internal ID |\n| `groups[x].aliases` | An array of aliases for the group |\n| `groups[x].private` | Decides if the group info can be shown on `GET` `/:group` |\n| `groups[x].users` | The users who are in the group |\n| `groups[x].users[x].id` | The user id (Note: The user must exist in the `users` array) |\n| `groups[x].users[x].private` | If the user's username is shown in `GET` `/:group` |\n| `groups[x].auth` | An object containing authentication options for the group |\n| `groups[x].auth.active` | Whether or not an auth key is needed to send messages to the group |\n| `groups[x].auth.key` | The auth key that is needed to send messages |\n| `ratelimiter` | An object containing ratelimiter options |\n| `ratelimiter.enabled` | Whether or not to enable the ratelimiter |\n| `ratelimiter.max` | The maximum amount of requests a user can send in the time window |\n| `ratelimiter.seconds` | The length of the ratelimiter time window in seconds |\n| `ratelimiter.bypassTokens` | An array of strings you can put in the `x-ratelimit-bypass` header to bypass the ratelimit |\n\n\\* Is optional so you can leave it empty \n## Usage\n\n### Sending messages\nTo send a message to a user or a group, simply send a `POST` request to `/:id` where `id` is a user or a group id or one of their aliases. The request body should contain a JSON object with the `message` property. If the user has authentication enabled, you also need to include an `Authorization` header with the value of their key.\n\n### Refreshing the config (Maybe for adding users and stuff)\nJust send a `POST` request to `/refresh` and the config get's refreshed.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frappytv%2Frappynotify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frappytv%2Frappynotify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frappytv%2Frappynotify/lists"}