Public | Automated Build

Last pushed: 9 months ago
Short Description
RSS- and Atom-Feed integration for Mattermost (www.mattermost.org)
Full Description

RSS- and Atom-Feed Integration Service for Mattermost

This integration service posts RSS feeds into specific Mattermost channels by formatting output from html to text
via Mattermost's incoming webhooks. It can also be managed through slash-commands.

<img src="https://github.com/bitbackofen/Rss-Atom-Feed-Integration-for-Mattermost/blob/master/Rss-Atom-Feed-Integration-for-Mattermost.png" width="250">

Requirements

To run this integration you need:

  1. A network connected device running python like Raspberry Pi or any other Linux device which supports python and the required packages or running Docker
  2. A Mattermost account where incoming webhooks are enabled and
    optionally slash-commands enabled

Linux/Ubuntu 14.04 Install

The following procedure shows how to install this project on a Linux device running Ubuntu 14.04.
The following instructions work behind a firewall as long as the device has access to your Mattermost instance.

To install this project using a Linux-based device, you will need Python 2.7 or a compatible version.
Other compatible operating systems and Python versions should also work.

Here's how to start:

  1. Set up your Mattermost instance to receive incoming webhooks

    1. Log in to your Mattermost account. Click the three dot menu at the top of the left-hand side and go to
      Account Settings > Integrations > Incoming Webhooks.
    2. Under Add a new incoming webhook select the channel in which you want Feed notifications to appear, then click Add to create a new entry.
    3. Copy the contents next to URL of the new webhook you just created (we'll refer to this as https://<your-mattermost-webhook-URL>).
  2. Set up a new slash-commands on your Mattermost instance to manage the feeds

    1. In the Integrations Menu, go to Slash Commands.
    2. Under Add a new slash command, enter the name of your command, a description and the word to trigger the command. The Request URL is simply the address to reach the machine where the project run. The default port is 8080 but is overriden by integration_listening_port.
      You can optionally opt-in for Autocompletion, and use this value :
      /rss-bot list | add <Feed Name> <Feed URL> [<Image URL>] [<Show Name>] [<Show Title>] [<Show Description>] [<Show URL>] | remove <Feed Name>
    3. Click Add to create the new command and copy the Token value for the command you just created. We'll refer to it as <your-slash-command-token>.
  3. Set up this project to run on your Linux device

    1. Set up a Linux Ubuntu 14.04 server either on your own machine or on a hosted service, like AWS.
    2. SSH into the machine, or just open your terminal if you're installing locally.
    3. Confirm Python 2.7 or a compatible version is installed by running:
      python --version If it's not installed you can find it here
    4. Install pip and git:
      sudo apt-get install python-pip supervisor git python-virtualenv
    5. Clone this GitHub repository:
      git clone https://github.com/bitbackofen/Rss-Atom-Feed-Integration-for-Mattermost.git
      cd Rss-Atom-Feed-Integration-for-Mattermost
    6. Copy sample file settings.py.sample:
      cp settings.py.sample settings.py
    7. Edit settings.py to suit your requirements:
      nano settings.py
      Save your changes (F2) and exit nano (CRTL-X)
    8. Setup virtual environment:
      virtualenv -p python2 env
      source env/bin/activate
      (env) $ pip install -r requirements.txt
      Leave virtual environment:
      (env) $ deactivate
    9. Test the the feed fetcher:
      ./env/bin/python ./feedfetcher.py
      You should see your feeds scrolling through. Check your configured Mattermost channel for the new feeds.
      If everything works fine:
    10. a) Start feedfetcher with nohup:
      nohup ./env/bin/python ./feedfetcher.py &
      b) Alternatively: Start feedfetcher with Supervisor:
      • sudo cp Rss-Atom-Feed-Integration-for-Mattermost.conf.sample /etc/supervisor/conf.d/mRss-Atom-Feed-Integration-for-Mattermost.conf
      • Edit the supervisor configuration file: sudo nano /etc/supervisor/conf.d/Rss-Atom-Feed-Integration-for-Mattermost.conf
        and change paths in command= and directory= to suit your environment.
      • Tell Supervisor to look for any new or changed program configurations:
        sudo supervisorctl reread
      • Followed by telling it to enact any changes with:
        sudo supervisorctl update
        Refer to this tutorial
        for more information about Supervisor.

