Difference between revisions of "LingoBot Installation"
(→Detailed Steps) |
|||
| (117 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| − | == |
+ | == Overview == |
| + | To start the lingobot service, some configuration is needed first. |
||
| − | 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 the LingoBot's configuration file: |
||
| + | # A Lingobot user needs to be added to the Command Center have access to projects |
||
| + | # 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. |
||
| + | == Configuration Settings: install.conf == |
||
| − | Below is a template of the configuration file's contents. The file itself can be found under LingoBot's home directory in the config subdirectory, and is called `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. |
||
| − | # 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: 'flowdock', 'slack', 'sparkwebhook' (Cisco Spark) |
||
| − | |||
| − | # 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= # required if LINGOBOT_ADAPTER is 'flowdock' |
||
| − | export HUBOT_SLACK_TOKEN= # required if LINGOBOT_ADAPTER is 'slack' |
||
| − | export CISCOSPARK_ACCESS_TOKEN= # required if LINGOBOT_ADAPTER is 'sparkwebhook' |
||
| − | export CISCOSPARK_SECRET= # required if LINGOBOT_ADAPTER is 'sparkwebhook'. |
||
| − | |||
| − | # NATURAL LANGUAGE PROCESSING (BETA) |
||
| − | export LINGOBOT_USE_NLP=false # If set to true, LingoBot will use NLP powered by wit.ai |
||
| + | Below is a template of the configuration file's contents for a Slack configuration. The file itself is called '''install.conf''' |
||
| − | Below, you will find instructions on how to obtain all of the necessary values to properly fill out this configuration file. |
||
| + | # |
||
| + | # 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: |
||
| − | The first step in the configuration process is to create a Jenkins user which can LingoBot have access to. This is the primary mechanism that LingoBot uses to access the Lingoport product suite, so it is very important that the configuration is done correctly. Please follow these instructions closely for the best results! |
||
| + | |||
| + | #[[Get the LingoBot installation files]] |
||
| + | #[[LingoBot Command Center Setup]] |
||
| + | #[[Configure_the_Collaboration_Environment#LingoBot_Slack_Setup| Lingobot Slack Setup]] |
||
| + | #[[Installing the Lingobot Service]] |
||
Latest revision as of 21:23, 19 March 2024
Overview
To start the lingobot service, some configuration is needed first.
- A Lingobot user needs to be added to the Command Center have access to projects
- 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.
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:
