Skip to content
This repository has been archived by the owner on Oct 25, 2019. It is now read-only.

Bot to publish NeCTAR documents committed to GitHub onto Freshdesk

Notifications You must be signed in to change notification settings

Li-ReDBox/nectar-doco-bot

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

nectar-doco-bot is an agent for publishing NeCTAR documents managed in GitHub into Freshdesk. These documents will appear in Freshdesk as articles. More detail on documents see nectarcloud-tier0doco.

Install the bot

# log in as ubuntu
wget https://raw.githubusercontent.com/eResearchSA/nectar-doco-bot/master/install.sh
source install.sh

This script will:

  • update OS,
  • install necessary packages,
  • set up Python3 virtual environment.

Run the bot

  • set up git account for the bot,

  • set up gpg key for the bot,

  • activate environment: source nectar_doco_bot_env/bin/activate,

  • run: ~/nectar-doco-bot-master/script/fdbroker.py -h first to find out arguments,

    usage: fdbroker.py [-h] [--repopath REPOPATH] [-c CONFNAME] [-ap ARTICLEPATH]
                       [-l {DEBUG,INFO,WARNING,ERROR}]
    
    Start a Freshdesk bot.
    
    optional arguments:
      -h, --help            show this help message and exit
      --repopath REPOPATH   Path to Tier0 Doco repository clone (default:
                            /home/ubuntu/nectarcloud-tier0doco)
      -c CONFNAME, --confname CONFNAME
                            Base name of configuration file. Script will look for
                            CONFIGNAME.yaml.asc under script/configs of REPOPATH
                            (default: fdbot)
      -ap ARTICLEPATH, --articlepath ARTICLEPATH
                            articles path relative to repopath (default: articles)
      -l {DEBUG,INFO,WARNING,ERROR}, --loglevel {DEBUG,INFO,WARNING,ERROR}
                            Log level (default: INFO)
  • run ~/nectar-doco-bot-master/script/fdbroker.py with right arguments starting the bot!

After the bot has been successfully started, it generates a log file: fdbroker.log in the directory it runs. It also prints out the result it runs git commands in the terminal.

Related link

About

Bot to publish NeCTAR documents committed to GitHub onto Freshdesk

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 98.9%
  • Shell 1.1%