SystemD Setup (instead of supervisor)

This config assumes that the feed fetcher will run on the same computer as mattermost as well as that a own user/group called rss was created for feedfetcher.

Place the following config under /etc/systemd/system/rss_atom_feed_integration_for_mattermost.service:

[Unit]
Description=RSS integration for mattermost
After=syslog.target network.target mattermost.service

[Service]
Type=simple
User=rss
Group=rss
ExecStart=/home/rss/Rss-Atom-Feed-Integration-for-Mattermost/env/bin/python /home/rss/Rss-Atom-Feed-Integration-for-Mattermost/feedfetcher.py
PrivateTmp=yes
WorkingDirectory=/home/rss/Rss-Atom-Feed-Integration-for-Mattermost/
Restart=always
RestartSec=30

[Install]
WantedBy=multi-user.target

Please note:

  • Remove mattermost.service from After if the fetcher was installed on a different computer than mattermost
  • change User and Group to the user and group that the fetcher should run under
  • change ExecStart and WorkingDirectory to the actual installation paths

Now you can start the fetcher with systemctl start rss_atom_feed_integration_for_mattermost.service to enable auto-start on boot type systemctl enable rss_atom_feed_integration_for_mattermost.service

Microsoft Windows Install

This integration also works with Microsoft Windows:

  • Download Python 2.7 from Python.org and install it
  • Download mattermost_integration_rss from Github or get it using git clone https://github.com/bitbackofen/Rss-Atom-Feed-Integration-for-Mattermost.git
  • Extract the archive to a directory of your choice if you downloaded archive.zip.
  • Start a command prompt and cd into your Python installation directory: e.g. cd c:\python27
  • Install requirements using Scripts\pip.exe install -r \path\to\Rss-Atom-Feed-Integration-for-Mattermost\requirements.txt
  • cd \path\to\Rss-Atom-Feed-Integration-for-Mattermost\
  • Start the Script:
    C:\Python27\python.exe feedfetcher.py (change C:\Python27\ if you installed Python elsewhere).

Linux/Ubuntu 14.04 Update

  1. cd into your mattermost_integration_rss directory:
    cd /path/to/Rss-Atom-Feed-Integration-for-Mattermost
  2. Stop feedfetcher:
    sudo supervisorctl
    supervisor> stop Rss-Atom-Feed-Integration-for-Mattermost
    Exit supervisor (CRTL-c)
  3. Update mattermost_integration_rss
    git pull origin master
  4. Have a look at settings.py.sample for changes.
  5. Start the feedfetcher:
    sudo supervisorctl
    supervisor> start Rss-Atom-Feed-Integration-for-Mattermost

Docker deployment

This integration is also available as a Docker image.

  1. Set up any box with Docker on it or access to a remote Docker Host.
  2. Clone this GitHub repository:
    git clone https://github.com/bitbackofen/Rss-Atom-Feed-Integration-for-Mattermost.git
    cd Rss-Atom-Feed-Integration-for-Mattermost
  3. Copy sample Compose and Feeds files:
    cp docker-compose.yml.sample docker-compose.yml
    cp feeds.env.sample feeds.env
  4. Edit the environment variables of docker-compose.yml to suit your needs. If a variable is omitted, the default value is used (except for MATTERMOST_HOOK_URL and MATTERMOST_CMD_TOKEN)
  5. Complete feeds.env with the desired RSS feeds
  6. Spin up the container with docker-compose up
    You should see your feeds scrolling through. Check your configured Mattermost channel for the new feeds.
    If everything works fine:
  7. Start the container with docker-compose up -d
Docker Pull Command
Owner
okhoshi