This documentation relates to an old version of Nuxeo DM (5.3). You may want to check the latest user guide or administration guide if you are using a more recent version.

Versions Compared

Old Version 3

changes.mady.by.user Solen Guitter

Saved on

compared with

New Version Current

changes.mady.by.user Solen Guitter

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
Section
Column
width75%

Welcome to the Nuxeo DM Install Guide.

You have just downloaded Nuxeo DM, for instance from the download page on nuxeo.com. Now how do you try it on your computer?

Nuxeo DM can be installed on any computer, providing that Java is installed. Installing Nuxeo DM takes 3 simple steps:

  1. Install the downloaded package,
  2. Start the server,
  3. Go on Nuxeo DM in a browser.

See below to install Nuxeo DM on Windows and on Mac OS and Linux.

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

In this section, we explain how to install the different Nuxeo DM packages available for download:

Table of Contents
Tip

For more information on how to install and configure your Nuxeo server, see the Nuxeo configuration page.

Install Nuxeo DM on Mac OS and Linux
Anchor
mac-linux-quick-install

Depending on the distribution you downloaded, you have:

  • a .zip file (simple archive, multi-OS compliant)
  • a .deb file (Linux Debian specific installer)
    Starting Nuxeo server takes between 30 sec and several minutes, depending on your hardware and the distribution you have chosen to install.

Install a JBoss or Tomcat Nuxeo DM with ZIP archive

To install Nuxeo DM on Mac OS or Linux, you need the .zip package.

Panel
bgColor#FFFFFF
borderStyledashed
  1. Unzip the downloaded ZIP file.
  2. Launch a terminal and go to your installation directory.
  3. Make the scripts executable (some ZIP tools lose the executable bit):
    Code Block
    chmod +x *.sh *ctl
  4. Start the server using nuxeoctl script:
    Code Block
    ./nuxeoctl start
  5. On Mac OS X, you can also use convenient commands from the Finder:
    1. Make the .command files executable:
      Code Block
      chmod +x *.command
    2. Click from the Finder on "Start Nuxeo.command" or "Stop Nuxeo.command"
      Tip

      You can also drag and drop the start script in the terminal and press Enter.

Install a JBoss or Tomcat Nuxeo DM with Debian installer
Anchor
debian-install

Here are the steps to install a Nuxeo DM using the Debian installer.

Panel
bgColor#FFFFFF
borderStyledashed
  1. Double-click on the .deb installer you downloaded and follow the instructions displayed.
  2. Nuxeo is installed as a service. To start or stop it, use the invoke-rc.d command on nuxeo-dm service from a terminal:
    Code Block
    sudo invoke-rc.d nuxeo-dm \[start\|stop\|status\|restart\]

Install a JBoss or Tomcat Nuxeo DM with APT sources for Debian
Anchor
apt-debian-install

Here are the steps to install a Nuxeo DM using the APT sources for Debian.

Panel
bgColor#FFFFFF
borderStyledashed
  1. Activate partner sources for JDK Sun install (click on "System/Administration/Software Sources" then check the "multiverse" source)
  2. Then either use your preferred graphical interface (Synaptic, ...)
    1. add "deb http://apt.nuxeo.org/ lucid releases" to the software sources
    2. click on nuxeo-dm-jboss (apt://nuxeo-dm-jboss) or nuxeo-dm-tomcat (apt://nuxeo-dm-tomcat)
  3. either issue the following commands in a terminal:
    Code Block
    sudo add-apt-repository "deb http://apt.nuxeo.org/ lucid releases"
sudo apt-get update
sudo apt-get install nuxeo-dm-jboss
# or
sudo apt-get install nuxeo-dm-tomcat
  4. Follow the instructions displayed.
  5. Nuxeo is installed as a service. To start or stop it, use the invoke-rc.d command on nuxeo-dm service from a terminal:
    Code Block
    sudo invoke-rc.d nuxeo-dm \[start\|stop\|status\|restart\]

Install Nuxeo DM on Windows
Anchor
windows-quick-install

Depending on the distribution you downloaded you have:

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

Starting takes between 30 sec and several minutes, depending on your hardware.

Install a JBoss or Tomcat Nuxeo DM with Windows installer

Here are the steps to install a Nuxeo DM using the Windows installer.

Panel
bgColor#FFFFFF
borderStyledashed
  1. Double-click on the .exe installer you downloaded and follow the instructions displayed.
  2. To start the server, in Programs/Nuxeo DM, click on Nuxeo DM then use the buttons in this Nuxeo control panel to start/stop the server and show/hide the logs.
Tip

If you installed Nuxeo as a Windows service (automatically done when using the Nuxeo installer for Windows), you can use the service for starting the server instead of the Nuxeo control panel.

Install a JBoss or Tomcat Nuxeo DM with ZIP archive

Here are the steps to install a Nuxeo DM using the ZIP archive.

Panel
bgColor#FFFFFF
borderStyledashed
  1. Unzip the downloaded ZIP file at the root of C:.
  2. Start Nuxeo by double-clicking on NuxeoCtl.exe in the folder C:\Nuxeo DM x.x.x\bin\.

Connect to the server using your web browser

  1. Open a browser and type the URL http://localhost:8080/nuxeo/.
  2. Log into Nuxeo EP using the Administrator user name and the Administrator password.

    Once logged with superuser credentials, you can start creating regular users and organize your folders.

Install Nuxeo DM virtual machine image

Nuxeo DM is available in ready-to-use 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.

Panel
bgColor#FFFFFF
borderStyledashed
titleTo install the Nuxeo DM virtual machine image and start Nuxeo:

Anchor
VM-steps

  1. Unzip the downloaded package.
    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.
    The VM image starts.

    Then, Nuxeo DM automatically starts.

    When Nuxeo DM is started, it displays the address at which it is available.
  3. In your browser, type the indicated address.
    The Nuxeo DM login page is displayed.
  4. Log into Nuxeo DM using the Administrator user name and the Administrator password.
Tip

See Nuxeo DM User Guide to discover all Nuxeo DM features.

Column
Panel
bgColor#FFFFFF
titleDownload

Download this documentation in PDF.

Panel
bgColor#FFFFFF
titleBGColor#D5E8FF
titleDetailed install instructions
borderColor#3080FF
Panel
bgColor#cee7ff
titleBGColor#6699cc
titleJoin the Nuxeo community
borderColor#ccc