{"id":13343000,"url":"https://github.com/mobergmann/pingme","last_synced_at":"2025-03-12T03:30:48.971Z","repository":{"id":178458568,"uuid":"661004928","full_name":"mobergmann/pingme","owner":"mobergmann","description":"A discord bot. Subscribe to a channel and get pinged (DM) whenever there is a new message posted on the channel. Good for thread like channels.","archived":true,"fork":false,"pushed_at":"2023-07-08T19:08:12.000Z","size":43,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-24T13:59:01.338Z","etag":null,"topics":["discord","discord-bot","dpp","xmake"],"latest_commit_sha":null,"homepage":"","language":"C++","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/mobergmann.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":"2023-07-01T13:42:27.000Z","updated_at":"2024-08-06T15:21:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"8f49be26-2b6f-465d-8caa-d0c4d304cad4","html_url":"https://github.com/mobergmann/pingme","commit_stats":null,"previous_names":["mobergmann/pingme"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mobergmann%2Fpingme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mobergmann%2Fpingme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mobergmann%2Fpingme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mobergmann%2Fpingme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mobergmann","download_url":"https://codeload.github.com/mobergmann/pingme/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243150727,"owners_count":20244450,"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":["discord","discord-bot","dpp","xmake"],"created_at":"2024-07-29T19:30:09.662Z","updated_at":"2025-03-12T03:30:48.964Z","avatar_url":"https://github.com/mobergmann.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pingme\nThis bot is indented to be used as a newsletter for certain channels.\nYou can subscribe to channels and when a new message is sent to the channel you will be notified with a DM from the bot.\nFor that, you have to enable private DMs from strainers.\n\n# Usage\n- `/subscribe [channel]` Subscribes you to a newsletter of a channel and notifies you when a new message appears in a given channel with a DM\n- `/unsubscribe [channel]` Unsubscribes you from a newsletter for a given channel\n- `/list` Lists all your subscribed newsletters\n\n## Setup\nFor the bot to function you have to enable DMs from strangers, as the bot will try to send you the newsletter per DM.\nTo do that you have to open the _server privacy settings_ and then turn on _Direct Messages_.  \nYou can also enable _Allow direct messages from server members_ in the _account settings_.\nBut this is **not encouraged**, as this would allow anyone on every server to DM you.  \nIf you don't want others to send you messages you could also add the bot to a \"private\" server, where only you and the bot are located.\nThen you can enable _Direct Messages_ in the _server privacy settings_ for that server.\n\n# Hosting\n## Compiling\n### Dependencies\n- xmake\n\n### Compilation\nTo compile the project make sure you have xmake installed.\nThen clone the repository, `cd` into the repository, and execute `xmake build`.\nMake sure you have a token for your bot.\nAdd the Token as the environment variable `BOT_TOKEN`.\n\n## Podman/Docker\nYou can compile and install the bot in a container.\nThe image automatically pulls all needed dependencies and compiles the project for you in the container, no need to install dependencies and compiling.\nIt is as simple as cloning the repository, building the image and then running the image.\n\n### Using Podman:\n```\ngit clone https://github.com/mobergmann/pingme.git\npodman build -t pingme_b .\npodman run -e BOT_TOKEN=\"\u003ctoken\u003e\" -d --name pingme pingme_b\n```\n\n### Using Docker:\n```\ngit clone https://github.com/mobergmann/pingme.git\ndocker build -t pingme_b .\ndocker run -e BOT_TOKEN=\"\u003ctoken\u003e\" -d --name pingme pingme_b\n```\nYou need to have the new docker build tool `docker-buildx` installed.\n\n---\n\nMake sure to replace `\u003ctoken\u003e` with your bot token.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmobergmann%2Fpingme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmobergmann%2Fpingme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmobergmann%2Fpingme/lists"}