ZBot Installation

What is a ZBot?

 

 

ZBots can be installed on Windows or UNIX (MacOS X, Solaris or Linux).

 

Installing ZBots on Windows

To install and use a ZBot on Windows, download the ZBot installation file from http://<your_zephyr_server>/zephyr/zbot

 

1. Clicking on the appropriate OS version for download, the following file is downloaded: zbot_win.exe

2. Run that file and accept any security warnings

3. The first welcome screen is displayed

 

 

4. Clicking on Next displays the License Agreement that must be accepted to proceed.

 

 

5. A destination location must be specified to where the ZBot will be installed.

 

 

6. Now the IP address and Port number on which the Zephyr Server is installed and listening on should be entered. This information is very important as this is how the ZBot connects with the Zephyr Server. If this is not known at this stage, the "Skip Zephyr server validation" checkbox can be selected and the IP/Port information can be entered later.

 

 

7. Now the Program Group and Shortcuts are selected.

 

 

8. Clicking on Next starts the file copy process.

 

 

9. Once the installation is completed, this final screen is displayed. A Program Group with the Start, Stop and Uninstaller is also created.

 

 

10. The final confirmation message showing the ZBot has started is displayed and the ZBot icon can be seen in the System Tray in the bottom right corner.

 

 

11. Right-clicking on the ZBot icon in the System Tray presents the following menu

 

 

The Edit Properties option allows the Zephyr Server IP and Port number to be changed.

Autostarting ZBots on Windows

The ZBot is already added as a Windows Service and can be stopped/started/restarted through the standard Windows Services application. It is also present in the System Tray and can be stopped/started/restarted from the right-click menu.

Installing ZBots on UNIX

ZBots can be installed on MacOSX, Solaris or Linux. Below is an example of an installation on Ubuntu Linux. The others are very similar. Also shown is how you can make ZBots autostart.

 

[Pre-requisites: You must have JRE 1.5 or higher for ZBot to run. In order to install java run sudo apt-get install sun-java5-jre ]

 

The ZBot can be downloaded from http://<your_zephyr_server>/zephyr/zbot

 

1. Clicking on the appropriate OS version for download, the following file is downloaded: zbot.unix.tar.gz

2. Open the archive with unzipping software (in this case Archive Manager on Ubuntu Linux)

 

 

3. Extract this folder to a convenient location where the ZBot will be installed. ZBot will be running from this folder.

 

 

4. In this case, /usr/local/zephyr has been chosen as seen below.

 

 

5. Open your favorite editor (gedit in this case), and open $ZBOT_EXTRACTION_FOLDER/zbot/lib/zbot.properties

 

 

6. Modify zephyrServerURL to point to your zephyr server (as highlighted) and save the property file.

 

 

7. Open a terminal window and navigate to $ZBOT_EXTRACTION_FOLDER/zbot and use the following to administer:

./bin/zbot.sh start - To Start the zbot in background

./bin/zbot.sh status - To Check the status of ZBot

./bin/zbot.sh stop - To Stop the zbot

./bin/zbot.sh console - To run zbot in interactive mode

 

 

8. Log files are in  $ZBOT_EXTRACTION_FOLDER/zbot/logs

 

Autostarting ZBots on UNIX

INSTALLATION
As root,
1. Create a symlink
	ln -s /usr/local/zephyr/zbot/bin/zbot.sh /etc/init.d/zbot
2. make sure symlink works
	cd /etc/init.d/
	./zbot console
3. run following command
	cd /etc/init.d
	update-rc.d zbot start 20 2 3 4 5 . stop 20 0 1 6 .
	
	OUTPUT
	Adding system startup for /etc/init.d/zbot ...  
	/etc/rc0.d/K20myapp -> ../init.d/myapp  
	/etc/rc1.d/K20myapp -> ../init.d/myapp  
	/etc/rc6.d/K20myapp -> ../init.d/myapp  
	/etc/rc2.d/S20myapp -> ../init.d/myapp  
	/etc/rc3.d/S20myapp -> ../init.d/myapp  
	/etc/rc4.d/S20myapp -> ../init.d/myapp  
	/etc/rc5.d/S20myapp -> ../init.d/myapp
4. reboot your machine to check if it works
	shutdown -r now

UNINSTALLATION 1. Remove the run levels update-rc.d -f zbot remove