Bitnami eXo Platform

    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.

    Please, take a look to the Quick Start Guide to know the basic use of this Stack.

    Where can I learn more about eXo Platform?

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

    eXo Platform Express 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 Express you will need to register a license after the 30-days 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 -> Bitnami Stack -> 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 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:

    • Place in the folder you want to save your backup
      cd /your/folder
    • 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:

    • Place in the folder you want to save your backup
      cd /your/folder
    • 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:

    • Place in the folder you want to save your backup
      cd /your/folder
    • 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:

    • Place in the folder where you have your backup
      cd /your/folder
    • 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:

    • Place in the folder where you have your backup
      cd /your/folder
    • 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:

    • Place in the folder where you have your backup
      cd /your/folder
    • 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 to configure the email settings of eXo Platform?

    If you have eXo Platform 4.1 or newest:

    To send emails from eXo Platform application via SMTP protocol, it is necessary to specify the SMTP settings in:

    installdir/apps/exoplatform/gatein/conf/exo.properties

    Here is the sample using smtp.gmail.com 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.

    If you have an older version:

    To send emails from eXo Platform application via SMTP protocol, it is necessary to specify the SMTP settings in:

    installdir/apps/exoplatform/scripts/setenv-customize.sh

    And modify this settings (f.e, for gmail.com):

    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"

    If you are on GNU/Linux or MacOSX, you will need to uncomment the lines deleting "#", and if you are on Windows, you will need to delete the "REM" string in this lines.

    After apply the changes, restart the Tomcat server using the GUI, or the console:

    sudo installdir/ctlscript.sh restart tomcat

    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:

    /opt/bitnami/apps/exoplatform/platform.log 

    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?

    eXo Platform runs in the "/portal" URL by default. If you want to add a simple redirection from your main domain to the "/portal" application, 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
    8418 view(s), 6 edit(s) and 5510 character(s)

    Comments

    You must login to post a comment.

    Attach file

    Attachments