Installing the Lingobot Service - Revision history

Rdaly: /* Installation Verification */

2024-03-19T22:06:34Z

Installation Verification

← Older revision		Revision as of 22:06, 19 March 2024
Line 61:		Line 61:

	Verify that you see the correct projects:		Verify that you see the correct projects:
	lingobot list projects		lingobot list projects

	List of all active projects:		List of all active projects:
	Name \| Type		Name \| Type
	-----------------------------------------------------\|---------------\|----------		-----------------------------------------------------\|---------------\|----------
	CET.IOS.testPush(testPush) \| Localyzer \| Parent		CET.IOS.testPush(testPush) \| Localyzer \| Parent
	CET.National.testing(testing) \| Globalyzer \| Parent		CET.National.testing(testing) \| Globalyzer \| Parent
	CET.Android.test8665(test8665) \| Globalyzer \| Parent		CET.Android.test8665(test8665) \| Globalyzer \| Parent
	CET.NOAAWeatherGithub.testing(testing) \| Localyzer \| Parent		CET.NOAAWeatherGithub.testing(testing) \| Localyzer \| Parent

Rdaly: /* Installation Verification */

2024-03-19T22:05:58Z

Installation Verification

← Older revision		Revision as of 22:05, 19 March 2024
Line 53:		Line 53:

	== Installation Verification ==		== 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.		A quick way to verify that the LingoBot service has successfully launched and can be accessed by your team, go to your collaboration environment (Slack, Flowdock, etc.) and try sending a message to LingoBot. To do this, you may have to invite LingoBot to the room you are currently in.

	Example:		Example:
Line 62:		Line 62:
	Verify that you see the correct projects:		Verify that you see the correct projects:
	lingobot list projects		lingobot list projects

			List of all active projects:
			Name \| Type
			-----------------------------------------------------\|---------------\|----------
			CET.IOS.testPush(testPush) \| Localyzer \| Parent
			CET.National.testing(testing) \| Globalyzer \| Parent
			CET.Android.test8665(test8665) \| Globalyzer \| Parent
			CET.NOAAWeatherGithub.testing(testing) \| Localyzer \| Parent

Rdaly: /* Set up install.conf */

2024-03-19T22:04:03Z

Set up install.conf

← Older revision		Revision as of 22:04, 19 March 2024
Line 34:		Line 34:
	* Make sure the <code>serverPort=8084</code> is not a port that is being used by anything else.		* Make sure the <code>serverPort=8084</code> is not a port that is being used by anything else.
	* Set the <code>docker_username=</code> and <code>docker_account_token=<token value></code> to the DockerHub login		* Set the <code>docker_username=</code> and <code>docker_account_token=<token value></code> to the DockerHub login
	* Set the <code>COMMAND_CENTER_URL</code> ~~is set the~~ the correct Command Center URL		* Set the <code>COMMAND_CENTER_URL</code> to the correct Command Center URL

	==Run install.sh==		==Run install.sh==

Rdaly: /* Set up install.conf */

2024-03-19T22:03:43Z

Set up install.conf

← Older revision		Revision as of 22:03, 19 March 2024
Line 33:		Line 33:
	* The <code>lingobot_image_version=</code> value should be provided		* The <code>lingobot_image_version=</code> value should be provided
	* Make sure the <code>serverPort=8084</code> is not a port that is being used by anything else.		* Make sure the <code>serverPort=8084</code> is not a port that is being used by anything else.
	* Set the <code>docker_username=</code> and <code>docker_account_token=<token value></code> ~~is set~~ to the DockerHub ~~values~~		* Set the <code>docker_username=</code> and <code>docker_account_token=<token value></code> to the DockerHub login
	* Set the <code>COMMAND_CENTER_URL</code> is set the the correct Command Center URL		* Set the <code>COMMAND_CENTER_URL</code> is set the the correct Command Center URL

Rdaly: /* Set up install.conf */

2024-03-19T22:03:10Z

