GaraxiChat Help

GaraxiChat 2.2 User's Guide

Home

3. Installation

3.1 System requirements

3.2 GaraxiChat files structures

3.3 GaraxiChat Server installation

3.3.1 Install on Windows

3.3.2 Install on Linux or FreeBSD

3.4 GaraxiChat Client installation

3.5 GaraxiChat registration

3.1 System requirements

Server requirements

- Dedicated or Shared server that enable you to run server application as daemon.

- Java friendly operating system such as Windows NT/2000/XP/2003, Linux, FreeBSD etc.

- JDK (Java Developer Kit) or JRE (Java Runtime Enviroment) version 1.2.2+ installed on server machine.

- If you using Unix any type server you need telnet or SSH account in order to operate installation.

- CPU speed 150 MHz or better with at least 64 Mb memory or better.

IIS

Apache

Client requirements

- Java enabled web browser such as IE 4.0+, Netscape 4.08+, Mozilla, Opera, HotJava or browser that installed embeded JRE.

your web browser for the best performance

3.2 GaraxiChat files structures

/server - Chat server you need only this part for running server.
/client - Sample client applets
- /client/docs - Documentation
README - REAME file
/JavaService.exe - This file use only on Windows in order to enable GaraxiChat to run as service.
/GService.exe - Utility application to start/stop Garaxi Chat service.

3.3 Server installation

3.3.1 Install on Windows

You need Windows NT/2000/XP/2003 in order to install GaraxiChat server.
We recommend all user with Garaxi Chat with JRE bundled version, because it easy to install.
If you didn't download the Garaxi Chat with JRE bundled version, you need JDK (Java Developer Kit) or JRE (Java Runtime Environment) installed on your machine.
Download free Java at http://www.javasoft.com But if you download the GaraxiChat bundled with JRE you don't need to worry about the version of Java anymore.
You must login as "Administrator" or full privileges account in order to install GaraxiChat server.
Run your installation file by double click on your single downloaded file.
Choose your installation type (Full installation mode recommend)
Choose your desire path
Begin install and done.
GaraxiChat will installed as service that automatically start when you Windows startup like figure below
You have 2 choices to start GaraxiChat server by
- Use Administrative Services tool
  Go to "Start" -> "Settings" -> "Control panel" -> "Administrative tools" -> "Services"
  Choose "GaraxiChat" service and right click to start or stop it.
- Start GaraxiChat as console application.
  Go to "Start" -> "Programs" -> "Garaxi Chat" -> "Server" -> "Start Garaxi Chat (console)"
  or
  "Start" -> "Programs" -> "Garaxi Chat" -> "Server" -> "Start Garaxi Chat as service"
  in case that you want to start chat as service (silience start)
To stop GaraxiChat of both 2 ways as mentioned above. You can use "Services" tool or terminate GaraxiChat console.
Server port by default GaraxiChat choose port 2428 for you. But if you are behide firewall restriction you can choose what you want. By change the port directive parameter in "[INSTALL_PATH]\server\properties.conf"
And restart your GaraxiChat server again.

3.3.2 Install on Linux or FreeBSD

Java required !!! but if you download the Garaxi Chat with JRE bundled you don't need to install Java.
You need JDK (Java Developer Kit) or JRE (Java Runtime Environment) 1.2.2+ installed on your machine.
Download free Java at http://www.javasoft.com But if you download the GaraxiChat bundled with JRE you don't need to worry about the version of Java anymore.
Properly Java installation will help you save your value time please consult your java documentation.
But if you don't know where to start with Java on Linux you can extract JDK or JRE in /usr/local
Setting JAVA_HOME environment to your java home such as "/usr/local/java" is helpful but not necessary.
Let's begin :-)
Extract the tar.gz file
from shell console (Suppose "$" is your shell prompt).
$ zcat -xvf garaxichat_2.xxx.tar.gz | tar xvf -
Invoke setup command by calling
$ ./setup.run
Following the installation step by just press "return" if you don't know anything.
All done.
Start GaraxiChat server by invoke

$ [INSTALL_PATH]/bin/garaxichat start

Suppose [INSTALL_PATH] is your installed directory "/usr/local/garaxichat" or

$ /usr/local/garaxichat/bin/garaxichat start
Stopping GaraxiChat server by invoke

$ [INSTALL_PATH]/bin/garaxichat stop

or

$ /usr/local/garaxichat/bin/garaxichat stop
Checking status by

$ [INSTALL_PATH]/bin/garaxichat status
Troubleshootings
- "permission denied" while start ./setup
  Because you has been modified file mode in some way. Fix it by invoke this command
  
  $ chmod a+x setup.run
- "No such file or Directory" while start ./setup.run
  In some Linux distribution it can't start ./setup.run why ?
  - Maybe you don't have /bin/sh (Bourne shell interpreter), so install Bourne shell.
  - Even there is /bin/sh but you still can't run ./setup.run (You see it at /bin/sh but still can't run it)
    Fix this by install "Bourne again shell" or "bash" (It's very popular shell) and try to find out where is the real path of "bash" shell.
    For example if you install "bash" at "/bin/bash" Edit "setup" file with "vi" editor (or whatever you like) and change the first line like below
    #!/bin/bash
    or if you install in "/usr/local/bin/bash"
    #!/bin/local/bin/bash
- HELP ME !!!!! it's complain like this
  
  "Could not bind port 8080.
  Maybe another service listening on that port.
  Please choose different port number: 2428 "
  
  "I've checked the port, it's free. And I try so many ports why it still tell me the port didn't free" !
  
  First check for the appropriated java installation by invoke command
  
  $java -version
  
  or
  
  $/PATH_TO_YOUR_INSTALLED_JAVA/bin/java -version
  
  It should show the information like this (Messages depend on your OS and java version)
  
  $ java -version java version "1.3.1_02" Java(TM) 2 Runtime Environment, Standard Edition (build 1.3.1_02-b02) Java HotSpot(TM) Client VM (build 1.3.1_02-b02, mixed mode)
  But if it show the error seems like the missing library(It reported Linux Redhat 9 and Fedora has this problem) . You need to get the new version of java from Sun (At least version 1.4.x)
  And download the GaraxiChat without JRE bundled and reinstall GaraxiChat again.
  Because Redhat 9 and Fedora has the problem with the old type libraries of Java. Redhat9 and Fedora using the new libraries that make it compatible with at least Java version 1.4 or later.

3.4 GaraxiChat Client installation

Demo chat !!
By copy directory "[INSTALL_PATH]/client" to your web server that can access by public (Example : http://your_domain.com/chat)
Or by point the directive or alias of your web to "[INSTALL_PATH]/client"
Suppose you copy "[INSTALL_PATH]/client" to your dynamic directory of your web server name "chat" You can run applet by call "http://your_server/chat" from your web browser
Customize your own chat applet code
You can customize your very own applet style e.g. colors,avatars,emoticons,font etc.
We suggest you should better go Client Configuration page.
After you copy directory [INSTALL_PATH]/client to your web server you can test to open the index.html of sample page. Done. No need to configure your applet to point to the server.
You can try every sample applets. It's simple on client configuration.
Try to open the "Example 4" chat page (It's contain user authentication).
By default for newly install default username & password for Administrator is

username : Admin
password : Admin

You must change it if you plan to use GaraxiChat in real life.
Try to type nickname and password above for connect as "Admin".
If you can login and see the sample 4 rooms in chat applet ... Congratulation !
Troubleshootings
If you can't connect to the chat server and the error dislay "Can't connect to chat server"
- Please check for sure you supply the connection port directive at client side (applet) correctly.
- If you've changed the server port at server side different from 2428. Make sure you edit the connection port directive at the client side (applet) same as server side.
- For more information about connection port at server side look here.
- For more information about connection port at client side look here.
Please make sure you start the Garaxi Chat server and make sure the server side is running.
Please be sure your server firewall (If you have) accept GaraxiChat port.
Your client firewall (If you have) must accept this port too.

3.5 GaraxiChat registration

After you decide to purchase GaraxiChat and receive Registration code. Now it's time to register.
Registration can process on only one way "register by client applet"
Applet will connect to server and register and save setting on your GaraxiChat server.
By open chat applet and connect as "Admin" (Garaxi chat will handle chat super use only "Admin")
Go to tab "Rooms list" and press button "Server config" at the bottom of chat applet.
When dialog comes up choose tab "Server license"
Type your "Register name" and copy and paste your "License key"
Press button "Register"
Done.

Home