CS Install Guide

CS Install Guide

This install guide will help you to get up and running with eXo CS on your computer in 5 minutes. It is pretty straightforward :

Requirements

  • OS : Windows, Linux or MAC OS X.
  • Memory : 1GB of RAM and at least one 1.5 Ghz processor.
  • Disk : 150MB of disk space is necessary for the install
  • Browser : Firefox 3 or Internet Explorer 7
This guide let you run a pre-built bundle for demonstration and evaluation purposes only. If you need to go further, have a look at these docs :

1 Download

Download the last binary bundle of CS. All released versions are available for download on OW2 Forge.

It is a 70MB download, make sure you have enough free disk space on your hard drive.

2 Extract

Unzip tomcat version to hard drive to a directory. We will call that directory $EXTRACT_FOLDER until the end of the article You will need at least 150MB free disk space to extract the file.

CS comes with a builtin file-based database (HSQL). Which means any data created with CS apps will take some more space on the disk. Make sure you have enough disk space for your emails, calendar and contacts information that you will create during your evaluation.

3 Launch

3.1 Launch cs on tomcat server

Prerequisites :

  • eXo CS 1 requires a Java 5 environment, make sure the JAVA_HOME environment variable point to a JRE 5 folder
  • eXo CS 2 requires a Java 6 environment, make sure the JAVA_HOME environment variable point to a JRE 6 folder
  • the exo server will run on portal 8080, make sure this port is not currently in use
  • the chat server will require additional ports 5222 and 7777. Make sure these ports are not currently in use
Launch instructions :

  • Using command line, go to $EXTRACT_FOLDER/bin and start the server :
    • Windows :
      eXo.bat run
    • Linux / Mac OS :
      chmod+x *.sh ; eXo.sh run
  • Wait for the server to start. You should see something like this on the console :
INFO: Server startup in 15359 ms

3.2 Launch the chat server (since 1.3 the chat application integrated to cs)

Since CS 1.3, a Chat application is available. Currently it requires to start a second server.

Chat server launch instructions :

  • Using command line, go to exo-openfire/bin and start the server :
    • Window :
      openfired.exe
    • Unix/Linux/Mac OS :
      ./openfire start

3.3 Launch the chat server for cs 2.0

since 2.0 we support multiple portal so chat server have extra params when start
Chat server 2.0 launch instructions :

  • When you are using our exo-chatserver provide in package, you can use this run script
    • Window for portal :
      run.bat
      For csdemo :
      run_demo.bat
    • Unix/Linux/Mac OS for protal :
      ./run.sh
      for csdemo
      ./run_demo.sh
    • Incase you have no run. file on chatserver/bin, you can go to chatserver/lib folder and run following hight light introduction below
  • java -DeXo.env.restContextName=rest -jar startup.jar . for cs classic
  • java -DeXo.env.restContextName=rest-csdemo -jar startup.jar . for cs-demo
  • We have this one in chat-server/conf/openfire.xml
<env> 
      <serverBaseURL>http://localhost:8080/</serverBaseURL>  
      
      <restContextName>rest</restContextName> 
    </env>
NameValueDescription
restContextNamerestthis used to specify Openfire server is dedicated for portal classic.
restContextNamerest-csdemothis used to specify Openfire server is dedicated for cs demo.

If "eXo.env.restContextName" system property exists, it will override this value. "eXo.env.restContextName" system property can be set by specifying the -D option to the java command when running Openfire. Example: If Openfire server is dedicated for "portal" portal the command will have following format :

  • java -DeXo.env.restContextName=rest -jar ../lib/startup.jar .
If Openfire server is dedicated for "csdemo" portal, the command will have following format:
  • java -DeXo.env.restContextName=rest-csdemo -jar ../lib/startup.jar .
By default, Openfire server is dedicated to "portal" portal.

- Congratulations, you have successfully installed eXo Collaboration Suite!

Tags:
Created by Patrice Lamarque on 03/10/2009
Last modified by pham tuan on 08/20/2010

Products

generated on Thu Sep 02 23:42:44 UTC 2010

eXo Optional Modules

eXo Core Foundations


Copyright (c) 2000-2010. All Rights Reserved - eXo platform SAS
2.4.30451