Difference between revisions of "Installing the Lingobot Service"
(Created page with "== 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...") |
|||
| Line 1: | Line 1: | ||
| + | ===Set up install.conf === |
||
| − | == 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. |
||
| + | # Provide your home directory, lingobot folder will be created |
||
| − | * 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. |
||
| + | home_directory=/home/centos |
||
| − | ** 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. |
||
| + | # Provide the Lingobot version |
||
| + | # |
||
| + | lingobot_image_version= |
||
| + | # |
||
| + | # Provide the Lingobot port |
||
| + | # |
||
| + | serverPort=8084 |
||
| + | # |
||
| + | # Provide your Docker Hub username |
||
| + | # |
||
| + | docker_username=lingoportcustomer |
||
| + | # |
||
| + | # Provide your Docker Hub account token |
||
| + | # |
||
| + | docker_account_token=dckr_pat_cUuqyjSfv3JQRG0R5_cwmWsHceg |
||
| + | # Slack security config |
||
| + | BOT_TOKEN=xoxb-********** |
||
| + | APP_TOKEN=xapp-********** |
||
| + | COMMAND_CENTER_URL=https://your_server/command-center |
||
| + | COMMAND_CENTER_URSER= |
||
| + | COMMAND_CENTER_TOKEN= |
||
| + | docker_image=lingoport/lingobot_dev |
||
| − | Example: |
||
| − | /var/lib/jenkins/lingoport/lingobot-<x.y>/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-<x.y>/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! |
Once this is done, your instance of LingoBot will be up and running! |
||
| Line 36: | Line 37: | ||
Example: |
Example: |
||
| − | + | lingobot hello |
|
| − | if LingoBot responds with " |
+ | if LingoBot responds with "hello", then you have successfully launched LingoBot. Have Fun! |
Verify that you see the correct projects: |
Verify that you see the correct projects: |
||
| − | + | lingobot list projects |
|
| − | |||
| − | Check that the dashboard comes up. Select the link and make sure it shows the correct dashboard. |
||
| − | @lingobot show dashboard |
||
| − | |||
| − | == Troubleshooting == |
||
| − | === I ran the install.sh script. I found that I had set some of the variables incorrectly. So, what now? === |
||
| − | If the variables need to be modified: |
||
| − | * Stop the LingoBot service (for example <code>sudo systemctl stop lingoport-lingobot.service</code>, see above) |
||
| − | * edit the <code>lingobot_config.sh</code> configuration file |
||
| − | * Run the <code>install.sh</code> script (See above) |
||
| − | * Make sure the LingoBot service has started (for example <code>sudo systemctl status lingoport-lingobot.service</code>, see above) |
||
Revision as of 05:27, 26 December 2023
Set up 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=8084 # # Provide your Docker Hub username # docker_username=lingoportcustomer # # Provide your Docker Hub account token # docker_account_token=dckr_pat_cUuqyjSfv3JQRG0R5_cwmWsHceg # Slack security config BOT_TOKEN=xoxb-********** APP_TOKEN=xapp-********** COMMAND_CENTER_URL=https://your_server/command-center COMMAND_CENTER_URSER= COMMAND_CENTER_TOKEN= docker_image=lingoport/lingobot_dev
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 hello
if LingoBot responds with "hello", then you have successfully launched LingoBot. Have Fun!
Verify that you see the correct projects:
lingobot list projects
