Bitnami eXo Platform

    eXo Platform combines collaboration, calendering, content and document management and other productivity tools with social features to provide a complete enterprise intranet. It includes rich collaboration features such as forums, wikis, documents and calendars which are smartly integrated around social networking, activity streams and workspaces. It is carefully designed to be highly engaging for users, it is open source and it is highly customizable to your organizational needs.

    Please review the Quick Start Guide for your platform to get started with the Bitnami eXo Platform Stack:

    Where can I learn more about eXo Platform?

    You can learn more about eXo Platform at the eXo Platform website and the eXo Platform community website.

    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.

    How to start/stop the servers?

    Graphical tool

    The native installers include a graphical tool to manage the servers easily. You can find the "manager-windows.exe", "manager-osx" or "manager-linux" tool in your installation directory. Using this tool, you can Start, Stop or Restart the servers and check the log files. You can click on the icon to start it.

    manager-servers.png

     

    manager-osx.png

     

     

     

     

     

     

     

     

     


    win_platform.png

    On Windows: You can also start the Manager tool from shortcuts: Start -> Program Files -> eXo Platform Enterprise Service -> Manager tool

    Command line tool

    If you prefer, you can use the "ctlscript.sh" utility from the command line. This script is in the installation directory.

    linux_platform.png


    On Virtual Machines and Cloud images:

    $ sudo /opt/bitnami/ctlscript.sh start

    A native installer on Linux:

    $ cd ~/application-version
    $ ./ctlscript.sh start
    

    mac_platform.png

     

    On OS X: You can start the Manager tool from the installation directory or you can use the "ctlscript.sh" utility from a Terminal.

    host:~ user$ cd /Applications/application-version
    host:~ user$ ./ctlscript.sh start

    How to change the startup type for Windows?

    win_platform.png

    By default, all Bitnami installers are configured to start required services automatically. If you wish to change this and start services manually, you will have to use the Microsoft Windows Services tool.

    Follow these steps:

    • Click "Start -> Run" or press Win+R to bring up the "Run" dialog box.
    • Type "services.msc" and click "OK".
    • In the resulting list of services, find the service which you wish to modify. Right-click the service name and select the "Properties" sub-menu.

      service-3.png

    • In the "Startup type" field, choose the value you prefer. For example, to configure a service so that it does not start automatically but must be manually started every time, select "Manual".

    service-4.png

    • If the service is currently running and you wish to terminate it immediately, click the "Stop" button in the "Service status" section. Or, if the service is currently stopped and you wish to start it, click the "Start" button.
    • Click "OK" to save your changes.

    The changes will come into effect after the system is restarted.

    How to create a full backup of eXo Platform?

    Backup

    Bitnami stacks are 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.

    Cloud Server

    Follow these steps:

    • Change to the directory in which you wish to save your backup.
      cd /your/directory
      
    • Stop all servers.
      $ sudo /opt/bitnami/ctlscript.sh stop
      
    • Create a compressed file with the stack contents.
      $ sudo tar -pczvf application-backup.tar.gz /opt/bitnami
    • Restart all servers.
      $ sudo /opt/bitnami/ctlscript.sh start

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

    Virtual Machine

    Follow these steps:

    • Change to the directory in which you wish to save your backup.
      cd /your/directory
      
    • Stop all servers.
      $ sudo /opt/bitnami/ctlscript.sh stop
    • Create a compressed file with the stack contents.
      $ sudo tar -pczvf application-backup.tar.gz /opt/bitnami
    • Restart all servers.
      $ sudo /opt/bitnami/ctlscript.sh start
      

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

    Native Installer (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.
    • Stop all servers using the shortcuts in the Start Menu or the graphical manager tool.

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

    Native Installer (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
      
    • Restart all servers.
      $ sudo installdir/ctlscript.sh start
      

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

    Tabs end

    Restore

    Bitnami stacks are self-contained, so to restore a stack, you only need to uncompress the backup file in the same location. It is important to use the same path that was used when the stack was originally installed.

    Cloud Server

    Follow these steps:

    • Change to the directory containing your backup.
      cd /your/directory
      
    • Stop all servers.
      $ sudo /opt/bitnami/ctlscript.sh stop
    • Rename the current directory to save it.
      $ sudo mv /opt/bitnami /opt/bitnamiBackup
    • Uncompress the backup file to the original directory.
      $ sudo tar -pxzvf application-backup.tar.gz -C /
    • Start all servers.
      $ sudo /opt/bitnami/ctlscript.sh start
      

    Virtual Machine

    Follow these steps:

    • Change to the directory containing your backup.
      cd /your/directory
      
    • Stop all servers.
      $ sudo /opt/bitnami/ctlscript.sh stop
    • Rename the current directory to save it.
      $ sudo mv /opt/bitnami /opt/bitnamiBackup
    • Uncompress the backup file to the original directory.
      $ sudo tar -pxzvf application-backup.tar.gz -C /
    • Start all servers.
      $ sudo /opt/bitnami/ctlscript.sh start
      

    Native Installer (Windows)

    Follow these steps:

    • Uncompress the backup file to the original directory.
    • Install services by launching a new command prompt and executing the following commands. Administrator privileges are required.
      $ cd installdir
      $ serviceinstall.bat INSTALL
      

    You can now start or stop servers using the graphical manager tool.

    Native Installer (Linux and Mac OS X)

    Follow these steps:

    • Change to the directory containing your backup.
      cd /your/directory
      
    • Stop all servers.
      $ sudo /opt/bitnami/ctlscript.sh stop
      
    • Rename the current directory to save it.
      $ sudo mv installdir installdirBackup
    • Uncompress the backup file to the original directory.
      $ sudo tar -pxzvf application-backup.tar.gz -C /
      
    • Start all servers.
      $ sudo installdir/ctlscript.sh start
      

    Tabs end

    IMPORTANT: When restoring, remember to maintain the original permissions for the files and folders. For example, if you originally installed the stack as 'root', make sure that the restored files are owned by 'root'.


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

    How to upgrade eXo Platform?

    It is strongly recommended to create a backup before starting the update process. If you have important data, create and try to restore a backup to ensure that everything works properly.

    There are two different ways to upgrade your application.

    • You can upgrade the application and all stack components, such as PHP, Ruby, MySQL and Apache.
    • You can upgrade the application only without modifying any other stack components.
      • Use the links provided in the application page on the wiki.

    How do I configure the base domain for eXo Platform?

    You can modify the base domain for your eXo Platform installation. You can do this automatically or manually.

    Automatic approach

    If you choose to do this automatically, please execute the following command (where mywebsite.com is your domain, it can also be an IP):

    $ sudo /opt/bitnami/apps/exoplatform/bnconfig --machine_hostname mywebsite.com
    
    $ sudo installdir/apps/exoplatform/bnconfig --machine_hostname mywebsite.com

    If you are using Windows, you can execute the following command instead:

    $ sudo installdir/apps/exoplatform/bnconfig.exe --machine_hostname mywebsite.com
    ​Manual approach

    If you prefer to do this manually, modify the file at /opt/bitnami/apps/exoplatform/gatein/conf/exo.properties (for cloud servers and virtual machines) or installdir/apps/exoplatform/gatein/conf/exo.properties (for native installers).

    Within the file, look for the exo.base.url property and change this to reflect your new domain or IP address. For example:

    exo.base.url=http://www.mywebsite.com
    

    Save your changes to the file and restart the Tomcat server, either via the manager or via your terminal:

    $ sudo /opt/bitnami/ctlscript.sh restart tomcat (on cloud servers and virtual machines)
    
    $ sudo installdir/ctlscript.sh restart tomcat (on native installers)
    

    If you are using Windows, you must execute the following commands instead:

    > installdir/servicerun.bat STOP
    > installdir/servicerun.bat START

    How to configure the email settings of eXo Platform?

    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 /opt/bitnami/apps/exoplatform/gatein/conf/exo.properties file (for cloud servers and virtual machines) or the installdir/apps/exoplatform/gatein/conf/exo.properties file (for native installers).

    Here is an example of the configuration parameters using a Gmail SMTP server:

    exo.email.smtp.from=your_account@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=your_account@gmail.com
    exo.email.smtp.password=***
    exo.email.smtp.socketFactory.port=465
    exo.email.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
    

    You can 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 /opt/bitnami/apps/exoplatform/scripts/setenv-customize.sh file or in the installdir/apps/exoplatform/scripts/setenv-customize.sh file (for native installers).

    Here is an example of the configuration parameters using a Gmail SMTP server:

    EXO_EMAIL_FROM="your_account@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="your_account@gmail.com"
    EXO_EMAIL_SMTP_PASSWORD="your_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 using the GUI, or the console:

    $ sudo /opt/bitnami/ctlscript.sh restart tomcat (on cloud servers and virtual machines)
    
    $ sudo installdir/ctlscript.sh restart tomcat (on native installers)
    

    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:

    • Load the necessary environment by running the command below at a console prompt.
    $ installdir/use_exoplatform (Linux and Mac OS X)
    
    $ installdir\use_exoplatform.bat (Windows)
    
    • Then, 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.

    How to enable SSL?

    You can see how to configure Apache to enable SSL connections at How to enable SSL to access through https?

    How to debug eXo Platform errors?

    If your eXo Platform installation is not working properly, you will be able to know the reason if you check this log:

    installdir/apps/exoplatform/platform.log 
    

    How to enable development or debug mode in eXo Platform?

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

    Development Mode

    Cloud Server

    Follow these steps:

    • Open the /opt/bitnami/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 /opt/bitnami/ctlscript.sh restart tomcat
    

    Virtual Machine

    Follow these steps:

    • Open the /opt/bitnami/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 /opt/bitnami/ctlscript.sh restart tomcat
    

    Native Installer (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
    

    Native Installer (Windows)

    Follow these steps:

    • Open the installdir/apps/exoplatform/scripts/setenv-customize.batfile 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 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.

    Tabs end

    Debug Mode

    Cloud Server

    Follow these steps:

    • Open the /opt/bitnami/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 /opt/bitnami/ctlscript.sh restart tomcat
    

    Virtual Machine

    Follow these steps:

    • Open the /opt/bitnami/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 /opt/bitnami/ctlscript.sh restart tomcat
    

    Native Installer (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
    

    Native Installer (Windows)

    Follow these steps:

    • Open the installdir/apps/exoplatform/scripts/setenv-customize.batfile 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.

    Tabs end

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

    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 configure a redirect for main page to /portal?

    NOTE: 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 eXo Platform, you can add the following at the beginning of the file in the "/opt/bitnami/apps/exoplatform/conf/httpd-app.conf" file.

    Redirect / /portal
    ...

    Then restart Apache server:

    $ sudo /opt/bitnami/ctlscript.sh restart apache
    
     
     
    Tag page (Edit tags)
    • No tags
    Page statistics
    11917 view(s), 22 edit(s) and 19496 character(s)

    Comments

    You must login to post a comment.

    Attach file

    Attachments