|Table of Contents|
4.3 Installing on Mac OS X
Please read the VolanoChat server software requirements in the [3.1] Requirements section before installing VolanoChat on your system. The installation instructions below assume you are using one of the recommended Java platforms for Mac OS X listed in Table 1.
This section consists of the following five parts:
- Installing VolanoChat
- Starting the server
- Starting the applets
- Purchasing a license
- Removing VolanoChat
Download the Java class file installation program from the VolanoChat Download page and run the installation program using the java command from the Terminal application. For example, if you download the file
vchat2_6_1.class, you would run the installation program as a graphical desktop application by changing to the directory where you saved the file and running the following command:
If you are using a character-based Telnet or SSH session to login to a remote system with no graphical desktop, you can perform the installation directly from the command prompt with the -o option:
java vchat2_6_1 -o path
where path is the directory where you want the VolanoChat software installed.
We recommend that you install each VolanoChat version into its own directory under the home directory of a new user account on your system, such as volano. For example, if you're installing VolanoChat version 2.6.1, you would create a new user account called volano, login to that account, and install VolanoChat into the following location:
with the command:
java vchat2_6_1 -o ~/vchat2.6.1
If you're unable to create a new account, you can simply install into a location under your own home directory. The examples that follow use the installation directory
/Users/volano/vchat2.6.1, but your location may be different if you installed into a different directory or under a different account name.
Download a trial license key from the VolanoChatPro Trial Licenses page and save the generated file as a plain text file. The easiest way to save the trial key is to select Save As... or Save Page As... from the Web browser File menu. Put the
key.txt file in the
conf subdirectory of your VolanoChat installation. For example, if you installed VolanoChat in the location
/Users/volano/vchat2.6.1, you would put the trial license key in:
Write to Volano Support <email@example.com> if you are moving or upgrading servers and need to exchange your purchased non-trial license for a new one with a different address.
Starting the server
You can start the VolanoChat server from the command prompt or automatically as a service when your system starts.
From the Command Prompt
VolanoChat includes a sample startup shell script called
startup.sh. To start the VolanoChat server, change to the VolanoChat installation directory, make the shell script executable, and run the script. For example, if you installed into the directory
/Users/volano/vchat2.6.1, you would enter:
cd /Users/volano/vchat2.6.1 chmod a+x startup.sh ./startup.sh
You should then see messages like the following:
java version "1.4.2_03" Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.2_03-117.1) Java HotSpot(TM) Client VM (build 1.4.2-34, mixed mode) VolanoChat(TM) Server Version 2.6.1 Copyright (c) 1996-2004 Volano Software. All rights reserved. Loading server properties from "/Users/volano/vchat2.6.1/conf/properties.txt". ibook.sf.volano.com:8000 (192.168.2.4:8000) VolanoChatPro - 5 connection limit. This evaluation copy expires on Tue Mar 02 00:00:00 PST 2004. Apache Tomcat/4.1.29
To stop the VolanoChat server, enter the Ctrl-C keyboard shortcut in the terminal window where you started it. If you started the server as a background process, you can find it with the ps command and then stop it with the kill command.
"ulimit -n 1024", allowing for about 1,000 concurrent chat connections:
Darwin) # Apple Mac OS X ulimit -n 1024 for file in lib/*.jar; do classpath="$classpath:$file"; done java=/Library/Java/Home/bin/java options="-server -Xmx256m -Xss128k" ;;
As a Service
You may want to create your own startup script to start the VolanoChat server in the background and save any output to a log file, as in the following sample script:
#!/bin/sh cd $HOME/vchat2.6.1 ./startup.sh -r >> server.log 2>&1 &
If you put the script in
$HOME/bin/startchat.sh and make it exectuable, you can then use the @reboot feature of crontab(5) to have the script invoked when you start your Mac OS X system. Use the
"crontab -e" command to create a cron table containing:
After rebooting, you can find the process identifiers (PIDs) of the startup script and the VolanoChat server Java process with the -U option of the ps command, such as the following example with the account name volano:
ps -U volano
The output of the command will look something like this:
PID TT STAT TIME COMMAND 190 ?? S 0:00.03 sh ./startup.sh -r 341 ?? S 0:11.51 /Library/Java/Home/bin/java -server -Xmx256m -Xss128k
With the process identifier, you can use the kill command to stop both the VolanoChat server and the startup script which launches and restarts it. If you simply want to restart the VolanoChat server, you can kill it and let the startup script (with its -r option) restart it in 15 seconds. Using the PID value in the example shown above, you would enter:
to kill the VolanoChat server and let the startup script restart it.
Starting the applets
If you're using a Web browser on the same machine that is running the VolanoChat server, you can load the applet from the following link:
If the server is on some other machine, change
localhost in the address shown above to the actual host name of the machine running the VolanoChat server. After your browser loads the page, push the button to connect to your VolanoChat server using the VolanoChat applet.
Although the applets and their resources can be delivered through the built-in Apache Tomcat servlet container as shown above, you should use a Web server like the Apache HTTP Server for delivering the VolanoChat applets and files on a production system. These files must be publicly available through your Web server so that the applet can be loaded onto Web pages. Do not move or copy the
vcclient subdirectory, but rather set up an Apache Alias or even just a symbolic link (using the
"ln -s" command) for the applet class files and resources.
For example, to publish your
vcclient directory using Apache, you would add an Alias directive like the following to the Aliases section of your Apache configuration file (
Alias /vcclient/ /Users/volano/vchat2.6.1/webapps/ROOT/vcclient/
With that change, you can drop the 8080 port number from the address and pull the applet through your normal Web server:
Purchasing a license
You can purchase a license key from Volano through our online store to increase the trial license connection limit and remove its expiration date. You will need the
support.log file that is generated by the VolanoChat server each time you start it, found under the
logs subdirectory. We'll use the
server.host IP address and
server.port port number to generate the new license. The contents of the support log file look like the following:
server.version = Version 2.6.1 server.properties = /Users/volano/vchat2.6.1/conf/properties.txt server.license = VolanoChatPro - 5 connection limit server.expiration = Tue Mar 02 00:00:00 PST 2004 server.host = ibook.sf.volano.com (192.168.2.4) server.port = 8000 java.vendor = Apple Computer, Inc. java.vendor.url = http://apple.com/ java.version = 1.4.2_03 java.class.version = 48.0 java.compiler = os.name = Mac OS X os.version = 10.3.2 os.arch = ppc user.language = en user.region = file.encoding = MacRoman file.encoding.pkg = sun.io
To remove VolanoChat using the graphical desktop application, change to the VolanoChat installation directory and enter the following command:
If you are using a character-based Telnet or SSH session to login to a remote system with no graphical desktop, you can remove VolanoChat directly from the command prompt with the -console option:
java uninstall -console
The uninstall program will remove all files except for those you have modified or created after installation, such as the modified configuration files or new log files. Simply delete these files if you don't want to keep them.
|XHTML 1.0||Table of Contents|