Difference between revisions of "LingoBot Installation"

From Lingoport Wiki
Jump to: navigation, search
(Detailed Steps)
(Detailed Steps)
Line 44: Line 44:
 
For step-by-step configuration, execute the following instructions:
 
For step-by-step configuration, execute the following instructions:
 
*[http://wiki.lingoport.com/Set_Up_Jenkins_Lingobot_User Set Up Jenkins Lingobot User]
 
*[http://wiki.lingoport.com/Set_Up_Jenkins_Lingobot_User Set Up Jenkins Lingobot User]
  +
[[Set Up Jenkins Lingobot User]]
 
*[http://wiki.lingoport.com/LingoBot_Dashboard_Setup LingoBot Dashboard Setup]
 
*[http://wiki.lingoport.com/LingoBot_Dashboard_Setup LingoBot Dashboard Setup]
 
* Configure the Collaboration Environment
 
* Configure the Collaboration Environment
Line 50: Line 51:
 
** [[LingoBot Cisco Spark Setup]]
 
** [[LingoBot Cisco Spark Setup]]
 
*[http://wiki.lingoport.com/Installing_the_Lingobot_Service Install and Start the Lingobot Service]
 
*[http://wiki.lingoport.com/Installing_the_Lingobot_Service Install and Start the Lingobot Service]
  +
* [[Lingobot CLI verification]]

Revision as of 19:35, 9 August 2018

Overview

To start the lingobot service, some configuration is needed first.

  1. A lingobot user needs to be added and configured in Jenkins
  2. A lingobot user needs to be added to the Dashboard
  3. A bot needs to be created on your chosen adapter (Slack, Spark, or Flowdock)
  4. All the infomation about these users needs to be encapsulated in the configuration file to start the lingobot service on the globalization server.
  5. Start the lingoport.lingobot service on server.

Configuration Settings: lingobot_config.sh

Configuration for LingoBot is intended to be as simple as possible. All that is needed for this friendly chatbot to be ready for use are a few environment variables, all of which should be set in LingoBot's configuration file. The config file can be found in LingoBot's home directory under the "config" sub-directory. By default, LingoBot home is set to:

/var/lib/jenkins/lingoport/lingobot-<x.y>

Below is a template of the configuration file's contents for a Slack configuration. The file itself is called lingobot_config.sh and is located in /var/lib/jenkins/lingoport/lingobot-<x.y>/config

# REQUIRED CONFIG VARIABLES
export LINGOBOT_JENKINS_USERNAME=lingobot # default: lingobot
export LINGOBOT_JENKINS_TOKEN=11d018ccbbea23a25cc443c8379aa3beda
export LINGOBOT_JENKINS_DOMAIN=http://acme.company.com/jenkins
export LINGOBOT_DASHBOARD_TOKEN=b7b190943d79516218b43775975a73f85eb6c67d
export JENKINS_HOME=/var/lib/jenkins # default: /var/lib/jenkins
export PORT=5001 # default: 5001
export LINGOBOT_ADAPTER=slack # Possible values: 'flowdock', 'slack', (coming soon)'sparkwebhook'

# OPTIONAL CONFIG VARIABLES
export LINGOBOT_JENKINS_PORT=8080 # default: 8080
export LINGOBOT_DASHBOARD_URL=http://acme.company.com # default: same as jenkins domain
export LINGOBOT_DASHBOARD_PORT=9000 # default: 9000
export LINGOBOT_NAME=LingoBot # default: LingoBot. This is the name to which lingobot will respond.

# API TOKENS FOR ADAPTERS
export HUBOT_FLOWDOCK_API_TOKEN=
export HUBOT_SLACK_TOKEN=xoxb-261328978756-rOmdLfqPg45U1Nm6iSczcetv
export CISCOSPARK_ACCESS_TOKEN=
export CISCOSPARK_SECRET=
export LINGOBOT_API_TOKEN= #this can be left blank, it will be filled in by the installation

# OPTIONAL CONFIGS FOR LINGOBOT API
# If these are unset, the default values are used
export LINGOBOT_API_STATUS_INTERVAL_SECONDS_ARRAY= # example: 15,30,60,150,300 (note: the last interval will continue to be used until the timeout    is reached
export LINGOBOT_API_STATUS_TIMEOUT_MINUTES= # identifies how long a JVM request will wait for a response. example: 60
export LINGOBOT_API_STATUS_MINUTES_TO_KEEP_MAXIMUM= # identifies the maximum number of minutes a response message will be retained on the server

Detailed Steps

For step-by-step configuration, execute the following instructions:

Set Up Jenkins Lingobot User