Bitnami eXo Platform Installer

NOTE: Before running the commands shown on this page, you should load the Bitnami stack environment by executing the installdir/use_APPNAME script (Linux and Mac OS X) or by clicking the shortcut in the Start Menu under "Start -> Bitnami APPNAME Stack -> Application console" (Windows). Learn more.
NOTE: When running the commands shown on this page, replace the installdir placeholder with the full installation directory for your Bitnami stack.

Description

eXo Platform is an open source social-collaboration software designed for enterprises. It is full featured, based on standards, extensible and has an amazing design.

First steps with the Bitnami Stack for eXo Platform

Welcome to your new Bitnami application! Here are a few questions (and answers!) you might need when first starting with your application.

What are the system requirements?

Before you download and install your application, check that your system meets these requirements.

How do I install the Bitnami Stack for eXo Platform?

Windows, OS X and Linux installer
  • Download the executable file for the Bitnami Stack for eXo Platform from the Bitnami website.

  • Run the downloaded file:

    • On Linux, give the installer executable permissions and run the installation file in the console.
    • On other platforms, double-click the installer and follow the instructions shown.

Check the FAQ instructions on how to download and install a Bitnami Stack for more details.

The application will be installed to the following default directories:

Operating System Directory
Windows C:\Bitnami\APPNAME-VERSION
Mac OS X /Applications/APPNAME-VERSION
Linux /opt/APPNAME-VERSION (running as root user)
OS X VM
  • Download the OS X VM file for the Bitnami Stack for eXo Platform from the Bitnami website.
  • Begin the installation process by double-clicking the image file and dragging the WordPress OS X VM icon to the Applications folder.
  • Launch the VM by double-clicking the icon in the Applications folder.

What credentials do I need?

You need application credentials, consisting of a username and password. These credentials allow you to log in to your new Bitnami application.

What is the administrator username set for me to log in to the application for the first time?

  • For Windows, Linux and OS X installers, the username was configured by you when you first installed the application.
  • For OS X VMs, the username can be obtained by clicking the Bitnami badge at the bottom right corner of the application welcome page.

What is the administrator password?

  • For Windows, Linux and OS X installers, the password was configured by you when you first installed the application.
  • For OS X VMs, the password can be obtained by clicking the Bitnami badge at the bottom right corner of the application welcome page.

How to start or stop the services?

Linux

Bitnami native installers include a graphical tool to manage services. This tool is named manager-linux-x64.run on Linux and is located in the installation directory. To use this tool, double-click the file and then use the graphical interface to start, stop or restart services. Server log messages can be checked in the "Server Events" tab.

Management tool

The native installer also includes a command-line script to start, stop and restart applications, named ctlscript.sh. This script can be found in the installation directory and accepts the options start, stop, restart, and status. To use it, log in to the server console and execute it following the examples below:

  • Call it without any service names to start all services:

      $ sudo installdir/ctlscript.sh start
    
  • Use it to restart a specific service only by passing the service name as argument - for example, mysql, postgresql or apache:

      $ sudo installdir/ctlscript.sh restart mysql
      $ sudo installdir/ctlscript.sh restart postgresql
      $ sudo installdir/ctlscript.sh restart apache
    
  • Obtain current status of all services:

      $ installdir/ctlscript.sh status
    

The list of available services varies depending on the required components for each application.

Mac OS X

Bitnami native installers include a graphical tool to manage services. This tool is named manager-osx on Mac OS X and is located in the installation directory. To use this tool, double-click the file and then use the graphical interface to start, stop or restart services. Server log messages can be checked in the "Server Events" tab.

Management tool

The native installer also includes a command-line script to start, stop and restart applications, named ctlscript.sh. This script can be found in the installation directory and accepts the options start, stop, restart, and status. To use it, log in to the server console and execute it following the examples below:

  • Call it without any service names to start all services:

    $ sudo installdir/ctlscript.sh start
    
  • Use it to restart a specific service only by passing the service name as argument - for example, mysql or apache:

     $ sudo installdir/ctlscript.sh restart mysql
     $ sudo installdir/ctlscript.sh restart apache
    
  • Obtain current status of all services:

     $ installdir/ctlscript.sh status
    

The list of available services varies depending on the required components for each application.

