Skip to content

Latest commit

 

History

History
171 lines (123 loc) · 8.94 KB

Installation-Setup.md

File metadata and controls

171 lines (123 loc) · 8.94 KB

Installation Steps

  1. Obtain API Keys/Webhook URL
  2. Install needed packages, clone Repo and install library dependencies
  3. Configure the script
  4. Run the Script

NOTE: This should NOT be installed on your PI-Star Hotspot. Please use another machine for this script.

Messaging Services

Here we need to setup the service you want to get the notifications from.

Discord Webhook URL

If you will be using Discord, you will need to configure your Discord server.

  • Create a new text channel for the bot (I called mine #dapnet).
  • Go to the settings of your server and click on integrations (right click the server icon and go to server settings and then integrations).
  • In the middle of the screen should be a button that says "Create Webhook". Click that.
  • Give it a name (I used DAPNET for mine) and select the new text channel you just created, or use an existing channel if you like.
  • Click the "Copy Webhook URL" button at the bottom of the window. Paste this somewhere as you will need it here shortly again. (If loose it, you can come back later after creation and click the Copy button again).
  • Click "Save". Your Webhook and Channel are ready.

Telegram

  • If you plan on using Telegram:
    • You will need to first either create a Telegram bot or use an existing one you own. If this is your first bot, you can use the steps here and talk to @BotFather to create your bot. You will need the bot token for the bot you are using/creating and this can also be obtained from talking to @BotFather.
    • You will also need your chatid. This can be obtained once your bot is up and running by sending a message to your bot and using the Telegram API by going to this url: https://api.telegram.org/bot'API-access-token'/getUpdates?offset=0 replacing 'API-access-token' with your bot access token you obtained in the previous step. You will see some json and you will be able to find your ID there in the From stanza.
    • Note that Influx DB provides some examples of what to look for in the above 2 steps. You can go to their page by clicking here.

Mattermost

  • If you plan on using Mattermost, you will either need to have an existing server or spin up a new one for use of you and your familiy and friends. These steps assume you already have a server ready to go.
  • Note: you will need admin access to create the Webhook Integration.
  • There are a few more steps involved in setting up the Mattermost Webhook:
    • First you will need to create a new channel for the bot to post to (I called mine DAPNET)
    • Next, go to the hamburger menu by your name and scroll down to Integrations.
    • Here you will want to click Incoming Webhooks
    • Click "Add Incoming Hook" and then fill out the form provided. You will want to select your DAPNET channel and lock the bot to that channel.
    • Once you click create, a new webhook is born. The URL will be made up of two parts
      • The URL is the domain of your Mattermost server. So for example myserver.mattermost.com
      • The API key is the mix of Letter and numbers after the /hook/ part of the url showing.
    • You will need to put both of these parts into the configuration file to be able to send to a Mattermost Webhook.

Pushover

  • Pushover is a service that sends notifications to your phone, tablet and computer.
  • It is important to note that, while they have a free trial, it is a paid service. It is $4.99 for every platform you want to use it on after a 30 Day trial, but you only pay that $4.99 once for every platform you are using it on.
  • This is the only paid service that this app supports.
  • While I am not advocating buying the service, I know that some people use it for other things already and it was an easy add to the program.
  • More information about Pushover can be found here.
  • To get your API keys for Pushover:
    • Log into your Pushover account.
    • Your User Key is the in the upper right hand corner of the screen there. Copy that someplace.
    • Next, you will need to register for an API key for Pushover to use the application with. Scroll to the bottom where it says "Your Applications" and click "Create and Application/API Token"
    • Give it a name, agree to the TOS and click create application.
    • On the next screen it shows you the API Key you will need. Copy that out and now you have the two pieces you need for message notifications to work with Pushover.

Slack

Like Mattermost, Slack uses Webhook URLs to allow incoming data to be posted to a channel.

  • If you plan on using Slack, you will either need to have an existing server or spin up a new one for use of you and your familiy and friends. These steps assume you already have a server ready to go.
  • Note: you will need admin access to create the Webhook Integration.
  • Create new channel in Slack (ex. DAPNET)
  • Click on Apps and then search for "incoming Webhook"
  • Click on Add and a browser window will open.
  • It will ask you to choose the server/channel to post to. Then Create the Webhook.
  • Scroll down the next page down to integration settings.
    • Double check the channel is correct
    • Copy the Webhook URL since you will need that later.
    • Give it a name (ex. FreePBX)
    • You can upload an Icon if you want.
    • Click Save. This will generate your incoming webhook URL.
    • Copy the URL to add to your Configuration file.
    • In Slack, in your channel, it will say Added Integration.

NOTE: There is a warning from Slack that this integation is legacy and may be discontinued. if that happens, this script will be updated to accomidate this change.

Installing the Script

The next step is installing the needed packages, cloning the repo to get the script and then installing the needed libraries for the script to work properly.

This is probably the easiest step to accomplish.

Please run the following commands on your FreePBX Server:

sudo apt-get update && sudo apt-get -y upgrade && sudo apt-get -y dist-upgrade

sudo apt-get install python3 python3-pip git screen

git clone https://github.com/n8acl/DAPNETNotifier.git

cd DAPNETNotifier

pip3 install -r requirements.txt

Configure the Script

Now that you have all of your keys/webhooks/what have you, let's configure the script.

You will need to edit the config.py file in the cloned directory. Open this file in your favorite text editor. You should see something similiar:

##### Main Variables
mmdvm_ip = 'FQDN or full IP Address for pi-star hotspot' # EX: http://pistar.local or http://10.0.0.100
wait_time = 60 #Your delay in seconds between message checks, let's not hammer the crap out of the MMDVM hum?

##### Notification Services Variables
# Pushover configuration
pushover = False # Enable or disable notifications via Pushover
pushover_token = "1234567890" # Your Pushover API token
pushover_user = "abcdefghijklm" # Your Pushover user key

# Configure Telegram
telegram = False # Enable. On = True, Off = False
telgram_bot_token = 'YOUR TELEGRAM BOT TOKEN HERE'
telegram_chat_id = 'YOUR TELEGRAM CHAT ID HERE'

# Configure Mattermost
mattermost = False # Enable. On = True, Off = False
mattermost_wh = 'YOUR MATTERMOST WEBHOOK URL HERE'

# Configure Slack
slack = False # Enable. On = True, Off = False
slack_wh = 'YOUR SLACK WEBHOOK URL HERE'

# Discord Configuration
discord = False # Enable. On = True, Off = False
discord_wh = 'DISCORD CHANNEL WEBHOOK HERE'

At the very top, you will see some settings that are general settings for the script. These variables are:

  • mmdvm_ip this is either the Fully Qualified Domain Name (FQDN) or the IP address of your PI-Star Hotspot. This does require http:// or https:// to work.
  • wait_time time in seconds to wait to check the dashboard. Remember, be kind to your hotspot.

Each section below that contains what is needed for each service to operate. To enable sending to a service, you will need to set the service name from False to True and supply the needed keys/webhooks for that service.

Running the Script

Once you have the config file edited, start the bot by typing the following:

screen -R dapnetnotifier

Then in the new window:

cd DAPNETNotifier

python3 dapnetnotifier.py

Once that is done, hold CTRL and then tap A and then D to disconnect from the screen session. If something ever happens, you can reconnect to the session by typing:

screen -R dapnetnotifier

And see why it errored or quit. You will know it errored because it will send the error to whatever server you are using for notifications. This is useful if you need to contact me for support or want to restart the script.