Difference between revisions of "LingoBot Installation"

From Lingoport Wiki
Jump to: navigation, search
(→‎Running LingoBot on the CLI)
(→‎Detailed Steps)
 
(80 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
== Configuration Overview ==
 +
== 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 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:
  
  +
# 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 ==
−
/var/lib/jenkins/lingoport/lingobot-X.Y
  
  +
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. The file itself is called `lingobot_config.sh`
 +
Below is a template of the configuration file's contents for a Slack configuration. The file itself is called '''install.conf'''
  +
#
−
# REQUIRED CONFIG VARIABLES
  
  +
# Provide your home directory, lingobot folder will be created
−
export LINGOBOT_JENKINS_USERNAME=lingobot # default: lingobot
  
  +
#
−
export LINGOBOT_JENKINS_TOKEN=
  
  +
home_directory=/home/centos
−
export LINGOBOT_JENKINS_DOMAIN=
  
  +
#
−
export LINGOBOT_DASHBOARD_TOKEN=
  
  +
# Provide the Lingobot version
−
export JENKINS_HOME=/var/lib/jenkins # default: /var/lib/jenkins
  
  +
#
−
export PORT=5001 # default: 5001
  
  +
lingobot_image_version=
−
export LINGOBOT_ADAPTER= # Possible values: 'flowdock', 'slack', 'sparkwebhook' (Cisco Spark)
  
−
+
#
  +
# Provide the Lingobot port
−
# OPTIONAL CONFIG VARIABLES
  
  +
#
−
export LINGOBOT_JENKINS_PORT=8080 # default: 8080
  
  +
serverPort=8083
−
export LINGOBOT_DASHBOARD_URL=$LINGOBOT_JENKINS_DOMAIN # default: same as jenkins domain
  
  +
#
−
export LINGOBOT_DASHBOARD_PORT=9000 # default: 9000
  
  +
# Provide your Docker Hub username
−
export LINGOBOT_NAME=LingoBot # default: LingoBot. This is the name to which lingobot will respond.
  
−
+
#
  +
docker_username=lingoportcustomer
−
# API TOKENS FOR ADAPTERS
  
  +
#
−
export HUBOT_FLOWDOCK_API_TOKEN= # required if LINGOBOT_ADAPTER is 'flowdock'
  
  +
# Provide your Docker Hub account token
−
export HUBOT_SLACK_TOKEN= # required if LINGOBOT_ADAPTER is 'slack'
  
  +
#
−
export CISCOSPARK_ACCESS_TOKEN= # required if LINGOBOT_ADAPTER is 'sparkwebhook'
  
  +
docker_account_token=dckr_pat_cUuqyjSfv3JQRG0R5_cwmWsHceg
−
export CISCOSPARK_SECRET= # required if LINGOBOT_ADAPTER is 'sparkwebhook'.
  
  +
# Slack security config
−
 
  +
CLIENT_SIGNING_SECRET=
−
# NATURAL LANGUAGE PROCESSING (BETA)
  
  +
BOT_TOKEN=xoxb-**********
−
export LINGOBOT_USE_NLP=false # If set to true, LingoBot will use NLP powered by wit.ai
  
  +
APP_TOKEN=xapp-**********
  +
COMMAND_CENTER_URL=https://your_server/command-center
  +
COMMAND_CENTER_USER=
  +
COMMAND_CENTER_TOKEN=
  +
docker_image=lingoport/lingobot
   
  +
== Detailed Steps ==
−
Below, you will find instructions on how to obtain all of the necessary values to properly fill out this configuration file.
  
  +
For step-by-step configuration, execute the following instructions:
   
  +
#[[Get the LingoBot installation files]]
−
== LingoBot Jenkins Setup ==
  
  +
#[[LingoBot Command Center Setup]]
−
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!
  
  +
#[[Configure_the_Collaboration_Environment#LingoBot_Slack_Setup| Lingobot Slack Setup]]
−  
  +
#[[Installing the Lingobot Service]]
−
* Navigate to your Lingoport Jenkins instance in a web browser (this is typically hosted on port 8080 of the Lingoport server).
  
−
* If an admin account has been configured, log in as the admin (otherwise no login is necessary) and click on the "Manage Jenkins" menu item on the left hand side of the window. (indicated by a small gear icon).
  
−
** If you don't see this menu item, this means the current account does not have administrative privileges.
  
−
* Click on "Configure Global Security", and on this page make sure that the following boxes are checked:
  
−
** Enable security
  
−
** Jenkins' own user database
  
−
** One of the authorization methods (preferably "Matrix-based security").
  
−
*** IMPORTANT: If Matrix-based security is selected and no users have been configured yet, make sure that "Anonymous" has full privileges (all boxes next to Anonymous MUST be checked).
  
−
* Once this is done, click "Apply" and return to the previous "Manage Jenkins" page.
  
−
* Scroll down and click on "Manage Users", and on this page, select "Create User" from the left hand menu and fill out the form with the following information:
  
−
** Username: "lingobot"
  
−
** Password: Choose a secure password.
  
−
** Confirm Password: Repeat your previous entry
  
−
** Full Name: "LingoBot"
  
−
** Email: "lingobot@lingoport.com"
  
−
* Click "Create User"
  
−
* Return once again to the "Configure Global Security" page (Manage Jenkins > Configure Global Security) and scroll down to the "Authorization" section.
  
−
* In the "User/group to add" field under Matrix-based security, enter "lingobot" and click add. This should result in lingobot being added as a row in the security matrix above.
  
−
* Enable the following security permissions for the lingobot account:
  
−
** Under "Overall"
  
−
*** Administer
  
−
*** Read
  
−
** Under "Job"
  
−
*** Build
  
−
*** Cancel
  
−
*** Configure
  
−
*** Create
  
−
*** Delete
  
−
*** Read
  
−
*** Workspace
  
−
** Under "View"
  
−
*** Configure
  
−
*** Read
  
−
* Once those boxes are checked, click "Apply" and log out if you were previously logged in.
  
−
* Log in as the newly created "lingobot" account using the password you just created.
  
−
* Once logged in, In the top-right hand corner of the window, click on the account name (LingoBot)
  
−
* Select "configure" from the menu on the left (or from the dropdown menu below the account-name button)
  
−
* On this page there should be a section called "API Token" and a corresponding button labeled "Show API Token...". Click this button.
  
−
* Copy the API Token that is displayed and paste it into the LingoBot configuration file next to the LINGOBOT_JENKINS_TOKEN variable declaration.
 
−  
−
Example:
  
−
export LINGOBOT_JENKINS_TOKEN=1234567890abcdef14d4f2789bea4f22a
  
−  
−
You're done with this part! Just make sure that the LINGOBOT_JENKINS_USERNAME is set correctly to the username you chose when creating LingoBot's Jenkins account (by default it is set to "lingobot")
  
−  
−
== LingoBot Dashboard Setup ==
  
−
The next step in the configuration process is to create a Dashboard user account for LingoBot. This step is also crucial to the functionality of the bot itself, so it is very important that these steps are followed carefully.
  
−  
−
* Navigate to your Lingoport Dashboard instance in a web browser (this is typically hosted on port 9000 of the Lingoport server).
  
−
* Log in as the administrator account.
  
−
** The default credentials are username: "admin", password: "admin".
  
−
* From the top navigation bar, select the "Administration" tab.
  
−
* The following page should have a drop-down menu near the top of the screen labeled "Security"
  
−
** From this drop-down menu, select "Users"
  
−
* On the right side of this page, click "Create User" and a form overlay should appear. Fill this form with the following information:
  
−
** Login: "lingobot"
  
−
** Name: "LingoBot"
  
−
** Email: "lingobot@lingoport.com"
  
−
** Password: Choose a secure password.
  
−
* Click "Create", and a new user row should appear on the "Users" page.
  
−
* Under the "GROUPS" column, click the small blue menu icon on the row corresponding to the newly created user account. An overlay should appear.
  
−
** In this overlay, select the "Deselected" tab.
  
−
** Check the box labeled "sonar-administrators", then click done.
  
−
* Under the "TOKENS" column, click the small blue menu icon on the row corresponding to the newly created user account. Another overlay should appear.
  
−
** In the "Generate Tokens" field, enter a token name (this can be anything. i.e. "lingobot") and click the "Generate" button.
  
−
** Click the "Copy" button that appears, or select and copy the API token that has appeared.
  
−
* Paste the API token into the LingoBot configuration file next to the LINGOBOT_DASHBOARD_TOKEN variable declaration.
  
−  
−
Example:
  
−
export LINGOBOT_DASHBOARD_TOKEN=1234567890abcdef14d4f2789bea4f22a
  
−  
−
Once this is complete, you're done configuring this part of LingoBot! The remaining configuration steps depend on which collaboration environment you will be using to communicate with LingoBot.
  
−  
−
Skip to the collaboration environment you will be using:
  
−
* [http://wiki.lingoport.com/LingoBot_Installation#LingoBot_Slack_Setup Slack]
  
−
* [http://wiki.lingoport.com/LingoBot_Installation#LingoBot_Flowdock_Setup CA Flowdock]
  
−
* [http://wiki.lingoport.com/LingoBot_Installation#LingoBot_Cisco_Spark_Setup Cisco Spark]
  
−  
−
== LingoBot Slack Setup ==
  
−
This portion of the installation guide only applies if the collaboration environment you will be using is Slack. If you will be using either Flowdock or Cisco Spark, please skip to the corresponding setup instructions.
  
−  
−
* Navigate to the [http://my.slack.com/services/new/bot Slack Custom Bot Creation] page, and log in as an account that is a part of your company's Slack organization.
  
−
* In the new bot username field, enter the name that you would like LingoBot to respond to.
  
−
** By default, we recommend simply calling it "lingobot", however you're welcome to name it whatever you would like.
  
−
** If you do choose to call it something other than "lingobot", make sure that you set the LINGOBOT_NAME variable in the configuration file to whatever name you chose.
  
−
*** Example: <code>export LINGOBOT_NAME=lingobot-123</code>
  
−
* Once you have decided on a name, click "Add Bot Integration" to continue to the next page.
  
−
* On this page, you can set a custom icon for the bot under the "Customize Icon" section. You can download the following icon and upload it, upload your own custom icon, or simply leave it blank.
  
−
[[File:Lingoport logo small.jpeg]]
  
−
* Once this is done, scroll down to the bottom of the page and click "Save Integration"
  
−
* Finally, copy the API Token that is provided near the top of the page and paste it into the LingoBot configuration file next to the HUBOT_SLACK_TOKEN variable declaration.
  
−  
−
Example:
  
−
export HUBOT_SLACK_TOKEN=xoxb-1234567890000-aAbBcCdDeEfFgGtTfF
  
−  
−
Furthermore, make sure the LINGOBOT_ADAPTER variable is set to "slack".
  
−  
−
Example:
  
−
export LINGOBOT_ADAPTER=slack
  
−  
−
Once this is complete, the bot is now configured and ready to be installed! Follow the instructions below on running the installation script to finish the installation process.
  
−  
−
Skip to the next step: [http://wiki.lingoport.com/LingoBot_Installation#Running_The_Installation_Script Running The Installation Script]
  
−  
−
== LingoBot CA Flowdock Setup ==
  
−
This portion of the installation guide only applies if the collaboration environment you will be using is CA Flowdock. If you will be using either Slack or Cisco Spark, please follow the corresponding setup instructions.
  
−  
−
Setting up LingoBot to run on CA Flowdock is as simple as creating a new user account through which LingoBot will communicate. If you would rather not deal with the hassle of creating a new Flowdock user account, feel free to ask us to make one for your LingoBot instance. We will send you the API token needed for LingoBot's configuration file and you can simply invite the account to join your Flow once it is ready.
  
−  
−
If you don't mind creating the account yourself, then simply follow these instructions to do so.
 
−  
−
* First, you will need an email account with which you can create a Flowdock account. You can make one for free on [https://accounts.google.com/SignUp?hl=en-US Gmail] if need be.
  
−
* Once this is completed, navigate to the [https://www.flowdock.com/signup Flowdock Sign Up page] and click "Sign Up Using Google"
  
−
* When prompted, sign in using the Google account you created for LingoBot (alternatively, you can sign up using a non-google account by filling out the details manually).
  
−
* Once the account has been created, navigate to the [https://www.flowdock.com/account/edit Profile Editing Page] and set the following information:
  
−
** Name: Lingoport Chatbot
  
−
** Display Name: By default, we recommend simply calling it "lingobot", however you're welcome to name it whatever you would like.
  
−
*** If you do choose to call it something other than "lingobot", make sure that you set the LINGOBOT_NAME variable in the configuration file to whatever name you chose.
  
−
*** Example: <code>export LINGOBOT_NAME=lingobot-123</code>
  
−
** Avatar: You can download the following icon and upload it, upload your own custom icon, or simply leave it blank.
  
−
[[File:Lingoport logo small.jpeg]]
  
−
* Once this is done, scroll down and click "Update Profile"
  
−
* The final step is to navigate to the [https://www.flowdock.com/account/tokens API Tokens page]. Here you will find an API token labeled "Personal Api Token".
  
−
* Copy the API token and paste it into the LingoBot configuration file next to the HUBOT_FLOWDOCK_API_TOKEN variable declaration.
  
−  
−
Example:
  
−
export HUBOT_FLOWDOCK_API_TOKEN=0a1b2c3d4e5f6g7a8b9c0d
  
−  
−
Furthermore, make sure the LINGOBOT_ADAPTER variable is set to "flowdock".
  
−  
−
Example:
  
−
export LINGOBOT_ADAPTER=flowdock
  
−  
−
Once this is complete, the bot is now configured and ready to be installed! Follow the instructions below on running the installation script to finish the installation process.
  
−  
−
Skip to the next step: [http://wiki.lingoport.com/LingoBot_Installation#Running_The_Installation_Script Running The Installation Script]
  
−  
−
== LingoBot Cisco Spark Setup ==
  
−
This portion of the installation guide only applies if the collaboration environment you will be using is Cisco Spark. If you will be using either Slack or CA Flowdock, please follow the corresponding setup instructions.
  
−  
−
Configuring LingoBot to communicate via Cisco Spark is a fairly straight forward process. All that is required is access to an account that has access to your organization's Cisco Spark.
  
−  
−
=== Creating a Custom Bot ===
  
−
* The first step is to sign in to your Cisco Spark account on the [https://developer.ciscospark.com/# Developer Portal].
  
−
* Once signed in, navigate to the [https://developer.ciscospark.com/add-bot.html Custom Bot Creation page].
  
−
* On the bot creation page, fill in the form with the following information:
  
−
** Display Name: By default, we recommend simply calling it "lingobot", however you're welcome to name it whatever you would like.
  
−
*** If you do choose to call it something other than "lingobot", make sure that you set the LINGOBOT_NAME variable in the configuration file to whatever name you chose.
  
−
*** Example: <code>export LINGOBOT_NAME=lingobot-123</code>
  
−
** Bot Name: Ideally this should be the same as the display name, however due to the necessity that it be unique this can be just about anything. This will only be used to invite the bot to a chat room.
  
−
** Icon: Paste the following URL into the Icon field: '''http://i.imgur.com/3bzw0zp.jpg'''
  
−
* Once this is done, click "Add Bot". On the following page, you will find an API token. Click the "Copy" button next to it (or select and copy the token itself) then paste it into the LingoBot configuration file next to the CISCOSPARK_ACCESS_TOKEN variable declaration.
  
−  
−
Example:
  
−
export CISCOSPARK_ACCESS_TOKEN=LDA5YjBiOTItMTAwOS00ODMxLTk4ZjEtYTQ4OGI4N2FjN2Y2MjVlM2QyNTUtYmM2
  
−  
−
=== Creating a Webhook for LingoBot ===
  
−
* The final step is to create a webhook that LingoBot can receive message event notifications through. To do this, navigate to the [https://developer.ciscospark.com/endpoint-webhooks-post.html Spark Webhook Creation Page].
  
−
* Make sure that the "Test Mode" switch is turned ON. This will allow you to generate webhooks directly into your organization's account.
  
−
* Under the "Request Headers" section, fill in the following information:
  
−
** Authorization: "Bearer '''[YOUR BOT'S API TOKEN HERE]'''"
  
−
* In the "Request Parameters" section, fill in the the following information under the "Your values" column:
  
−
** name: This can be anything. i.e. "lingobot".
  
−
** targetURL: "'''[YOUR JENKINS INSTANCE URL HERE]''':5001/hubot/ciscospark/incoming"
  
−
** resource: "all"
  
−
** event: "all"
  
−
** secret: This can be just about anything, but ideally it is a random string of letters and numbers that it at least 32 characters long.
  
−
*** Whatever you chose for this must also be copied to the LingoBot configuration file, next to the CISCOSPARK_SECRET variable declaration.
  
−
Example:
 
−
export CISCOSPARK_SECRET=a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
  
−
* Once all of these values have been entered, click the "Run" button. You should see a response containing the webhook's information on the right.
  
−  
−
Finally, make sure the LINGOBOT_ADAPTER variable is set to "sparkwebhook".
  
−  
−
Example:
  
−
export LINGOBOT_ADAPTER=sparkwebhook
  
−  
−
Once this is complete, the bot is now configured and ready to be installed! Follow the instructions below on running the installation script to finish the installation process.
  
−  
−
== Running The Installation Script ==
  
−
=== With Sudo ===
  
−
This is the final step in the configuration process. If all goes well, your instance of LingoBot will be up and running once this step has been completed.
  
−  
−
* On the command-line shell where you have been modifying the LingoBot configuration file, save and close the file.
  
−
* if you have been operating as the "jenkins" user, change users so that you are on an account that has root privileges (unrestricted access to the sudo command).
 
−
** Typically this will be either the "centos" account or the "ec2-user" account, depending on your installation.
  
−
** If you are unable to access an account with root privileges, skip to the "Without Sudo" section below.
  
−
* Once this is done, simply execute the install.sh script. This script can be found in LingoBot's home directory under the "lingobot_installer" sub directory.
  
−  
−
Example:
  
−
/var/lib/jenkins/lingoport/lingobot-1.0/lingobot_installer/install.sh
  
−  
−
If everything has been configured correctly, then this script will take only a few seconds to run. Otherwise, the output of the script will tell you which aspects of the bot need to be reconfigured.
 
−
If something needs to be changed, simply modify the LingoBot config file and rerun the install script until it reports a successful installation.
  
−  
−
Once this is done, your instance of LingoBot will be up and running!
  
−  
−
=== Without Sudo ===
 
−
If you are unable to access an account that has root privileges, the LingoBot installation script can be run as the "jenkins" user by including the '--nosudo' ('-n') flag.
  
−  
−
Example:
  
−
/var/lib/jenkins/lingoport/lingobot-1.0/lingobot_installer/install.sh --nosudo
  
−  
−
NOTE: if the no-sudo flag is included, the installer will neither configure nor start the LingoBot service.
  
−
To start the service manually, you must have access to root privileges. The following commands can be run to manually start the LingoBot service.
  
−
 
−
sudo cp /var/lib/jenkins/lingobot-1.0/service_files/lingoport-lingobot.service /etc/systemd/system/lingoport-lingobot.service
  
−
sudo systemctl enable lingoport-lingobot.service
  
−
sudo systemctl start lingoport-lingobot.service
  
−  
−
Once this is done, your instance of LingoBot will be up and running!
  
−  
−
== Installation Verification ==
 
−
A quick way to verify that the LingoBot service has successfully launched and can be accessed by your team, go to your collaboration environment and try sending a message to LingoBot. To do this, you may have to invite LingoBot to the room you are currently in.
  
−  
−
Example:
  
−
@lingobot ping
  
−  
−
if LingoBot responds with "PONG", then you have successfully launched LingoBot. Have Fun!
  
−  
−
== Running LingoBot on the CLI ==
  
−
If you would like to run LingoBot directly from the CLI, all you have to do is run the `lingobot-cli.sh` script which can be found in LingoBot's bin folder. Once this is done, assuming everything has been configured correctly, you should enter into an interactive shell. There are two important things to keep in mind:
 
−
1.) All commands issued to LingoBot within the CLI must be prefaced with the bot's name, and
 
−
2.) Once the bot has finished responding, you must press enter before starting your next command.
  

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 "http://wiki.lingoport.com/index.php?title=LingoBot_Installation&oldid=98553"