From 67632ab966d6f93cc7fed818cc9df6ef02402899 Mon Sep 17 00:00:00 2001 From: TimZ99 Date: Sat, 3 Mar 2018 15:53:43 +0000 Subject: [PATCH] Added Telegram notifications --- docs/faq.rst | 44 +++++++++++++++++++++++++++++++++++++++++++- docs/intro.rst | 4 ++-- 2 files changed, 45 insertions(+), 3 deletions(-) diff --git a/docs/faq.rst b/docs/faq.rst index 4e638494..5dc990c5 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -87,4 +87,46 @@ The second part is the actual message. There are a few variables you can use in * %LABEL% - The name of the server * %IP% - The ip of the server * %PORT% - The port of the server -* %ERROR% - This one only works for the off_* messages and contains the error returned by the monitor \ No newline at end of file +* %ERROR% - This one only works for the off_* messages and contains the error returned by the monitor + +Notifications ++++++++++++++ + +How do I setup Telegram? +------------------------ +A few steps are required to get Telegram notifications working. +You need to be an administrator for this part. + +1. Go to @botfather (https://t.me/BotFather) and type /start . +2. Type /newbot and give your bot an unique name. +3. Save the API token. + +How do I sent Telegram notifications to a person? +------------------------------------------------- + +1. Go to @cid_bot (https://t.me/cid_bot) and start. +2. Save your chat id. +3. Press the activation button. +4. Go to your chat with the bot and press start of type /start. + +How do I sent Telegram notifications to a group? +------------------------------------------------ + +1. Add @cid_bot (https://t.me/cid_bot) to the group. +2. Save the chat id (including the -). +3. Remove @cid_bot from the group. +4. Add your bot to the group. + +How do I sent Telegram notifications to a channel? +-------------------------------------------------- + +1. Create a public channel. +2. Add the bot as an administator to the channel. +3. Save chat id as: @channelname. + +What is the username of my bot? +------------------------------- + +1. Go to profile on the monitor. +2. Press activate. +3. A button will appear, this will direct you to your Telegram bot. diff --git a/docs/intro.rst b/docs/intro.rst index 46364c7c..a6cefe78 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -15,7 +15,7 @@ Features ++++++++ * Monitor services and websites (see below). -* Email, SMS and Pushover notifications. +* Email, SMS, Pushover and Telegram notifications. * View history graphs of uptime and latency. * User authentication with 2 levels (administrator and regular user). * Logs of connection errors, outgoing emails and text messages. @@ -44,7 +44,7 @@ There are two different ways to monitor a server: Notifications ------------- Each server has its own settings regarding notification. -You can choose for email, text message (SMS) and Pushover.net notifications. +You can choose for email, text message (SMS), Pushover.net and Telegram notifications. The following SMS gateways are currently available: * Clickatell -