Nuxeo Server

Installing the Nuxeo Platform on Linux

Updated: September 22, 2017 Page Information Edit on GitHub

This page is scheduled for review and update. Check back soon for updated content!

On Linux, you can install the Nuxeo Platform using the packages below:

  • the ZIP archive,
  • the Virtual Machine image,
  • the Debian package.

Checking Requirements

Check out the Installation for detailed steps to check your Java version and install it.

Installing the Nuxeo Platform from the ZIP Archive

Installing the Nuxeo Platform using the ZIP archive installs the Nuxeo Platform only. External dependencies must be installed separately.

To install the Nuxeo Platform ZIP archive: Unzip the .zip archive using your favorite tool.

What's next? You want to evaluate the platform? You can now start the server. You want to do a complete installation, compatible for a production environment? You should now prepare your environment.

Installing a Nuxeo Virtual Machine Image

The Nuxeo Platform is available as ready-to-use 64b virtual machine images from nuxeo.com. VM images are available for VMWare and Virtual Box. They provide a full environment (OS, database…) and all required dependencies to make the Nuxeo Platform work.

To install the Nuxeo virtual machine image and start Nuxeo:

  1. Unzip the downloaded package.

    Do not use the Windows built-in ZIP functionality (aka "zipfldr.dll" or "Compressed Folders Module"), it reports incorrect uncompressed size. Recommended: 7-Zip.

    You get a folder with the required file for the virtual machine image to run.

  2. Start the virtual machine image in your virtual machine application by double-clicking on it.

    • For the VMWare package, double-click on the file "nuxeo.vmx".
    • For the OVF package: in VirtualBox, go to the File menu and choose Import Appliance. Then start the imported virtual machine.The VM image starts.
      Then, the Nuxeo application automatically starts.
      When the Nuxeo application is started, it displays the address at which it is available.
  3. In your browser, type the indicated address. The startup wizard is displayed to help you configure your application.

    Shell root access

    The password for the root and nuxeo users are generated the first time you start the virtual machine and are displayed on the console. 

Limitations:

  • As a 64 bit virtual image, it cannot be installed on a 32 bit system.
  • MP4 video conversion is not supported because of distribution rights limitations.

Installing the Nuxeo Platform from the APT Repository for Debian and Ubuntu

Installing the Nuxeo Platform using the APT sources for Debian and Ubuntu installs and configures the platform, but it also installs all required dependencies for an optimal use of the platform.

