Overview
The installer is in the form of a .pkg file, which is installed via the Cobalt Administration interface and handles all the work of installing Urchin 4. The basic tasks of the Urchin 4 installer for Sun Cobalt are:
- Create the /home/urchin4 distribution directory, unpack the files, and set appropriate ownership and file permissions
- Configure and launch a light Apache webserver to allow web based configuration and report delivery
- Launch the Urchin 4 task scheduler daemon, which manages log processing jobs
- Permit initial configuration and demo licensing of Urchin 4 via the administration interface
Installation Preparation
You must have root access to install Urchin 4 on a Sun Cobalt system. Although Urchin itself does not require any special system privileges to operate, and is specifically designed to run as a non-root user for security reasons, installation requires superuser access to some areas of your system.
You should download the appropriate package file for your system. This can be done one of 2 ways:
- Use a web browser from your desktop system to download from http://www.urchin.com/download/urchin4 and save the .pkg file on your local machine until you're ready to install
- Use ftp directly from your Cobalt system to ftp.urchin.com/pub/urchin4, and put the downloaded .pkg file into the /home/packages directory
Your Cobalt system will need access to the Internet, since it is necessary for you to connect to the urchin.com site to complete the demo licensing and activate your Urchin distribution once it is installed.
RaQ550 owners should read and understand the information on RaQ550 web.log permissions issues when installing Urchin.
Installation and Upgrade Instructions
A new installation of Urchin 4 for Sun Cobalt and an upgrade of an existing installation of Urchin 4 for Sun Cobalt use the same procedure. The package installers intelligently deal with each of these cases automatically.
Begin by connecting with your browser to the main Site Administrator's page for your Cobalt box, and navigate to the section of the Sun Cobalt administration interface used to install new third party software. The location of this area in the Cobalt interface will be platform specific:
- Raq 3 or RaQ 4 - click on Maintenance in the left hand frame, then click Install Software in the top row
- Qube 3 or RaQ 550 - click on the BlueLinQ tab, then click Third Party Software, then click the Install Manually button
- XTR - click on the BlueLinQ tab, then click New Software, then click the Install Manually button
In the new software area, prepare and launch the package installer using the directions appropriate for your platform:
- RaQ 3 or RaQ 4
- If you downloaded the Urchin package by using a browser and saving the .pkg file on your desktop system, then in the Software Package box select the Upload radio button, then click the Browse button to the right and navigate through your local filesystem until you locate the file. Once you click the Open button in the browse window, the pkg filename will be entered into the Upload text box.
- If you copied the software into your Cobalt system's /home/packages directory, then select the radio button labeled Loaded. Then choose your package installer from the drop down box to the right of this button.
- Click the "Install a pkg Package" button. When the installation is finished, in the lower section labeled Software on the Sun Cobalt Server, an Urchin 4 link will appear.
- Qube 3, XTR, or RaQ 550
- If you downloaded the Urchin package by using a browser and saving the .pkg file on your desktop system, then in the Location box select the Upload radio button, then click the Browse button to the right and navigate through your local filesystem until you locate the file. Once you click the Open button in the browse window, the pkg filename will be entered into the Upload text box.
- If you copied the software into your Cobalt system's /home/packages directory, then in the Location box, select the radio button labeled "Packages in /home/packages", and choose your package installer from the drop down box to the right of this button.
- Click the Prepare button. Once the package has been prepared, an Install Software window will appear. In this window click the Install button. When the installation is finished, Urchin 4 will be listed under the Programs tab.
Initial Configuration Using the Administration Interface
Click on the Urchin 4 link in your Cobalt administration interface and the Urchin admininstration login window will appear. Alternatively, you can connect directly to your Urchin 4 administration interface without going through the Cobalt administration interface by using the URL http://yourhost:9999, where yourhost is the DNS hostname for your Cobalt system. Enter the admin username and password to start configuring Urchin. Use these initial login values:
Username: admin
Password: urchin
Upon initial login, the interface will take you to a License Urchin wizard. You should click on "Obtain Demo License". The interface will connect to the licensing server at the Urchin Software Corporation website and walk you through the process. When finished with the license process, you will be returned to the Urchin 4 administration interface where you will be led through the Setup Wizard, which will set some required initial configuration parameters. Follow the instructions to complete your initial configuration. Please make sure to reset the password for the admin account and to record this password somewhere for safekeeping. When the Setup Wizard has completed you'll be taken to the Profile configuration screen. Click Add to create a new Profile. You will see a list of some sample Cobalt profiles and Log Sources that you can use as templates. Once you have a Profile you're ready to start processing logs and viewing Report data.
Managing Urchin 4 Services
There are 2 daemons, "urchind" and "urchinwebd", that need to be running in order for log processing, reporting, and configuration administration to occur. These daemons are automatically launched by the installation process and are configured for your system so that they should always restart if the system is rebooted. However, you may have need to control these processes manually. The daemons are stopped and started by the urchinctl program in the bin subdirectory of your Urchin distribution in /home/urchin4. To start or stop both daemons, use:
/home/urchin4/bin/urchinctl start
/home/urchin4/bin/urchinctl stop
You can also specify to only start or stop one daemon at a time by using a -w option for the webserver or a -s option for the scheduler. To see all of the available options, execute urchinctl with the -h option. Any errors encountered when one of the daemons is launched should be reported on the command line. For the urchinwebd daemon, once you think it is running successfully, you should also check the var/error_log file for any startup problems.
User Access To Reports
For users to see their individual reports, they should use the URL http://yourhost:9999, where yourhost should be replaced by the name of the system where Urchin is installed. If, during installation, you have chosen some other port number than the default of 9999 for the Urchin webserver to run on, then that number should be used instead.
Urchin Traffic Monitor
On Sun Cobalt systems, due to the combination of the default webserver logging format, the automated webserver log splitting mechanism, and the built-in statistics gathering software, it is currently not possible to utilize the Urchin 4 UTM.