Difference between revisions of "LingoBot Installation"

From Lingoport Wiki
Jump to: navigation, search
(Configuration Settings: lingobot_config.sh)
(Detailed Steps)
 
(8 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 to the Command Center and have projects access
+
# 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)
 
# 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.
+
# 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: 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.
 
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'''
 
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
+
# Provide your home directory, lingobot folder will be created
#
+
#
home_directory=/home/centos
+
home_directory=/home/centos
  +
#
 
  +
# Provide the Lingobot version
#
 
  +
#
# Provide the Lingobot version
 
  +
lingobot_image_version=
#
 
  +
#
lingobot_image_version=
 
  +
# Provide the Lingobot port
 
  +
#
 
  +
serverPort=8083
#
 
  +
#
# Provide the Lingobot port
 
  +
# Provide your Docker Hub username
#
 
  +
#
serverPort=8083
 
  +
docker_username=lingoportcustomer
 
#
+
#
# Provide your Docker Hub username
+
# Provide your Docker Hub account token
#
+
#
  +
docker_account_token=dckr_pat_cUuqyjSfv3JQRG0R5_cwmWsHceg
docker_username=lingoportcustomer
 
  +
# Slack security config
 
  +
CLIENT_SIGNING_SECRET=
#
 
  +
BOT_TOKEN=xoxb-**********
# Provide your Docker Hub account token
 
  +
APP_TOKEN=xapp-**********
#
 
  +
COMMAND_CENTER_URL=https://your_server/command-center
docker_account_token=dckr_pat_cUuqyjSfv3JQRG0R5_cwmWsHceg
 
  +
COMMAND_CENTER_USER=
 
  +
COMMAND_CENTER_TOKEN=
# Slack security config
 
  +
docker_image=lingoport/lingobot
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 ==
 
== 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#LingoBot_Slack_Setup| Lingobot Slack Setup]]
# [[Configure the Collaboration Environment]] or select the step below that corresponds your collaboration environment
 
## [[Configure_the_Collaboration_Environment#LingoBot_Slack_Setup| Lingobot Slack Setup]]
 
## [[Configure_the_Collaboration_Environment#LingoBot_MS_Teams_Setup| LingoBot MS Team Setup]]
 
## [[Configure_the_Collaboration_Environment#LingoBot_CA_Flowdock_Setup| LingoBot CA Flowdock Setup]]
 
## [[Configure_the_Collaboration_Environment#LingoBot_Cisco_Spark_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