NOTE: If you are using the stack manager for Mac OS X-VM, please check the following blog post to learn how to manage services from its graphical tool.

Windows

Bitnami native installers include a graphical tool to manage services. This tool is named manager-windows.exe on Windows and is located in the installation directory. To use this tool, double-click the file and then use the graphical interface to start, stop or restart services. Server log messages can be checked in the "Server Events" tab.

Management tool

The Windows native installer creates shortcuts to start and stop services created in the Start Menu, under "Programs -> Bitnami APPNAME Stack -> Bitnami Service". Servers can also be managed from the Windows "Services" control panel. Services are named using the format APPNAMESERVICENAME, where APPNAME is a placeholder for the application name and SERVICENAME is a placeholder for the service name. For example, the native installer for the Bitnami WordPress Stack installs services named wordpressApache and wordpressMySQL.

These services will be automatically started during boot. To modify this behaviour, refer to the section on disabling services on Windows.

How to configure outbound email settings?

For eXo Platform 4.1 or newer

To send email using eXo Platform via SMTP, it is necessary to specify the SMTP settings in the installdir/apps/exoplatform/gatein/conf/exo.properties file.

Here is an example of the configuration parameters using a Gmail SMTP server. Replace USERNAME and PASSWORD with your Gmail account username and password respectively.

exo.email.smtp.from=USERNAME@gmail.com
exo.email.smtp.host=smtp.gmail.com
exo.email.smtp.port=465
exo.email.smtp.starttls.enable=true
exo.email.smtp.auth=true
exo.email.smtp.username=USERNAME@gmail.com
exo.email.smtp.password=PASSWORD
exo.email.smtp.socketFactory.port=465
exo.email.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory

Find more information in this guide.

For eXo Platform 4.1.0 or older

To send email using eXo Platform via SMTP, it is necessary to specify the SMTP settings in the installdir/apps/exoplatform/scripts/setenv-customize.sh file.

Here is an example of the configuration parameters using a Gmail SMTP server. Replace USERNAME and PASSWORD with your Gmail account username and password respectively.

EXO_EMAIL_FROM="USERNAME@gmail.com"
EXO_EMAIL_SMTP_HOST="smtp.gmail.com"
EXO_EMAIL_SMTP_PORT="465"
EXO_EMAIL_SMTP_STARTTLS_ENABLE=true
EXO_EMAIL_SMTP_AUTH=true
EXO_EMAIL_SMTP_USERNAME="USERNAME@gmail.com"
EXO_EMAIL_SMTP_PASSWORD="PASSWORD"

