Difference between revisions of "LingoBot Installation"
(→Configuration Overview) |
(→Detailed Steps) |
||
| (50 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | == |
+ | == Overview == |
To start the lingobot service, some configuration is needed first. |
To start the lingobot service, some configuration is needed first. |
||
| − | # A |
+ | # A Lingobot user needs to be added to the Command Center have access to projects |
| − | # A |
+ | # 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: 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''' |
||
| + | # |
||
| − | # REQUIRED CONFIG VARIABLES |
||
| + | home_directory=/home/centos |
||
| − | export LINGOBOT_JENKINS_USERNAME=lingobot # default: lingobot |
||
| + | # |
||
| − | export LINGOBOT_JENKINS_TOKEN=11d018ccbbea23a25cc443c8379aa3beda |
||
| + | # Provide the Lingobot version |
||
| − | export LINGOBOT_JENKINS_DOMAIN=<nowiki>http://acme.company.com/jenkins</nowiki> |
||
| + | # |
||
| − | export LINGOBOT_DASHBOARD_TOKEN=b7b190943d79516218b43775975a73f85eb6c67d |
||
| + | 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=slack # Possible values: 'flowdock', 'slack', (coming soon)'sparkwebhook' |
||
| − | + | # |
|
| + | serverPort=8083 |
||
| − | # OPTIONAL CONFIG VARIABLES |
||
| + | # |
||
| − | export LINGOBOT_JENKINS_PORT=8080 # default: 8080 |
||
| + | # Provide your Docker Hub username |
||
| − | export LINGOBOT_DASHBOARD_URL=<nowiki>http://acme.company.com</nowiki> # default: same as jenkins domain |
||
| + | # |
||
| − | export LINGOBOT_DASHBOARD_PORT=9000 # default: 9000 |
||
| + | docker_username=lingoportcustomer |
||
| − | export LINGOBOT_NAME=LingoBot # default: LingoBot. This is the name to which lingobot will respond. |
||
| − | + | # |
|
| + | # Provide your Docker Hub account token |
||
| − | # API TOKENS FOR ADAPTERS |
||
| + | # |
||
| − | export HUBOT_FLOWDOCK_API_TOKEN= |
||
| + | docker_account_token=dckr_pat_cUuqyjSfv3JQRG0R5_cwmWsHceg |
||
| − | export HUBOT_SLACK_TOKEN=xoxb-261328978756-rOmdLfqPg45U1Nm6iSczcetv |
||
| + | # Slack security config |
||
| − | export CISCOSPARK_ACCESS_TOKEN= |
||
| + | CLIENT_SIGNING_SECRET= |
||
| − | export CISCOSPARK_SECRET= |
||
| + | BOT_TOKEN=xoxb-********** |
||
| − | export LINGOBOT_API_TOKEN= #this can be left blank, it will be filled in by the installation |
||
| + | APP_TOKEN=xapp-********** |
||
| − | |||
| + | COMMAND_CENTER_URL=https://your_server/command-center |
||
| − | # OPTIONAL CONFIGS FOR LINGOBOT API |
||
| + | COMMAND_CENTER_USER= |
||
| − | # If these are unset, the default values are used |
||
| + | COMMAND_CENTER_TOKEN= |
||
| − | 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 == |
||
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] |
||
| + | #[[Get the LingoBot installation files]] |
||
| − | *[http://wiki.lingoport.com/LingoBot_Dashboard_Setup LingoBot Dashboard Setup] |
||
| + | #[[LingoBot Command Center Setup]] |
||
| − | *[http://wiki.lingoport.com/Configure_the_Collaboration_Environment Configure the Collaboration Environment] |
||
| + | #[[Configure_the_Collaboration_Environment#LingoBot_Slack_Setup| Lingobot Slack Setup]] |
||
| − | *[http://wiki.lingoport.com/Installing_the_Lingobot_Service Install and Start the Lingobot Service] |
||
| + | #[[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:
