LingoBot Installation: Difference between revisions

From Lingoport Wiki
Jump to navigation Jump to search
← Older edit
Rdaly (talk | contribs)
4,499 edits
Rdaly (talk | contribs)
4,499 edits
 
(41 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)
# A bot needs to be created on your chosen adapter (Slack, Spark, or Flowdock)
# All the information about these users needs to be encapsulated in the configuration file to start the lingobot docker container on the Lingoport server.
# 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.  


/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'''  
 
  #
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>
  # Provide your home directory, lingobot folder will be created
  # REQUIRED CONFIG VARIABLES
  #
  export LINGOBOT_JENKINS_USERNAME=lingobot # default: lingobot
  home_directory=/home/centos
  export LINGOBOT_JENKINS_TOKEN=11d018ccbbea23a25cc443c8379aa3beda
  #
  export LINGOBOT_JENKINS_DOMAIN=<nowiki>http://acme.company.com/jenkins</nowiki>
  # Provide the Lingobot version
  export LINGOBOT_DASHBOARD_TOKEN=b7b190943d79516218b43775975a73f85eb6c67d
  #
  export JENKINS_HOME=/var/lib/jenkins # default: /var/lib/jenkins
  lingobot_image_version=
  export PORT=5001 # default: 5001
#
  export LINGOBOT_ADAPTER=slack # Possible values: 'flowdock', 'slack', (coming soon)'sparkwebhook'
  # Provide the Lingobot port
   
  #
  # OPTIONAL CONFIG VARIABLES
  serverPort=8083
  export LINGOBOT_JENKINS_PORT=8080 # default: 8080
#
  export LINGOBOT_DASHBOARD_URL=<nowiki>http://acme.company.com</nowiki> # 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
  # Provide your Docker Hub account token
  export HUBOT_FLOWDOCK_API_TOKEN=
  #
  export HUBOT_SLACK_TOKEN=xoxb-261328978756-rOmdLfqPg45U1Nm6iSczcetv
  docker_account_token=dckr_pat_cUuqyjSfv3JQRG0R5_cwmWsHceg
  export CISCOSPARK_ACCESS_TOKEN=
  # Slack security config
  export CISCOSPARK_SECRET=
  CLIENT_SIGNING_SECRET=
  export LINGOBOT_API_TOKEN= #this can be left blank, it will be filled in by the installation
  BOT_TOKEN=xoxb-**********
   
  APP_TOKEN=xapp-**********
  # OPTIONAL CONFIGS FOR LINGOBOT API
  COMMAND_CENTER_URL=https://your_server/command-center
# If these are unset, the default values are used
  COMMAND_CENTER_USER=
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_TOKEN=
  export LINGOBOT_API_STATUS_TIMEOUT_MINUTES= # identifies how long a JVM request will wait for a response. example: 60
  docker_image=lingoport/lingobot
  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
#[[Configure_the_Collaboration_Environment#LingoBot_Slack_Setup| Lingobot Slack Setup]]
** [[LingoBot Slack Setup]]
** [[LingoBot CA Flowdock 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 "https://wiki.lingoport.com/index.php?title=LingoBot_Installation&oldid=98553"