Note that for UNIX-based or Mac OS X-based servers or native installers, you will need to also uncomment each line by deleting the hash (#) symbol at the start of each line, whereas for Windows native installers, you will need to uncomment each line by deleting the the REM string at the start of each line.

After saving the changes to the file, restart the Tomcat server:

$ sudo installdir/ctlscript.sh restart tomcat

To configure the application to use other third-party SMTP services for outgoing email, such as SendGrid or Mandrill, refer to the FAQ.

NOTE: If you are using Gmail as the outbound email server and have experienced issues trying to send emails correctly, check the How to troubleshoot Gmail SMTP issues to learn the causes of these issues and how to solve them.

How to create a full backup of eXo Platform?

The Bitnami Stack for eXo Platform is self-contained and the simplest option for performing a backup is to copy or compress the Bitnami stack installation directory. To do so in a safe manner, you will need to stop all servers, so this method may not be appropriate if you have people accessing the application continuously.

NOTE: If you want to create only a database backup, refer to these instructions for MySQL and PostgreSQL.

Backup on Linux and Mac OS X

Follow these steps:

  • Change to the directory in which you wish to save your backup.

     $ cd /your/directory
    
  • Stop all servers.

     $ sudo installdir/ctlscript.sh stop
    
  • Create a compressed file with the stack contents.

     $ sudo tar -pczvf application-backup.tar.gz installdir
    
  • Start all servers.

     $ sudo installdir/ctlscript.sh start
    
  • Download or transfer the application-backup.tar.gz file to a safe location.

You should now download or transfer the application-backup.tar.gz file to a safe location.

Backup on Windows

Follow these steps:

  • Stop all servers using the shortcuts in the Start Menu or the graphical manager tool.

  • Create a compressed file with the stack contents. You can use a graphical tool like 7-Zip or WinZip or just right-click the folder, click "Send to", and select the "Compressed (zipped) folder" option.

  • Download or transfer the compressed file to a safe location.

  • Start all servers using the shortcuts in the Start Menu or the graphical manager tool.

Restore on Linux and Mac OS X

Follow these steps:

  • Change to the directory containing your backup:

    $ cd /your/directory
    
  • Stop all servers.

    $ sudo installdir/ctlscript.sh stop
    
  • Move the current stack to a different location:

    $ sudo mv installdir /tmp/bitnami-backup
    
  • Uncompress the backup file to the original directory:

    $ sudo tar -pxzvf application-backup.tar.gz -C /
    
  • Start all servers.

    $ sudo installdir/ctlscript.sh start
    
IMPORTANT: When restoring, remember to maintain the original permissions for the files and folders. For example, if you originally installed the stack as the root user on Linux, make sure that the restored files are owned by root as well.

Restore on Windows

  • Change to the directory containing your backup:

       $ cd /your/directory
    
  • Stop all servers using the shortcuts in the Start Menu or the graphical manager tool.

  • Uninstall the previous services by executing the following command:

        $ serviceinstall.bat
    
  • Create a safe folder named Backups in the desktop and move the current stack to it. Remember to replace PATH with the right location of your folder:

        $ move installdir \PATH\Backups
    
  • Uncompress the backup file using a tool like 7-Zip or Winzip or just double-click the .zip file to uncompress it, and move it to the original directory.
  • Install services by running the following commands from an elevated command prompt:

      $ cd installdir
      $ serviceinstall.bat INSTALL
    
  • Start all servers using the shortcuts in the Start Menu or the graphical manager tool.

How to create an SSL certificate for Apache Tomcat?

A detailed guide is available in the official Apache Tomcat documentation at http://tomcat.apache.org/tomcat-6.0-doc/ssl-howto.html.

How to enable SSL access over HTTPS?

You can configure Apache Tomcat to enable SSL access to applications using HTTPS. It is necessary to configure Tomcat with the location of the Apache SSL certificate, as described below.

  • Check that the certificate file is present at installdir/apache-tomcat/conf/ssl/tomcat.cert.pem and the certificate key file is present at installdir/apache-tomcat/conf/ssl/tomcat.key.pem.

  • Uncomment the following line in the installdir/apache-tomcat/conf/server.xml file:

       <Connector port="8443"
                  protocol="HTTP/1.1" SSLEnabled="true"
                  maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
                  enableLookups="false" disableUploadTimeout="true"
                  acceptCount="100" scheme="https" secure="true"
                  clientAuth="false" sslProtocol="TLS"
                  keystoreFile="conf/myKeystore"
                  keystorePass="your_password"
                  SSLCertificateFile="installdir/apache-tomcat/conf/ssl/tomcat.cert.pem"
                  SSLCertificateKeyFile="installdir/apache-tomcat/conf/ssl/tomcat.key.pem"/>
    
  • Restart the Apache Tomcat server

You should now be able to access your Web applications over HTTPS by browsing to https://localhost:8443.

How to create an SSL certificate?

OpenSSL is required to create an SSL certificate. A certificate request can then be sent to a certificate authority (CA) to get it signed into a certificate, or if you have your own certificate authority, you may sign it yourself, or you can use a self-signed certificate (because you just want a test certificate or because you are setting up your own CA).

Follow the steps below for your platform.

Linux and Mac OS X

NOTE: OpenSSL will typically already be installed on Linux and Mac OS X. If not installed, install it manually using your operating system's package manager.

Follow the steps below:

  • Generate a new private key:

     $ sudo openssl genrsa -out installdir/apache2/conf/server.key 2048
    
  • Create a certificate:

     $ sudo openssl req -new -key installdir/apache2/conf/server.key -out installdir/apache2/conf/cert.csr
    
    IMPORTANT: Enter the server domain name when the above command asks for the "Common Name".
  • Send cert.csr to the certificate authority. When the certificate authority completes their checks (and probably received payment from you), they will hand over your new certificate to you.

  • Until the certificate is received, create a temporary self-signed certificate:

     $ sudo openssl x509 -in installdir/apache2/conf/cert.csr -out installdir/apache2/conf/server.crt -req -signkey installdir/apache2/conf/server.key -days 365
    
  • Back up your private key in a safe location after generating a password-protected version as follows:

     $ sudo openssl rsa -des3 -in installdir/apache2/conf/server.key -out privkey.pem
    

    Note that if you use this encrypted key in the Apache configuration file, it will be necessary to enter the password manually every time Apache starts. Regenerate the key without password protection from this file as follows:

     $ sudo openssl rsa -in privkey.pem -out installdir/apache2/conf/server.key
    

Windows

NOTE: OpenSSL is not typically installed on Windows. Before following the steps below, download and install a binary distribution of OpenSSL.

Follow the steps below once OpenSSL is installed:

  • Set the OPENSSL_CONF environment variable to the location of your OpenSSL configuration file. Typically, this file is located in the bin/ subdirectory of your OpenSSL installation directory. Replace the OPENSSL-DIRECTORY placeholder in the command below with the correct location.

     $ set OPENSSL_CONF=C:\OPENSSL-DIRECTORY\bin\openssl.cfg
    
  • Change to the bin/ sub-directory of the OpenSSL installation directory. Replace the OPENSSL-DIRECTORY placeholder in the command below with the correct location.

     $ cd C:\OPENSSL-DIRECTORY\bin
    
  • Generate a new private key:

     $ openssl genrsa -out installdir/apache2/conf/server.key 2048
    
  • Create a certificate:

     $ openssl req -new -key installdir/apache2/conf/server.key -out installdir/apache2/conf/cert.csr
    
    IMPORTANT: Enter the server domain name when the above command asks for the "Common Name".
  • Send cert.csr to the certificate authority. When the certificate authority completes their checks (and probably received payment from you), they will hand over your new certificate to you.

  • Until the certificate is received, create a temporary self-signed certificate:

     $ openssl x509 -in installdir/apache2/conf/cert.csr -out installdir/apache2/conf/server.crt -req -signkey installdir/apache2/conf/server.key -days 365
    
  • Back up your private key in a safe location after generating a password-protected version as follows:

     $ openssl rsa -des3 -in installdir/apache2/conf/server.key -out privkey.pem
    

    Note that if you use this encrypted key in the Apache configuration file, it will be necessary to enter the password manually every time Apache starts. Regenerate the key without password protection from this file as follows:

     $ openssl rsa -in privkey.pem -out installdir/apache2/conf/server.key
    

Find more information about certificates at http://www.openssl.org.

How to enable HTTPS support with SSL certificates?

TIP: If you wish to use a Let's Encrypt certificate, you will find specific instructions for enabling HTTPS support with Let's Encrypt SSL certificates in our Let's Encrypt guide.
NOTE: The steps below assume that you are using a custom domain name and that you have already configured the custom domain name to point to your cloud server.

Bitnami images come with SSL support already pre-configured and with a dummy certificate in place. Although this dummy certificate is fine for testing and development purposes, you will usually want to use a valid SSL certificate for production use. You can either generate this on your own (explained here) or you can purchase one from a commercial certificate authority.

Once you obtain the certificate and certificate key files, you will need to update your server to use them. Follow these steps to activate SSL support:

  • Use the table below to identify the correct locations for your certificate and configuration files.

    Variable Value
    Current application URL https://[custom-domain]/
      Example: https://my-domain.com/ or https://my-domain.com/appname
    Apache configuration file installdir/apache2/conf/bitnami/bitnami.conf
    Certificate file installdir/apache2/conf/server.crt
    Certificate key file installdir/apache2/conf/server.key
    CA certificate bundle file (if present) installdir/apache2/conf/server-ca.crt
  • Copy your SSL certificate and certificate key file to the specified locations.

    NOTE: If you use different names for your certificate and key files, you should reconfigure the SSLCertificateFile and SSLCertificateKeyFile directives in the corresponding Apache configuration file to reflect the correct file names.
  • If your certificate authority has also provided you with a PEM-encoded Certificate Authority (CA) bundle, you must copy it to the correct location in the previous table. Then, modify the Apache configuration file to include the following line below the SSLCertificateKeyFile directive. Choose the correct directive based on your scenario and Apache version:

    Variable Value
    Apache configuration file installdir/apache2/conf/bitnami/bitnami.conf
    Directive to include (Apache v2.4.8+) SSLCACertificateFile "installdir/apache2/conf/server-ca.crt"
    Directive to include (Apache < v2.4.8) SSLCertificateChainFile "installdir/apache2/conf/server-ca.crt"
    NOTE: If you use a different name for your CA certificate bundle, you should reconfigure the SSLCertificateChainFile or SSLCACertificateFile directives in the corresponding Apache configuration file to reflect the correct file name.
  • Once you have copied all the server certificate files, you may make them readable by the root user only with the following commands:

     $ sudo chown root:root installdir/apache2/conf/server*
    
     $ sudo chmod 600 installdir/apache2/conf/server*
    
  • Open port 443 in the server firewall. Refer to the FAQ for more information.

  • Restart the Apache server.

You should now be able to access your application using an HTTPS URL.

How to force HTTPS redirection with Apache?

Add the following lines in the default Apache virtual host configuration file at installdir/apache2/conf/bitnami/bitnami.conf, inside the default VirtualHost directive, so that it looks like this:

<VirtualHost _default_:80>
  DocumentRoot "installdir/apache2/htdocs"
  RewriteEngine On
  RewriteCond %{HTTPS} !=on
  RewriteRule ^/(.*) https://%{SERVER_NAME}/$1 [R,L]
  ...
</VirtualHost>

After modifying the Apache configuration files:

  • Open port 443 in the server firewall. Refer to the FAQ for more information.

  • Restart Apache to apply the changes.

How to debug Apache errors?

Once Apache starts, it will create two log files at installdir/apache2/logs/access_log and installdir/apache2/logs/error_log respectively.

  • The access_log file is used to track client requests. When a client requests a document from the server, Apache records several parameters associated with the request in this file, such as: the IP address of the client, the document requested, the HTTP status code, and the current time.

  • The error_log file is used to record important events. This file includes error messages, startup messages, and any other significant events in the life cycle of the server. This is the first place to look when you run into a problem when using Apache.

If no error is found, you will see a message similar to:

Syntax OK

How to change the Java memory settings?

The Java Virtual Machine (JVM) determines the default settings for your Java application:

JAVA_OPTS="-Xms256m -Xmx512m"

The Tomcat server uses CATALINA_OPTS to set these Java settings when running:

CATALINA_OPTS="-Xms256M -Xmx768M"

You can increase these settings if necessary by following the steps below:

Linux and Mac OS X

  • Modify the settings file installdir/apache-tomcat/bin/setenv.sh:

     $ export CATALINA_OPTS="$CATALINA_OPTS -Xms256M -Xmx768M"
    

    NOTE: You could also modify the Java Virtual Machine (JVM) settings if you prefer.

       $ export JAVA_OPTS="$JAVA_OPTS -Xms256M -Xmx768M"
    
  • Restart Tomcat after modifying the file:

     $ installdir/ctlscript.sh restart tomcat
    

Windows

  • Modify the settings file installdir/apache-tomcat/bin/setenv.bat:

     $ SET CATALINA_OPTS="%CATALINA_OPTS% -Xms256M -Xmx768M"
    

    NOTE: You could also modify the Java Virtual Machine (JVM) settings if you prefer.

       $ SET JAVA_OPTS="%JAVA_OPTS% -Xms256M -Xmx768M"
    
  • Reinstall the services after modifying the file, as shown below. Run the following commands from an elevated command prompt:

     $ cd installdir
     $ serviceinstall.bat UNINSTALL
     $ serviceinstall.bat INSTALL
    

How to debug errors in Tomcat?

The main Apache Tomcat configuration file is at installdir/apache-tomcat/conf/server.xml.

Once Apache Tomcat starts, it will create several log files in the installdir/apache-tomcat/logs directory. The main log file is the catalina.out file where you can find error messages. On some platforms, you may need root account privileges to view these files.

How to find the database credentials?

  • Database username: postgres.
  • Database password: The password entered during the installation process.

How to connect to the PostgreSQL database?

You can connect to the PostgreSQL database from the same computer where it is installed with the psql client tool.

$ psql -U postgres

You will be prompted to enter the *postgres* user password. This is the same as the [application password](/installer/faq#how-to-find-application-credentials).

Troubleshooting eXo Platform

How to debug errors in eXo Platform?

The eXo Platform log file is stored at installdir/apps/exoplatform/platform.log.

How to change the password for a user manually?

To change the password for a user in eXo Platform, you will have to execute a database query. To do this, follow the steps below:

  • Execute the following command:

     $ psql -U postgres -p POSTGRESQL_PORT -h localhost -d bitnami_exoplatform -c "UPDATE jbid_io_creden c SET text=MD5('YOUR_NEW_PASSWORD') FROM jbid_io u WHERE u.id = c.identity_object_id AND u.name='YOUR_USER_NAME';"
    

Remember to replace POSTGRESQL_PORT with the port for PostgreSQL (by default 5432), YOUR_NEW_PASSWORD with the new password and YOUR_USER_NAME with the current username of your account in eXo Platform.

Can I configure eXo platform in a high-availability setup?

The default Bitnami setup is not prepared for a clustered deployment. You can find more information on how to do that over at the eXo clustered deployment documentation guide.

How to enable development or debug mode in eXo Platform?

Development or debug modes are disabled by default in the Bitnami Stack for eXo Platform because of their performance impact. Enabling these modes will help you debug eXo Platform in case of problems.

Development Mode

Linux and Mac OS X

Follow these steps:

  • Open the installdir/apps/exoplatform/scripts/setenv-customize.sh file in a text editor. Uncomment the lines below so they look like this:

     EXO_DEV=true
     EXO_JCR_SESSION_TRACKING=true
     EXO_TOMCAT_UNPACK_WARS=true
    
  • Restart Tomcat in order for these changes to take effect, either using the manager or manually:

     $ sudo installdir/ctlscript.sh restart tomcat
    
Windows

Follow these steps:

  • Open the installdir/apps/exoplatform/scripts/setenv-customize.bat file in a text editor. Uncomment the lines below so they look like this:

     SET EXO_DEV=true
     SET EXO_JCR_SESSION_TRACKING=true
     SET EXO_TOMCAT_UNPACK_WARS=%EXO_DEV%
    
  • Reinstall the service by running the following commands from an elevated command prompt:

     installdir/serviceinstall.bat REMOVE
     installdir/serviceinstall.bat INSTALL
     installdir/servicerun.bat START
    
  • Restart Tomcat in order for these changes to take effect using the manager.

Debug Mode

Linux and Mac OS X

Follow these steps:

  • Open the installdir/apps/exoplatform/scripts/setenv-customize.sh file in a text editor. Uncomment the lines below so they look like this:

     EXO_DEBUG=true
     EXO_DEBUG_PORT="8000"
    
  • Restart Tomcat in order for these changes to take effect, either using the manager or manually:

     $ sudo installdir/ctlscript.sh restart tomcat
    
Windows

Follow these steps:

  • Open the installdir/apps/exoplatform/scripts/setenv-customize.bat file in a text editor. Uncomment the lines below so they look like this:

     SET EXO_DEBUG=true
     SET EXO_DEBUG_PORT=8000
    
  • Reinstall the service by executing these commands from the Windows command prompt:

     installdir/serviceinstall.bat REMOVE
     installdir/serviceinstall.bat INSTALL
     installdir/servicerun.bat START
    
  • Restart Tomcat in order for these changes to take effect using the manager.

You can find more information about these modes in the documentation for Debug mode and Development mode.

How to configure a redirect for main page to /portal?

eXo Platform runs in the /portal URL by default and, from eXo Platform 4.1.1 and later versions, an automatic redirection has been added from the main domain to the /portal application.

If you have an older version and want to add a simple redirection like the one included in newer versions of Bitnami Stack for eXo Platform, add the following at the beginning of the file in the installdir/apps/exoplatform/conf/httpd-app.conf file.

Redirect / /portal
...

Then, restart the Apache server:

$ sudo installdir/ctlscript.sh restart apache

Where can I learn more about eXo Platform?

Learn more about eXo Platform from the eXo Platform website and the eXo Platform community website.

NOTE: eXo Platform Enterprise is the commercial offering of eXo Platform. You can learn more about it at the eXo Platform edition comparison page. If you are using eXo Platform Enterprise edition, you will need to register a license after the 30 day trial expires.
nativeInstaller

Bitnami Documentation