Difference between revisions of "LingoBot Installation"
(→Detailed Steps) |
(→Detailed Steps) |
||
Line 78: | Line 78: | ||
# [[Configure the Collaboration Environment]] or select the step below that corresponds your collaboration environment |
# [[Configure the Collaboration Environment]] or select the step below that corresponds your collaboration environment |
||
## [https://wiki.lingoport.com/Configure_the_Collaboration_Environment#LingoBot_Slack_Setup Lingobot Slack Setup] |
## [https://wiki.lingoport.com/Configure_the_Collaboration_Environment#LingoBot_Slack_Setup Lingobot Slack Setup] |
||
− | ## [[Lingobot Slack |
+ | ## [[Lingobot Slack Setup]] |
## [https://wiki.lingoport.com/Configure_the_Collaboration_Environment#LingoBot_MS_Teams_Setup LingoBot MS Team Setup] |
## [https://wiki.lingoport.com/Configure_the_Collaboration_Environment#LingoBot_MS_Teams_Setup LingoBot MS Team Setup] |
||
## [https://wiki.lingoport.com/Configure_the_Collaboration_Environment#LingoBot_CA_Flowdock_Setup LingoBot CA Flowdock Setup] |
## [https://wiki.lingoport.com/Configure_the_Collaboration_Environment#LingoBot_CA_Flowdock_Setup LingoBot CA Flowdock Setup] |
Revision as of 19:20, 5 December 2018
Contents
Overview
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 Dashboard
- 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 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= export LINGOBOT_JENKINS_DOMAIN= export LINGOBOT_DASHBOARD_TOKEN= export JENKINS_HOME=/var/lib/jenkins # default: /var/lib/jenkins export PORT=5001 # default: 5001 export LINGOBOT_ADAPTER= # Possible values: 'botframework'(for Microsoft Teams)'flowdock', 'slack', (coming soon)'sparkwebhook' # OPTIONAL CONFIG VARIABLES export LINGOBOT_JENKINS_PORT=8080 # default: 8080 export LINGOBOT_DASHBOARD_URL=$LINGOBOT_JENKINS_DOMAIN # 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= export CISCOSPARK_ACCESS_TOKEN= export CISCOSPARK_SECRET= export LINGOBOT_API_TOKEN= export BOTBUILDER_APP_ID= export BOTBUILDER_APP_PASSWORD= # OPTIONAL CONFIGS FOR LINGOBOT API 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. The default is 2 minutes export LINGOBOT_API_STATUS_MINUTES_TO_KEEP_MAXIMUM= # identifies the maximum number of minutes a response message will be retained on the server # BETA export LINGOBOT_USE_NLP=false
Set the Jenkins and Dashboard Locations
To get started, set the LINGOBOT_JENKINS_DOMAIN
and LINGOBOT_DASHBOARD_URL
to the URL values for Jenkins and the Dashboard.
export LINGOBOT_JENKINS_DOMAIN=http://acme.company.com/jenkins export LINGOBOT_DASHBOARD_URL=http://acme.company.com
Leave the port values as they are defaulted.
export LINGOBOT_JENKINS_PORT=8080 export LINGOBOT_DASHBOARD_PORT=9000
If you have an a system that uses the port numbers so that the Jenkins URL is something like http://acme.company.com:8080 and the Dashboard is http://acme.company.com:9000, then just use the URL before the port value.
export LINGOBOT_JENKINS_DOMAIN=http://acme.company.com export LINGOBOT_DASHBOARD_URL=http://acme.company.com
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
# 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
- LingoBot Dashboard Setup
- Configure the Collaboration Environment or select the step below that corresponds your collaboration environment
- Installing the Lingobot Service
- Lingobot CLI verification