https://github.com/krzys-h/ctfd_chat_notifier
A small CTFd plugin to send notifications about solves and admin announcements to Slack/Discord/Telegram
https://github.com/krzys-h/ctfd_chat_notifier
chat ctfd ctfd-plugin discord notification plugin slack telegram
Last synced: 10 months ago
JSON representation
A small CTFd plugin to send notifications about solves and admin announcements to Slack/Discord/Telegram
- Host: GitHub
- URL: https://github.com/krzys-h/ctfd_chat_notifier
- Owner: krzys-h
- Created: 2020-10-18T12:57:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-10-20T17:33:32.000Z (over 4 years ago)
- Last Synced: 2025-04-07T06:35:02.575Z (about 1 year ago)
- Topics: chat, ctfd, ctfd-plugin, discord, notification, plugin, slack, telegram
- Language: Python
- Homepage:
- Size: 121 KB
- Stars: 12
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CTFd Chat Notifier
A small CTFd plugin to send notifications to Slack, Discord or Telegram about solves and admin announcements. Can be easily extended to support other platforms.
## Installation
Clone this repo to `CTFd/plugins/CTFd_chat_notifier` in your CTFd installation directory and restart it. You should see the notifier settings in the admin panel.
Tested with CTFd 3.1.1.
## Extending
1. Create your own plugin (or, if you are implementing a popular service, modify this one and send me a pull request!)
2. Create a class that extends from `BaseNotifier`
3. If your notifier requires any configuration (it probably needs at least a webhook url), override the `get_settings` method and create a settings template in `templates/chat_notifier/admin_notifier_settings/your_notifier_type_id.html`. Override `is_configured` to return True only when all required settings are configured correctly.
4. Implement the `notify_solve` and `notify_message` methods
5. Register your notifier type by creating an instance of your class and adding it to the `NOTIFIER_CLASSES` dictionary