Set up install.conf

← Older revision		Revision as of 22:03, 19 March 2024
Line 28:		Line 28:
	COMMAND_CENTER_TOKEN=		COMMAND_CENTER_TOKEN=
	docker_image=lingoport/lingobot_dev		docker_image=lingoport/lingobot_dev


			* Verify that the <code>/home/directory</code> is correct.
			* The <code>lingobot_image_version=</code> value should be provided
			* Make sure the <code>serverPort=8084</code> is not a port that is being used by anything else.
			* Set the <code>docker_username=</code> and <code>docker_account_token=<token value></code> is set to the DockerHub values
			* Set the <code>COMMAND_CENTER_URL</code> is set the the correct Command Center URL

	==Run install.sh==		==Run install.sh==

Lji: /* Set up install.conf */

2024-01-10T08:28:05Z

Set up install.conf

← Older revision		Revision as of 08:28, 10 January 2024
Line 25:		Line 25:
	APP_TOKEN=xapp-**********		APP_TOKEN=xapp-**********
	COMMAND_CENTER_URL=https://your_server/command-center		COMMAND_CENTER_URL=https://your_server/command-center
	~~COMMAND_CENTER_URSER~~=		COMMAND_CENTER_USER=
	COMMAND_CENTER_TOKEN=		COMMAND_CENTER_TOKEN=
	docker_image=lingoport/lingobot_dev		docker_image=lingoport/lingobot_dev

Lji: /* Set up install.conf */

2023-12-26T05:29:18Z

Set up install.conf

← Older revision		Revision as of 05:29, 26 December 2023
Line 29:		Line 29:
	docker_image=lingoport/lingobot_dev		docker_image=lingoport/lingobot_dev

			==Run install.sh==

			chmod +x *.sh
			sudo ./install.sh

			To check the running container status

			sudo docker ps

			If you need to re-run the install.sh, make sure to run uninstall.sh first to clean your environment.

			Note: Docker image version is not the Lingobot version, check latest docker image version at https://hub.docker.com/repository/docker/lingoport/lingobot/general

Lji at 05:27, 26 December 2023

2023-12-26T05:27:23Z

@@ Line 1: / Line 1: @@
-== Running The Installation Script ==
+===Set up install.conf ===
-* 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).
+ # Provide your home directory, lingobot folder will be created
-** 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.
+ home_directory=/home/centos
-* 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.
 Once this is done, your instance of LingoBot will be up and running!
@@ Line 36: / Line 37: @@
 Example:
-  @lingobot ping
+  lingobot hello
-if LingoBot responds with "PONG", then you have successfully launched LingoBot. Have Fun!
+if LingoBot responds with "hello", then you have successfully launched LingoBot. Have Fun!
 Verify that you see the correct projects:
-   @lingobot list projects
+   lingobot list projects

Rdaly: 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..."

2018-08-06T19:39:35Z

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..."

New page

== 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-<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!

== 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!

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)

← Older revision		Revision as of 22:06, 19 March 2024
Line 61:		Line 61:

	Verify that you see the correct projects:		Verify that you see the correct projects:
	lingobot list projects		lingobot list projects

	List of all active projects:		List of all active projects:
	Name \| Type		Name \| Type
	-----------------------------------------------------\|---------------\|----------		-----------------------------------------------------\|---------------\|----------
	CET.IOS.testPush(testPush) \| Localyzer \| Parent		CET.IOS.testPush(testPush) \| Localyzer \| Parent
	CET.National.testing(testing) \| Globalyzer \| Parent		CET.National.testing(testing) \| Globalyzer \| Parent
	CET.Android.test8665(test8665) \| Globalyzer \| Parent		CET.Android.test8665(test8665) \| Globalyzer \| Parent
	CET.NOAAWeatherGithub.testing(testing) \| Localyzer \| Parent		CET.NOAAWeatherGithub.testing(testing) \| Localyzer \| Parent