On Debian 8 (jessie), the openjdk-8-jdk is not available in the default repositories. Before installing the nuxeo package, you will need to:

  • add the jessie-backports repository (deb http://httpredir.debian.org/debian jessie-backports main) to your /etc/apt/sources.list
  • refresh your package list (apt-get update)
  • install the package (apt-get install -t jessie-backports openjdk-8-jdk)

You can either install the Nuxeo Platform using the OS graphical user interface or from the terminal.

You will need to know two things first:

  • the codename of your distribution (eg xenial for Ubuntu 16.04 LTS)
  • which kind of Nuxeo release you want to install (Long Term Support, Fast Track or SNAPSHOT; see the page Nuxeo Release Cycle for more details).

For the examples below, let's say you are using Ubuntu 16.04 LTS ("xenial") and want to install the Nuxeo latest Fast Track release (from the "fasttracks" APT repository; for LTS you would replace "fasttracks" with "releases").

Using the Graphical User Interface

 

This requires X11.

  1. Edit the Software sources: using the Unity Dash, running gksudo software-properties-gtk, or browsing the System/Administration/Software Sources Gnome 2 menu.
  2. Download the Nuxeo key and import it in the Authentication tab.
  3. Add the Nuxeo APT repository: on the Other Software tab, add deb http://apt.nuxeo.org/ xenial releases and deb http://apt.nuxeo.org/ xenial fasttracks to the sources. (if you're using another version of Ubuntu, replace trusty by the adequate name, for instance zesty for Ubuntu 17.04)
  4. Click on that link to install Nuxeo: apt://nuxeo.
  5. Follow the instructions displayed. If it's your first install, you can configure:
    • the bind address,
    • the port,
    • the database (a preconfigured PostgreSQL database is suggested by default). The platform is installed as a service. It is automatically started and set to automatically start at boot.
  6. Open a browser and type the URL http://NUXEO_SERVER/nuxeo/. The startup wizard is displayed so you can setup your Nuxeo platform and select the module you want to install.

From the Terminal

The GnuPG package may be missing since Debian Stretch (9):

sudo apt-get install gnupg

  1. Import the Nuxeo key.

    wget -q -O- http://apt.nuxeo.org/nuxeo.key | sudo apt-key add -
    
  2. Add the Nuxeo APT repository.

    sudo add-apt-repository "deb http://apt.nuxeo.org/ $(lsb_release -cs) releases"
    sudo add-apt-repository "deb http://apt.nuxeo.org/ $(lsb_release -cs) fasttracks"
    

    If you don't have add-apt-repository, which is a non-standard command, issue the following commands:

    sudo echo "deb http://apt.nuxeo.org/ $(lsb_release -cs) releases" > /etc/apt/sources.list.d/nuxeo.list
    sudo echo "deb  http://apt.nuxeo.org/  $(lsb_release -cs) fasttracks" >> /etc/apt/sources.list.d/nuxeo.list
    

  3. Update your APT cache.

    sudo apt-get update
    
  4. Install the Nuxeo Platform.

    sudo apt-get install nuxeo
    
  5. Follow the instructions displayed. If it's your first install, you can configure:

    • the bind address
    • the port
    • the database (a preconfigured PostgreSQL database is suggested by default).

    The platform is installed as a service. It is automatically started and set to automatically start at boot.

  6. Open a browser and type the URL http://NUXEO_SERVER/nuxeo/. The startup wizard is displayed so you can setup your Nuxeo platform and select the module you want to install.

Other Recommendations

Prevent Swapping

Like any Java application you should prevent the JVM Heap to be swapped to disk, this will crush server performance. You have two options here:

  • Disable the swap with sudo swapoff -a you’ll need to edit your /etc/fstabto disable swap permanently. Note that before doing this you need to make sure that you have enough memory for all the processes that run on the server (Nuxeo JVM, converters, other custom process and the OS).
  • Limit the swapiness of the OS using sysctl to set vm.swappiness=1.

Temporary Folder

While setting nuxeo.tmp.dir property in nuxeo.conf, we recommend not to use the system temporary folder /tmp because this one can be cleaned up by the operating system. This is the case on Red Hat Enterprise Linux in particular, where systemd-tmpfiles service is deleting old files from /tmp.


a month ago manonlumeau NXDOC-1323: Update BDE doc
a year ago Manon Lumeau 56
a year ago Solen Guitter 55
a year ago Solen Guitter 54
a year ago Thierry Martins 53
2 years ago Benoit Delbosc 52 | Add a recommendations to disable swap
2 years ago Manon Lumeau 51
2 years ago Alain Escaffre 50
2 years ago Manon Lumeau 49
2 years ago Mathieu Guillaume 47
2 years ago Mathieu Guillaume 48
2 years ago Solen Guitter 46
2 years ago Mathieu Guillaume 45
3 years ago Mathieu Guillaume 43
3 years ago Mathieu Guillaume 44 | Migration of unmigrated content due to installation of a new plugin
3 years ago Solen Guitter 41 | Fix broken excerpt of vm installation
3 years ago Solen Guitter 42 | Migration of unmigrated content due to installation of a new plugin
3 years ago Solen Guitter 40 | Add note about Java 8 unavailability in package
3 years ago Solen Guitter 39 | Update related pages
3 years ago Solen Guitter 38 | Add link to download page
3 years ago Julien Carsique 36
3 years ago Julien Carsique 37 | Migration of unmigrated content due to installation of a new plugin
3 years ago Manon Lumeau 35
3 years ago Manon Lumeau 34
3 years ago Solen Guitter 32 | Format
3 years ago Solen Guitter 33 | Migration of unmigrated content due to installation of a new plugin
3 years ago Solen Guitter 31 | Add Checking requirements section
3 years ago Mathieu Guillaume 29
3 years ago Mathieu Guillaume 30 | Migration of unmigrated content due to installation of a new plugin
3 years ago Julien Carsique 27
3 years ago Julien Carsique 28 | Migration of unmigrated content due to installation of a new plugin
4 years ago Solen Guitter 26 | Added tip
4 years ago Solen Guitter 24
4 years ago Solen Guitter 25 | Migration of unmigrated content due to installation of a new plugin
4 years ago Solen Guitter 23
4 years ago Thibaud Arguillere 21
4 years ago Thibaud Arguillere 22 | Migration of unmigrated content due to installation of a new plugin
4 years ago Solen Guitter 20 | Replaced last "releases" repository
4 years ago Solen Guitter 19 | Replaced releases APT repository by fasttracks
4 years ago Mathieu Guillaume 18
4 years ago Solen Guitter 17
4 years ago Solen Guitter 16
5 years ago Solen Guitter 14
5 years ago Solen Guitter 15 | Migration of unmigrated content due to installation of a new plugin
5 years ago Solen Guitter 10
5 years ago Solen Guitter 11 | Migrated to Confluence 4.0
5 years ago Solen Guitter 12 | Migration of unmigrated content due to installation of a new plugin
5 years ago Solen Guitter 13 | Migration of unmigrated content due to installation of a new plugin
5 years ago Mathieu Guillaume 9 | Updated ubuntu distribution name to latest LTS
5 years ago Thierry Martins 8
6 years ago Solen Guitter 7
6 years ago Solen Guitter 6
6 years ago Solen Guitter 5
6 years ago Solen Guitter 4
6 years ago Solen Guitter 3 | Added toc
6 years ago Solen Guitter 2
6 years ago Solen Guitter 1
History: Created by Solen Guitter