You are looking at documentation for an older release. Not what you want? See the current release documentation.
The eXo Platform Tomcat bundle is a ready-made package on top of the Tomcat 7 application server.
So, you just need to download and extract the package (named eXo-Platform-4.4.x.zip
, for example) on your server.
In this guideline, $PLATFORM_TOMCAT_HOME
is the folder path of the extracted package.
Starting up the server
eXo Platform is started with a built-in startup script file, which is start_eXo.sh
for Linux and OS X (Mac),
and start_eXo.bat
for Windows. Double-click, or run it in console (Terminal or Command Prompt):
Linux/OS X: $PLATFORM_TOMCAT_HOME/start_eXo.sh
Windows: %PLATFORM_TOMCAT_HOME%\start_eXo.bat
The server is started successfully when you see a message like this:
INFO: Server startup in 120619 ms
To start eXo Platform as a background process, use the --background option:
Linux/OS X: $PLATFORM_TOMCAT_HOME/start_eXo.sh --background
Windows: %PLATFORM_TOMCAT_HOME%\start_eXo.bat --background
You can always check the log files under $PLATFORM_TOMCAT_HOME/logs
.
Shutting down the server
If you have started eXo Platform in console (without --background option), just press Ctrl+C to stop it.
In case it is running as background process, you can use the stop_eXo script:
Linux/OS X: $PLATFORM_TOMCAT_HOME/stop_eXo.sh
Windows: %PLATFORM_TOMCAT_HOME%\stop_eXo.bat
If you still see the process running, you may forcefully stop it. There are several ways: using Task Manager (Windows), or running stop_eXo.sh -force (Linux/OS X), or using kill -9 command (Linux/OS X).
Starting up eXo Platform in the Dev/Debug mode
In eXo Platform, the Debug mode is generally like other Java applications using JDWP, whereas the Dev mode is specific for debugging JavaScript, CSS and configurations.
To start eXo Platform in the Debug mode, use the --debug option:
Linux/OS X: $PLATFORM_TOMCAT_HOME/start_eXo.sh --debug
Windows: %PLATFORM_TOMCAT_HOME%\start_eXo.bat --debug
The --debug option actually adds a JVM option to the Java process:
-agentlib:jdwp=transport=dt_socket,address=8000,server=y,suspend=n
To start eXo Platform in the Dev mode, use the --dev option. This option adds two JVM options:
-Dorg.exoplatform.container.configuration.debug
-Dexo.product.developing=true
The Debug and Dev modes are turned off by default and are not recommended in production environment because of performance impact. See more details in Developer guide.
See also