FT 6.0 5.8

5.6

Skip to end of metadata
Go to start of metadata

Nuxeo Drive is a Nuxeo addon that enables the synchronization of folders or workspaces from the Nuxeo Platform with local folder on your computer.

Here is the big picture of how Nuxeo Drive works: on the Nuxeo Platform web interface, you mark some workspaces or folders to synchronize. After you installed the Nuxeo Drive client on your computer and bound it to a Nuxeo server, documents are saved on your computer so you can access them and work on them offline. And the next time you have an Internet connection, changes in your local folder are uploaded to the Nuxeo Platform. Changes on the server are also automatically downloaded to your computer.
Nuxeo Drive also enables to edit synchronized documents locally from your computer.

To enable Nuxeo Drive, you need to install Nuxeo Drive client on your computer so your computer can communicate with the Nuxeo Platform.

The Nuxeo Drive package adds the following elements to your Nuxeo Platform application:

  • a Nuxeo Drive tab in the user Home, from which you can see what Nuxeo spaces are synchronized with Drive,
  • a Drive icon  on folderish document types, to synchronize or unsynchronize spaces.

Installing Nuxeo Drive on your computer

Icon

For the installation of the Nuxeo Drive package on the server, please see the Installation and Administration Guide.

To be able to synchronize folders on your computer, you need to install the Nuxeo Drive client on your computer. We provide OS-specific installer for Mac OS and Windows, available from the Nuxeo Drive tab of the Home. A Linux installer will come shortly.

If you try to synchronize a folder and you haven't installed the Nuxeo Drive client yet or haven't provided your credentials to the Nuxeo Drive client, you are automatically directed to the Nuxeo Drive home tab to install it.

Installing Nuxeo Drive on Mac OS

To install Nuxeo Drive on your Mac OS computer:

  1. Download the installer (.dmg file) from the Nuxeo Drive tab in the Home.
  2. Run the installer: drag and drop the Nuxeo Drive icon in the Applications directory.
    Nuxeo Drive is now installed on your computer.
  3. You now need to start Nuxeo Drive on your computer.
    A Nuxeo Drive folder will be created by the system at the root of your local home folder. This is the place where synchronized documents will be stored on your computer.

Installing Nuxeo Drive on Windows

Nuxeo Drive is known to work on Windows XP, Windows 7.

To install Nuxeo Drive on your Windows computer:

  1. Download the Windows installer (.msi file) from the Nuxeo Drive tab in the Home.
  2. Run the installer: indicate where Nuxeo Drive should be installed (typically C:\Program Files or C:\Program Files (x86)) and click Next until the installation process is done.
    Nuxeo Drive is now installed on your computer.
  3. You now need to start Nuxeo Drive to use it.
    A new Nuxeo Drive Folder will be created by the system at the root of your local home folder (C:\Documents and Settings\USER\Documents\ or C:\Users\USER\Documents\ depending on the Windows version). This is the place where synchronized documents will be stored on your computer.

Ubuntu/Debian (and other Linux variants)

The .deb package of the client is not yet available. In the mean time you can manually install the development version.

To Install Nuxeo Drive on your Linux computer:

  1. Install pip using your favorite package manager and then use it to grab all the dev dependencies and tools at once:

    For now, the systray icon is not visible under Unity desktop. As a consequence, the configuration window only appears at the first launch. If you want to change it, issue the following commands:

  2. Configure automatic start:
    curl https://gist.github.com/jcarsique/5421710/raw/5621c388f85bf6dda7de6d0f726545d6551b5dde/ndrive.desktop -o ~/.config/autostart/ndrive.desktop --create-dirs
  3. You now need to start Nuxeo Drive on your computer.

    Nuxeo Drive folder will be created by the system at the root of your local home folder. This is the place where synchronized documents will be stored on your computer.

Working with Nuxeo Drive

Starting Nuxeo Drive

