Nuxeo Drive - Desktop Synchronization Client for Nuxeo
This is an ongoing development project for desktop synchronization of local folders with remote Nuxeo workspaces.
Watch this screencast to get a 6 min overview of this project.
See USERDOC/Nuxeo Drive for complete up-to-date documentation.
Note: this documentation follows the Drive version of the master branch, which could evolve rapidly. To see the documentation of a given Drive release, use this kind of link:
# For Drive 2.1.113 go to: https://github.com/nuxeo/nuxeo-drive/release-2.1.113/README.md
The source code of Nuxeo Drive is available under the GNU Lesser General Public License v2.1 described in LICENSE.txt.
Installing Nuxeo Drive requires two components: a server addon for the Nuxeo Platform and a desktop program on the user's computer.
Server-Side Marketplace Package
Getting the Marketplace Package
Stable releases for Nuxeo Drive are available as a Marketplace package from the Nuxeo Online Services portal: https://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-drive
You can also fetch the latest development version of the Marketplace package for the Nuxeo master branch from the Continuous Integration server (use at your own risk).
Installing the Marketplace Package
The Marketplace package can be installed using the Admin Center / Update Center / Local Packages interface of a Nuxeo server.
Alternatively, from the command line:
$NUXEO_HOME/bin/nuxeoctl stop $NUXEO_HOME/bin/nuxeoctl mp-install --nodeps marketplace-<version>.zip $NUXEO_HOME/bin/nuxeoctl start
Debian based Distributions (and Other GNU/Linux Variants) Client
The .deb (or .rpm) package of the client is not yet available. In the meantime you can install it from source code.
Has been reported to work on Ubuntu >= 12.04.
The easiest and safest way to build Drive is to follow the same steps as we do on Jenkins.
On FreeBSD and macOS, xattrs are enabled in the default kernel.
On GNU/Linux, depending on the distribution, you may need a special mount option (
user_xattr) to enable them for a given file system, e.g.:
sudo mount -o remount,user_xattr /dev/sda3
Nuxeo Drive is officially supported on Python 3.6+.
Install Nuxeo Drive
Install Nuxeo Drive requirements and Nuxeo Drive itself. These are common installation actions, not depending on the package manager:
DRIVE_VERSION=release-3.1.0 pip install -r https://raw.github.com/nuxeo/nuxeo-drive/$DRIVE_VERSION/requirements.txt pip install git+https://github.com/nuxeo/nuxeo-drive.git@$DRIVE_VERSION
~/.local/bin is in the
PATH and then you can start Drive by typing
ndrive in a terminal.
macOS and Windows Desktop Clients
Once the Marketplace package is installed, the macOS/Windows desktop client package can be downloaded from the Home > Nuxeo Drive tab. Administrator rights are required.
You can also fetch the latest development version from the our Continous Integration server.
All the necessary dependencies (such as the Python interpreter and the Qt / PyQt for the client side user interface) are included and will not impact any alternative version you may have already installed on your computer.
To easily manage all dependencies and packaging steps, we created several Jenkinsfiles you can reuse. They are located in the tools/jenikins folder. You may also want to read the docs/deployment.md.
Configuration and Usage
Launch the Nuxeo Drive program (e.g. from the Start menu under Windows).
A new icon should open in the system tray and a popup menu should open asking the user for the URL of the Nuxeo server and credentials.
In the Nuxeo web interface, mark workspaces and folders for synchronization.
You can now go to the local Nuxeo Drive folder by using the menu of the system tray icon.
Command-Line Usage (Advanced)
The desktop synchronization client can also be operated from the command-line:
Make sure that the
ndriveprogram is installed in a folder that has been added to the
PATHenviroment variable of your OS (on Unix like, it may be
You can check by typing the
ndrive --helpcommand in a console.
If you installed the .dmg package for OSX, the binary is:
- You can alias it in your
alias ndrive="/Applications/Nuxeo\ Drive.app/Contents/MacOS/ndrive"
Launch Nuxeo Drive (no automatic background mode yet, this will come in future versions):
Under Windows you can launch
ndrive.exeinstead to avoid keeping the cmd console open while Nuxeo Drive is running instead.
The first time you run this command a dialog window will open asking for the URL of the Nuxeo server and your user credentials.
Alternatively you can bind to a Nuxeo server with your user credentials using the following commandline arguments:
ndrive bind-server nuxeo-username https://server:port/nuxeo --password secret
This will create a new folder called Nuxeo Drive in your home folder on GNU/Linux & macOS and under the Documents folder on Windows.
Go to your Nuxeo with your browser, navigate to workspaces or folder where you have permission to create new documents.
Click on the Nuxeo Drive icon right of the title of the folder to treat this folder as a new synchronization root.
Alternatively you can do this operation from the commandline with:
ndrive bind-root "/default-domain/workspaces/My Workspace"
You can now create office documents and folders locally or inside Nuxeo and watch them getting synchronized both ways automatically.
For more options, type:
ndrive --help ndrive subcommand --help
Translations are managed with Crowdin.
The reference file i18n.json contains the labels and the English values.
The sync-nuxeo-drive-crowdin Jenkins job triggers a daily synchronization of:
- The i18n.json reference file to Crowdin. This file can be edited and changes must be pushed to the current repository.
- The Crowdin translation files to the i18n folder, e.g. i18n-fr.json. These files must never be edited from the source tree.
Generate a bug report in the Advanced tab of the Settings panel of the Nuxeo Drive client.
You can also log TRACE information directly in the console by using the following command-line:
Create a GitHub issue mentionning the version of the Nuxeo Platform, your operating system name and version (e.g. Windows 7), the steps to reproduce the error and a copy of the logs.
For long running sessions, it is better to dump the debug information in a log file. This can be done with the following command:
By default the location of the log file is:
~stands for the location of the user folder. For instance:
- Under Windows 7 and 8:
- Under macOS:
- Under Ubuntu (and other GNU/Linux variants):
- Under Windows 7 and 8:
The backlog is handled on JIRA.
Developing on Nuxeo Drive
See the contributor guide if you wish to actually contribute to the Nuxeo Drive code base.