Home > Client Applications > Nuxeo Drive > Tutorials > HOWTO: Manually Initialize or Deploy a Nuxeo Drive Instance
Client Applications

HOWTO: Manually Initialize or Deploy a Nuxeo Drive Instance

Updated: November 7, 2024

Usually Nuxeo Drive is initialized when the user completes the Settings panel and successfully logs in. But for auto deployment you might want to use the command line or EXE.

Command Line

You can bind a new engine on Nuxeo Drive by calling the ndrive executable with the following arguments. It is recommended to have your Drive not running while executing this command.

ndrive bind-server [--password PASSWORD] [--local-folder LOCALFOLDER] USERNAME URL

More information about the parameters:

  • USERNAME: The username of the user who will be using Nuxeo Drive. Mandatory.
  • URL: The URL of the Nuxeo server. Mandatory.
  • PASSWORD: The password of the user who will be using Nuxeo Drive. If you don't specify the PASSWORD then it will be asked to the user when Nuxeo Drive is started.
  • LOCALFOLDER: The path to the Nuxeo Drive folder that will be created. Path must include the Nuxeo Drive folder. If LOCALFOLDER is not specified then the default location will be picked.

Installer

On Windows you can automatically call the bind-server command on install if you set up the EXE variables:

  • TARGETURL: The URL of the Nuxeo server. Mandatory.
  • TARGETUSERNAME: The username of the user who will be using Nuxeo Drive. Mandatory.
  • TARGETPASSWORD: The password of the user who will be using Nuxeo Drive. If you don't specify it then it will be asked to the user when Nuxeo Drive is started.
  • TARGETDRIVEFOLDER: The path to the Nuxeo Drive folder that will be created. Path must include the Nuxeo Drive folder.
  • START=auto: Start Nuxeo Drive after the installation.

Examples

Install Nuxeo Drive and configure the Nuxeo server to http://localhost:8080/nuxeo with the username username:

nuxeo-drive.exe /SILENT /TARGETURL="http://localhost:8080/nuxeo" /TARGETUSERNAME="username"

Same as above, but add the associated password:

nuxeo-drive.exe /SILENT /TARGETURL="http://localhost:8080/nuxeo" /TARGETUSERNAME="username" /TARGETPASSWORD="password"

A full installation, useful for large automatic deployments:

nuxeo-drive.exe /VERYSILENT /TARGETDRIVEFOLDER="%USERPROFILE%\Documents\Nuxeo Drive" /TARGETURL="http://localhost:8080/nuxeo" /TARGETUSERNAME="foo"

Even if username is wrong, it will allow the customization of the Nuxeo server on all clients. The users will be asked to enter their username and password upon the first connection.

Deployment Scripts

You can use one of those scripts to automatically deploy a specific version of Nuxeo Drive on a user's machine.

Script Workflow

  1. Stop any running instance of Nuxeo Drive.
  2. Uninstall all Nuxeo Drive versions (from version 3.1.0 to the latest currently available).
  3. Download the installer for the desired Nuxeo Drive version.
  4. Install Nuxeo Drive using the previously downloaded installer.
  5. Add a custom local configuration file to set the auto-update channel to centralized.
    If the desired version is 4.4.0, then an additional parameter will be added: client_version = 4.4.0.
    This is required only for 4.4.0 as newer versions will include the NXDRIVE-2047 fix.

All those actions are done silently, no user interaction will be needed.

The script only install official release. No alpha or beta versions.

Linux

There is currently no script provided for GNU/Linux. But one can be created on-demand.

Mac

Script: deploy-nuxeo-drive-mac.sh.

Usage:

bash deploy-nuxeo-drive-mac.sh VERSION

For example, to deploy Nuxeo Drive 4.4.0, the command line would be:

bash deploy-nuxeo-drive-mac.sh 4.4.0

Windows

Script: deploy-nuxeo-drive-windows.ps1.

Usage:

powershell ".\deploy-nuxeo-drive-windows.ps1" VERSION

For example, to deploy Nuxeo Drive 4.4.0, the command line would be:

powershell ".\deploy-nuxeo-drive-windows.ps1" 4.4.0

Other documentation about Nuxeo Drive