This documentation relates to an old version of Nuxeo CMF (1.x). You may want to check the latest version if you are using a more recent version.
Skip to end of metadata
Comment: Migration of unmigrated content due to installation of a new plugin
Go to start of metadata

Welcome to the Nuxeo CMF Installation Guide.

You have just downloaded Nuxeo Case Management Framework 1.x, now how do you try it on your computer?

Nuxeo CMF can be installed on any computer, provided that Java is installed. Installing Nuxeo CMF requires 3 simple steps:

  1. Install the downloaded package,
  2. Start the server,
  3. Connect to Nuxeo CMF in a web browser.

Once Nuxeo CMF is installed, you may want to install some additional resources used for some features.

In this page, we explain how to quickly install and start the different Nuxeo CMF packages available for download:

By default, you cannot run two Nuxeo applications at the same time. If you want to run two Nuxeo applications at the same time (for instance a Nuxeo DM and a Nuxeo DAM), you need to change the default port used by the Nuxeo server.

Install Nuxeo CMF on Windows

Depending on the version and distribution of Nuxeo CMF you downloaded, you can have:

  • a .exe file (Windows specific installer)
  • a .zip file (simple archive, multi-OS compliant)

How to Install Nuxeo CMF with the Windows installer

Here are the steps to install Nuxeo CMF using the Windows installer.

To install the application using the Windows installer (.exe), double-click on the .exe installer you downloaded and follow the instructions displayed.

CMF 1.7

On Windows 7, because of rights issues, it is highly recommended to install your Nuxeo application at the root of C: in order for your application to restart correctly at the end of the startup wizard steps.

You can then start Nuxeo CMF.

How to Install Nuxeo CMF from the ZIP archive

Here are the steps to install Nuxeo CMF using the ZIP archive.

Unzip the .zip archive using your favorite tool.

CMF 1.7

On Windows 7, because of rights issues, it is highly recommended to install your Nuxeo application at the root of C: in order for your application to restart correctly at the end of the startup wizard steps.

You can then start Nuxeo CMF.

How to start Nuxeo CMF on Windows

  1. Open the Nuxeo Control Panel.
    Depending on how you installed your application, you can open the Nuxeo Control Panel in two different ways. See below for the appropriate command.
    The Nuxeo Control Panel opens.
  2. Click on the Start button.
    Starting the Nuxeo server takes between 30 sec and several minutes, depending on your hardware and the distribution you have chosen to install.
    When the server is started, the Start button becomes a Stop button.
  3. Open a browser and type the URL http://localhost:8080/nuxeo/.
  • On Nuxeo CMF 1.0 to 1.6, you can directly log in to your application the Administrator user name and the Administrator password and start using your application.
  • On Nuxeo CMF 1.7, you need to set up your application's configuration using the displayed startup wizard.

How to open the Nuxeo Control Panel

Nuxeo CMF package

Command

zip package of Nuxeo CMF 1.0 to 1.6

In the folder C:\Nuxeo application\bin, double-click on NuxeoCtl.exe.

zip package of Nuxeo CMF 1.7

In the folder C:\Nuxeo application\bin, double-click on nuxeoctl.bat.

On Windows 7, you need to run the nuxeoctl.bat and Start Nuxeo.bat commands as an administrator if you haven't installed your Nuxeo application at the root of C: (for instance in C:\Program Files). To run them as an administrator, right-click on the command and click on "Run as administrator".

On Windows, it is possible to start Nuxeo as a service. Please report the Install the application as a Windows service page for guidelines and examples.

Install Nuxeo CMF on Linux

You can install Nuxeo CMF on Linux in three different ways:

How to install Nuxeo CMF the ZIP package

  1. Unzip the downloaded ZIP file using your favorite tool.
    You can then start Nuxeo CMF.

How to Install Nuxeo CMF from the APT repository for Debian and Ubuntu

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

  1. Activate multiverse and partner sources for JDK Sun install and other third parties:
    1. Click on System/Administration/Software Sources.
    2. Check the multiverse and partner sources.
  2. Add the Nuxeo key:
    • Download the Nuxeo key and import it in the "Authentication" tab.
    • Or, in a terminal, issue:
  3. Add the Nuxeo source:
    • In the "Other Software" tab, add "deb http://apt.nuxeo.org/ lucid releases" to the software sources.
    • Or issue the following commands in a terminal:
  4. Install Nuxeo CMF:
    • Click on apt://nuxeo-cmf
    • or, in a terminal, issue:
  5. Follow the instructions displayed.
    If it's your first install of Nuxeo CMF, you can configure:
    • the bind address,
    • the port,
    • the database (a preconfigured PostgreSQL database is suggested by default).

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

Installation details
Here are some information of the installation's configuration:

  • application: opt/nuxeo-cmf
  • Configuration file (nuxeo.conf): etc/nuxeo-cmf/nuxeo.conf
  • logs: var/log/nuxeo-cmf
  • data: var/log/nuxeo-cmf

How to install Nuxeo CMF with the Debian package

A Debian installer (.deb) is available for download. This installer enables you to configure your application at the time of installation and to install it as a Debian service directly.

To install Nuxeo DAM using the Debian package:

Double-click on the downloaded .deb file and follow the instructions displayed. If it's your first install of Nuxeo DAM, you can configure:

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

The application is automatically installed as a service and immediately started and set to automatically start at boot.

The installation's configuration (where to find the configuration file, logs etc) are the same as for the APT sources installation.

How to start Nuxeo CMF on Linux

For a Nuxeo DAM installed from the zip archive:
  1. Launch a terminal and go to your installation directory.
  2. Start the server using the nuxeoctl script (located in the bin directory):
    The command used to launch the Control Panel may not be executable by default. If it is the case, in the terminal go to the bin directory of Nuxeo and type the line below to be able to use it:
    chmod +x *.sh *ctl
    The Control Panel opens.
  3. Click on the Start button.
    Starting the Nuxeo server takes between 30 sec and several minutes, depending on your hardware and the distribution you have chosen to install.
    When the server is started, the Start button becomes a Stop button.
  4. Open a browser and type the URL http://localhost:8080/nuxeo/.
  • On Nuxeo CMF 1.0 to 1.6, you can directly log in to your application the Administrator user name and the Administrator password and start using your application.
  • On Nuxeo CMF 1.7, you need to set up your application's configuration using the displayed startup wizard.

How to Install Nuxeo CMF on Mac OS

To install Nuxeo CMF on Mac OS, you need the .zip package.

Step 1: Install Nuxeo CMF
  1. Unzip the downloaded ZIP file using your favorite tool.
Step 2: Start Nuxeo CMF
  1. From the Finder, click on "Start Nuxeo.command". You can also drag and drop the start script in the terminal and press Enter.
    The command may not be executable by default. If it is the case, in the terminal go to the bin directory of Nuxeo and type the line below:
    chmod +x *.command
    The Control Panel opens.
  2. Click on the Start button.
    Starting the Nuxeo server takes between 30 sec and several minutes, depending on your hardware and the distribution you have chosen to install.
    When the server is started, the Start button becomes a Stop button.
  3. Open a browser and type the URL http://localhost:8080/nuxeo/.
  • On Nuxeo CMF 1.0 to 1.6, you can directly log in to your application the Administrator user name and the Administrator password and start using your application.
  • On Nuxeo CMF 1.7, you need to set up your application's configuration using the displayed startup wizard.

See the Nuxeo CMF User Guide to discover all Nuxeo CMF features.
Download

Download this documentation in PDF.

Detailed install instructions
Join the Nuxeo community
Labels
  • None