Difference between revisions of "LingoBot Installation"

From Lingoport Wiki
Jump to: navigation, search
(→‎Set the Jenkins and Dashboard Locations)
(→‎Detailed Steps)
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
== Overview ==
  
== Overview ==
 
To start the lingobot service, some configuration is needed first.
  
To start the lingobot service, some configuration is needed first.
−
# A lingobot user needs to be added and configured in Jenkins
 +
# A Lingobot user needs to be added to the Command Center have access to projects
−
# A lingobot user needs to be added to the Dashboard
 +
# A bot needs to be created on your chosen adapter (Slack, Teams)
  +
# All the information about these users needs to be encapsulated in the configuration file to start the lingobot docker container on the Lingoport server.
−
# A bot needs to be created on your chosen adapter (Slack, Spark, or Flowdock)
  
−
# All the infomation about these users needs to be encapsulated in the configuration file to start the lingobot service on the globalization server.
  
−
# Start the lingoport.lingobot service on server.
 
   
−
== Configuration Settings: lingobot_config.sh ==
 +
== Configuration Settings: install.conf ==
−
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:
 +
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.
   
  +
Below is a template of the configuration file's contents for a Slack configuration. The file itself is called '''install.conf'''
−
/var/lib/jenkins/lingoport/lingobot-<x.y>
  
  +
#
−  
  +
# Provide your home directory, lingobot folder will be created
−
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 <code>/var/lib/jenkins/lingoport/lingobot-<x.y>/config</code>
  
  +
#
−
# REQUIRED CONFIG VARIABLES
  
  +
home_directory=/home/centos
−
export LINGOBOT_JENKINS_USERNAME=lingobot # default: lingobot
  
  +
#
−
export LINGOBOT_JENKINS_TOKEN=
  
  +
# Provide the Lingobot version
−
export LINGOBOT_JENKINS_DOMAIN=
  
  +
#
−
export LINGOBOT_DASHBOARD_TOKEN=
  
  +
lingobot_image_version=
−
export JENKINS_HOME=/var/lib/jenkins # default: /var/lib/jenkins
  
  +
#
−
export PORT=5001 # default: 5001
  
  +
# Provide the Lingobot port
−
export LINGOBOT_ADAPTER= # Possible values: 'botframework'(for Microsoft Teams)'flowdock', 'slack', (coming soon)'sparkwebhook'
  
  +
#
−
# OPTIONAL CONFIG VARIABLES
  
  +
serverPort=8083
−
export LINGOBOT_JENKINS_PORT=8080 # default: 8080
  
  +
#
−
export LINGOBOT_DASHBOARD_URL=$LINGOBOT_JENKINS_DOMAIN # default: same as jenkins domain
  
  +
# Provide your Docker Hub username
−
export LINGOBOT_DASHBOARD_PORT=9000 # default: 9000
  
  +
#
−
export LINGOBOT_NAME=LingoBot # default: LingoBot. This is the name to which lingobot will respond.
  
  +
docker_username=lingoportcustomer
−
# API TOKENS FOR ADAPTERS
  
  +
#
−
export HUBOT_FLOWDOCK_API_TOKEN=
  
  +
# Provide your Docker Hub account token
−
export HUBOT_SLACK_TOKEN=
  
  +
#
−
export CISCOSPARK_ACCESS_TOKEN=
  
  +
docker_account_token=dckr_pat_cUuqyjSfv3JQRG0R5_cwmWsHceg
−
export CISCOSPARK_SECRET=
  
  +
# Slack security config
−
export LINGOBOT_API_TOKEN=
  
  +
CLIENT_SIGNING_SECRET=
−
export BOTBUILDER_APP_ID=
  
  +
BOT_TOKEN=xoxb-**********
−
export BOTBUILDER_APP_PASSWORD=
  
  +
APP_TOKEN=xapp-**********
−
# OPTIONAL CONFIGS FOR LINGOBOT API
  
  +
COMMAND_CENTER_URL=https://your_server/command-center
−
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
  
  +
COMMAND_CENTER_USER=
−
export LINGOBOT_API_STATUS_TIMEOUT_MINUTES= # identifies how long a JVM request will wait for a response. The default is 2 minutes
  
  +
COMMAND_CENTER_TOKEN=
−
export LINGOBOT_API_STATUS_MINUTES_TO_KEEP_MAXIMUM= # identifies the maximum number of minutes a response message will be retained on the server
  
  +
docker_image=lingoport/lingobot
−
# BETA
  
−
export LINGOBOT_USE_NLP=false
  
−  
−  
−
=== Set the Jenkins and Dashboard Locations ===
  
−  
−
To get started, set the <code>LINGOBOT_DASHBOARD_URL</code> to the URL values for the Dashboard.
  
−
export LINGOBOT_DASHBOARD_URL=<nowiki>https://acme.company.com</nowiki>
  
−  
−
Leave the port values as they are defaulted.
  
−
export LINGOBOT_JENKINS_PORT=8080
  
−
export LINGOBOT_DASHBOARD_PORT=9000
  
−  
−
If you have an older system that uses the port numbers so that the Jenkins URL is something like <nowiki>http://acme.company.com:9000</nowiki>, then just use the URL before the port value.
 
−
export LINGOBOT_DASHBOARD_URL=<nowiki>http://acme.company.com</nowiki>
  
−
but make sure the port values are set.
  
−
export LINGOBOT_JENKINS_PORT=8080
  
−
export LINGOBOT_DASHBOARD_PORT=9000
  
−  
−
=== Setting or changing the Optional Configurations ===
  
−  
−
The optional configuration settings don't need to be set to complete the installation of LingoBot.
 
−  
−
To make changes see [[LingoBot_CLI#Server_Modifications|LingoBot CLI Server Modifications]]
  
−  
−
# 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 ==
  
== Detailed Steps ==
 
For step-by-step configuration, execute the following instructions:
  
For step-by-step configuration, execute the following instructions:
   
−
#[[Set Up Jenkins Lingobot User]]
 +
#[[Get the LingoBot installation files]]
−
#[[LingoBot Dashboard Setup]]
 +
#[[LingoBot Command Center Setup]]
  +
#[[Configure_the_Collaboration_Environment#LingoBot_Slack_Setup| Lingobot Slack Setup]]
−
# [[Configure the Collaboration Environment]] or select the step below that corresponds your collaboration environment
  
−
## [[Configure_the_Collaboration_Environment#LingoBot_Slack_Setup| Lingobot Slack Setup]]
  
−
## [[Configure_the_Collaboration_Environment#LingoBot_MS_Teams_Setup| LingoBot MS Team Setup]]
  
−
## [[Configure_the_Collaboration_Environment#LingoBot_CA_Flowdock_Setup| LingoBot CA Flowdock Setup]]
  
−
## [[Configure_the_Collaboration_Environment#LingoBot_Cisco_Spark_Setup| LingoBot Cisco Spark Setup]]
  
 
#[[Installing the Lingobot Service]]
  
#[[Installing the Lingobot Service]]
−
#[[Lingobot CLI verification]]
  

Latest revision as of 21:23, 19 March 2024

Overview

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

  1. A Lingobot user needs to be added to the Command Center have access to projects
  2. A bot needs to be created on your chosen adapter (Slack, Teams)
  3. All the information about these users needs to be encapsulated in the configuration file to start the lingobot docker container on the Lingoport server.

Configuration Settings: install.conf

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.

Below is a template of the configuration file's contents for a Slack configuration. The file itself is called install.conf 

#
# Provide your home directory, lingobot folder will be created
#
home_directory=/home/centos
#
# Provide the Lingobot version
#
lingobot_image_version=
#
# Provide the Lingobot port
#
serverPort=8083
#
# Provide your Docker Hub username
#
docker_username=lingoportcustomer 
#
# Provide your Docker Hub account token
#
docker_account_token=dckr_pat_cUuqyjSfv3JQRG0R5_cwmWsHceg
# Slack security config
CLIENT_SIGNING_SECRET=
BOT_TOKEN=xoxb-**********
APP_TOKEN=xapp-**********
COMMAND_CENTER_URL=https://your_server/command-center
COMMAND_CENTER_USER=
COMMAND_CENTER_TOKEN=
docker_image=lingoport/lingobot

Detailed Steps

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

  1. Get the LingoBot installation files
  2. LingoBot Command Center Setup
  3. Lingobot Slack Setup
  4. Installing the Lingobot Service
Retrieved from "http://wiki.lingoport.com/index.php?title=LingoBot_Installation&oldid=98553"