After you installed Nuxeo Drive, you need to start it manually and provide the address of the Nuxeo application and your credentials on that application.

  1. Start like any other application:
    • On Windows, Nuxeo Drive is started from Start > Programs > Nuxeo Drive.
    • On Mac OS X, Nuxeo Drive is in the Applications directory.
    • On Linux, press Alt+F2 then enter ndrive.
    The Nuxeo Drive icon is displayed:
    • In the top menu bar on Mac OS,
    • in the system tray on Windows.
    • In the system tray on Linux desktops (except Unity).
    An authentication window pops up.
  2. Type the URL of your Nuxeo application, with the /nuxeo/ suffix (http://www.mynuxeoapp.com/nuxeo for instance), your username and your password.
  3. Click on OK.
    Nuxeo Drive immediately starts synchronizing the Nuxeo workspaces or folders you indicated as synchronized in the Nuxeo Platform. It will automatically update content when there is a modification on the server.
    In the Nuxeo Drive tab in your Home, an authentication token corresponding to the computer you are synchronizing from is displayed. The list of synchronized folders is displayed in the Synchronization roots section of the tab.
Icon

After you start Nuxeo Drive the first time, it will be automatically started when you start your computer. So you won't need to repeat these steps.

Accessing the Nuxeo Drive folder

When you install Nuxeo Drive on your computer, it creates a "Nuxeo Drive" folder on your computer, from where you will be able to access the synchronized documents. This Nuxeo Drive folder is located:

  • in C:\Documents and Settings\USER\Documents\ on Windows,
  • at the root of your home folder on Mac OS and Linux OS.

Quick access to this folder is possible at any time using the Nuxeo Drive icon: right-click on the icon (in the top menu bar on Mac OS, in the system tray on Windows) and click on Open Nuxeo Drive folder. The Nuxeo Drive opens like any folder. You can now browse the Nuxeo synchronized folders.

Marking workspaces and folders for synchronization

Nuxeo Drive enables the synchronization of the document types below and their content:

  • Document Management module:
    • workspace,
    • folder,
    • picture book,
    • website,
    • blog,
    • ordered folder,
  • Social collaboration module:
    • social workspace,
    • news folder,
  • Digital Asset Management module:
    • Asset library domain,
    • import set,
    • import folders.

Synchronizing a folder

You can only synchronize spaces on which you have Write or Manage everything rights.

To synchronize a space, in the Nuxeo Platform, click on the icon .
The icon becomes green. Documents inside the synchronized space have an orange icon.
The folder and all its content is now available in your local Nuxeo Drive folder. You can now create, edit, delete documents from your computer.

Suspending Synchronization

If a synchronized folder holds big document or a large amount of documents, synchronization can take some time and some computer resources. It is then possible to suspend synchronization until a more convenient time.

To suspend synchronization:

  1. Click on the Drive icon in the system tray.
  2. Click on Suspend synchronization.
    Pending synchronization tasks are immediately stopped until you resume synchronization.
    The Drive icon becomes grey as long as synchronization is suspended: .

To resume synchronization:

  1. Click on the Drive icon in the system tray.
  2. Click on Resume synchronization.
    Pending synchronization tasks are immediately restarted where they were suspended.

Unsynchronizing a folder

Unsynchronizing a folder is only possible from the Nuxeo Platform web interface. You can only unsynchronize the whole synchronized space, i.e. from the synchronization root (green Drive icon): it is not possible to unsynchronize a child (orange Drive icon). Clicking on this orange icon brings you back on the space from which the synchronization is done (called Synchronization root).

To unsynchronize a space, in the Nuxeo Platform interface, click on the icon .
The icon becomes grey, indicating that the space is no longer synchronized.
The folder and its content is no longer available from your Nuxeo Drive folder.

Creating documents

When you create a new document in a Drive-synchronized folder from the Platform, it is automatically created in your Drive folder at the next synchronization. If you created a file or a picture, what is in the Drive folder is the attachment (mydoc.doc for instance for Nuxeo document whose title could be "My document").

Adding a new document in a Drive-synchronized folder from your computer will create the document in the Platform workspace at the next synchronization (immediately if you're connected to the Internet or the next time you're online if you currently don't have an Internet access). The document's title is the name of the original file, and no metadata is filled in.

Here are some examples of most commonly used item types and their output in Nuxeo:

Item type

Document created in Nuxeo

Folder

Folder

Microsoft Office file

File

OpenOffice.file

File

.txt file

Note

Picture (.jpg, .png, etc)

Picture

Editing documents

When you edit a document from your Nuxeo Drive folder, a new version is automatically created on the Platform and the version number is updated. For instance, if your document's version was 1.0 before modification, it automatically becomes 1.1+ after you edited it from the Nuxeo Drive folder and the 1.1 is archived as it is created.

Editing a locked document

In the Nuxeo Drive folder, no indication is available if a document has been locked from the Nuxeo Platform interface. Nuxeo Drive won't prevent you from working on a document, but it will not update the locked document if you are not the locker. When you save your modification, a new document will be created automatically, whose title will be composed of the file name, your name and the date and time at which the document is created : "my-document (John Doe - 2013-04-01 10-11).odt" for instance. Two documents are now available :

  • the original document, which is locked and hasn't been modified,
  • the new document based on the original one.

Online editing

When you browse a synchronized folder from the Nuxeo Platform UI and want to edit the document's content, you can edit the attachment directly in its native application from the web interface, on the same principle as Live Edit. This saves you the fastidious steps of opening the Drive Folder, browsing its content until you find the document and open it.

To edit a document locally from the web interface:

  1. On the document in the Nuxeo Platform, click on More and then on Edit locally synchronized file.
    A browser's window pops up so you can choose with what application the document should be opened.
  2. Select Nuxeo Drive (which should be the default choice).
    The document opens in its native application (OpenOffice.org for an .odt file for instance).
  3. Edit the document and save the modifications.
    Modifications are saved in the Nuxeo Platform directly.
  4. Close the document.

Renaming documents

Renaming a document from the server, i.e. changing the document's title, has no impact on the file's name in your Nuxeo Drive folder, which is the document's attachment.

Renaming a document from the Drive folder renames the document's attachment on the server.

Moving documents

You can move documents either from your local Nuxeo Drive folder or from the Platform. When you move documents between two synchronized spaces, the move is done on the other side, whether you move documents from the Platform or from your Drive folder.

When you move a document from a Drive-synchronized folder to an unsynchronized one, the behavior is different if you move the document from the Platform or from your local folder.

  • If you move the document from the Platform, the document is not available anymore in your local folder.
  • If you move the document from your local folder, the document is deleted on the Platform and moved into the folder's trash. In the document's history, the deletion is tagged with the Nuxeo Drive category.

Deleting documents

When you delete documents from the Platform, it is deleted from your local Drive folder at the next update.

When you delete a document from your local Drive folder, the document is deleted on the Platform and moved into the folder's trash. In the document's history, the deletion is tagged with the Nuxeo Drive category.

Unauthorizing a Drive client to access the Nuxeo Platform

When you start Nuxeo Drive on your computer for the first time, you need to provide your credentials so the Drive client can communicate with the Nuxeo Platform. This creates an authentication token on the Platform, that is displayed on the Nuxeo Drive tab in the Home. If you want to unauthorize a Drive client to access the Nuxeo Platform using your credentials, for instance because you changed your computer, you can revoke this authentication token. The Nuxeo Drive client will then require the credentials to be updated to connect to the Nuxeo Platform.

To revoke an authentication token:

  1. On the Nuxeo Platform, in the Home tab, click on the Nuxeo Drive tab.
  2. Click on the Revoke button of the token to be revoked. Several elements are displayed to help you identify the right token:
    • the device description: whether it is a Mac OS client, Windows client, Linux client;
    • the creation time: date and time at which the token was created, i.e. the date and time at which you provided it with your credentials.
  3. In the window that pops up, click on OK to confirm.
    The Nuxeo Drive client cannot communicate with the Nuxeo Platform and switches to offline. When you click on the Drive icon, it says "Update credentials (required)".

Advanced usages

You can use  the command line for some advanced options. For example, you can bind the server to a specific folder of your desktop, instead of the default "\My Documents\Nuxeo Drive'". For example you can use:

Note that ndrive is not in your PATH. You need to go to the folder where Nuxeo Drive was setup (in Program Files with Windows).