|
|
| Line 6: |
Line 6: |
|
| |
|
| == Configuration Settings: lingobot_config.sh == | | == 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: | | 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. |
|
| |
|
| /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 '''install.conf''' |
| | # |
| | # Provide your home directory, lingobot folder will be created |
| | # |
| | home_directory=/home/centos |
|
| |
|
| 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
| | # Provide the Lingobot version |
| export LINGOBOT_JENKINS_USERNAME=lingobot # default: lingobot
| | # |
| export LINGOBOT_JENKINS_TOKEN=
| | lingobot_image_version= |
| 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 ===
| | # |
| | # Provide the Lingobot port |
| | # |
| | serverPort=8083 |
|
| |
|
| 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>
| | # Provide your Docker Hub username |
| | # |
| | docker_username=lingoportcustomer |
|
| |
|
| Leave the port values as they are defaulted.
| | # |
| export LINGOBOT_JENKINS_PORT=8080
| | # Provide your Docker Hub account token |
| export LINGOBOT_DASHBOARD_PORT=9000
| | # |
| | docker_account_token=dckr_pat_cUuqyjSfv3JQRG0R5_cwmWsHceg |
|
| |
|
| If you have an older system that uses the port numbers so that the Dashboard URL is something like <nowiki>http://acme.company.com:9000</nowiki>, then just use the URL before the port value.
| | # Slack security config |
| export LINGOBOT_DASHBOARD_URL=<nowiki>http://acme.company.com</nowiki>
| | CLIENT_SIGNING_SECRET= |
| but make sure the port values are set.
| |
| export LINGOBOT_JENKINS_PORT=8080
| |
| export LINGOBOT_DASHBOARD_PORT=9000
| |
|
| |
|
| === Setting or changing the Optional Configurations === | | BOT_TOKEN=xoxb-********** |
| | APP_TOKEN=xapp-********** |
|
| |
|
| The optional configuration settings don't need to be set to complete the installation of LingoBot.
| | COMMAND_CENTER_URL=https://your_server/command-center |
|
| |
|
| To make changes see [[LingoBot_CLI#Server_Modifications|LingoBot CLI Server Modifications]]
| | COMMAND_CENTER_URSER= |
|
| |
|
| # OPTIONAL CONFIGS FOR LINGOBOT API
| | COMMAND_CENTER_TOKEN= |
| # 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
| | docker_image=lingoport/lingobot |
| 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 == |
Overview
To start the lingobot service, some configuration is needed first.
- A Lingobot user needs to be added to the Command Center and have projects access
- A bot needs to be created on your chosen adapter (Slack, Teams)
- All the infomation about these users needs to be encapsulated in the configuration file to start the lingobot docker container on the Lingoport 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.
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_URSER=
COMMAND_CENTER_TOKEN=
docker_image=lingoport/lingobot
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
- Lingobot Slack Setup
- LingoBot MS Team Setup
- LingoBot CA Flowdock Setup
- LingoBot Cisco Spark Setup
- Installing the Lingobot Service
- Lingobot CLI verification