Giter Club home page Giter Club logo

matrixalert's Introduction

TelegramNotification Plugin for Graylog

Build status GitHub Release Graylog Marketplace Donate

TelegramNotification allows you to send Graylog alert messages to a specified Telegram chat.

Requirements

Requires Graylog 3.1 or later. It's recommended to use the latest Graylog release.

Installation

  1. Download the latest TelegramNotification release and place the graylog-plugin-telegram-notification-x.x.x.jar file in your plugin_dir that is configured in your graylog.conf as described in the Graylog documentation.

  2. Restart your graylog-server, i.e. systemctl restart graylog-server.

  3. Configure an alert notification as described in the next section.

Usage

Step 1 - Create Bot

Create a new Telegram bot with the BotFather and copy the bot token.

Step 2 - Get Channel ID

Use the Message Tool to find the Chat ID of the desired chat.

You can use a private chat, add the bot to a group-chat or to a channel. Just make sure to copy the correct Channel ID.

Step 3 - Add Notification

Navigate to Alerts > Notifications in your Graylog-interface and select Telegram Notification as the notification type.

The message is a template that can be configured as described in the Graylog Documentation

Settings

Update

To update the plugin you need to remove the old graylog-plugin-telegram-notification-x.x.x.jar (or telegram-alert-x.x.x.jar) file from your plugins folder and follow the installation instructions again.

You may need to remove and re-create your Telegram Notifications.

Development

See development/README.md for some notes on how to get started with development.

Contributions are welcome.

Credits

Thanks to:

  • Alexey Medov (@kakogoxepa) - for his valuable ideas and generous donation!
  • Everyone that starred this repository โญ๏ธ - you keep me motivated ๐Ÿ™‚
  • Contributors that submitted useful pull-requests or opened good issues with suggestions or a detailed bug report.

matrixalert's People

Contributors

irgendwr avatar fengkaijia avatar lantalex avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.