zimbra-drivev2-guide.adoc

Zimbra Drive

Introduction

Zimbra Drive is an optional Zimbra component that provides both a fully-fledged file storage system integrated with the Zimbra WebClient, and a replacement for the old "Briefcase" component.

Browser compatibility

Zimbra Drive features are available on all browsers officially supported by the {product-short} {web-client}, with some client-side limitations:

Browser	Version	OS	Supported
Microsoft Edge (Chromium)	Latest	Windows	[check circle] Yes
Microsoft Edge (Chromium)	Others	Windows	[check circle] Limited
Microsoft Edge (EdgeHTML)	Any	Windows	[times circle] No
Internet Explorer	Any	Windows	[times circle] No
Mozilla Firefox	Latest	Windows/Linux/OSX	[check circle] Yes
Mozilla Firefox	ESR	Windows/Linux/OSX	[check circle] Yes
Mozilla Firefox	Others	Windows/Linux/OSX	[check circle] Limited
Google Chrome	Latest	Windows/Linux/OSX	[check circle] Yes
Google Chrome	Others	Windows/Linux/OSX	[check circle] Limited
Safari	Latest	OSX	[check circle] Yes
Safari	Others	OSX	[check circle] Limited

While likely to work, items marked as "[check circle] Limited" are only supported on the browser’s two previous stable releases to the current one.

Features

Frontend

• Upload, manage and download files

• Organize files within navigable folders

• Preview files

• Mark files as "preferred" for quick access

• Add custom notes (descriptions) to files

• Share files to internal users

• Share files to external users (NYI)

• Integration with Zimbra Docs

• File search

• Folder-based navigation

• Quick "stateful" navigation

• File Versioning

Backend

• Option to store files on dedicated Zimbra volumes

• zxsuite drive CLI

Differences between Briefcase and Zimbra Drive

Zimbra Drive does not follow the usual mailbox-driven behaviors when it comes to file storage, navigation, sharing, and item deletion. See each feature’s dedicated paragraph for a complete explanation of the differences and of the features themselves.

Zimbra Drive UI

1. Quick Access navigation panel;

2. Folder navigation panel;

3. InfoBox control;

4. New, Upload and Search features;

5. Folder list;

6. File list;

Feature Description

Upload and Download

To upload a file to Zimbra Drive, either click on the "Upload" button above the file list or drag and drop any number of files from your computer to the main Zimbra Drive window.

To download a file from Zimbra Drive, right-click on it and select "Download":

Any file and folder in Zimbra Drive can be renamed by right-clicking on it and selecting the "Rename" option in the context menu.

Navigation

Briefcase items are part of the mailbox’s folder and item hierarchy, while Zimbra Drive has its own internal folder structure and navigation. Navigating through Zimbra Drive folders is done through the Navigation Bar on top of the UI instead of through a tree view and folders are visible in the main section of the UI above files.

On top of the standard folder-based navigation, a "Quick Access" menu is available on the left side of the UI, which allows to quickly view the following types of items: • "Preferred Items" – items marked with the "Star" option available in the right-click context menu; • "Recently Edited" – items edited recently, sorted from the most recently edited; • "Shared with me" – items shared by other users • "Shared by me" – items shared to other users • "Marked for deletion" – items marked for deletion

Folder Creation

To create a folder in Zimbra Drive, click on the "New" button above the file list and select "Folder":

File and Folder naming

The following characters cannot be used in Zimbra Drive folders and files:

• Slash - /

• Backslash - \

• Semicolon - :

• Question Mark - ?

• Plus sign - +

• Asterisk - *

• Percent sign - %

Sharing

Being separated from the mailbox’s item hierarchy, Zimbra Drive files and folders can be shared independently. Sharing permissions can be chosen among 3 options: "View", "Edit" and "Edit and Share" – the latter two options include the "View" right by default.

To share a file or a folder, right-click on it and select "Edit Shares". After entering the email address of the destination user and selecting the sharing permissions, click the (+) button to add the share to the list:

To edit or delete a share, simply click on the dropdown permission selector to change the sharing permissions of the file/folder or click the trash bin icon to delete the share:

In Zimbra Drive, sharing rights are only "additive", so it’s not possible to share an item with a lower permission than its parent, e.g. if a folder is shared with "Edit" permissions it’s not possible to share one of its items with "View" rights with the same person.

Item Deletion

When deleted, Zimbra Drive items are not put into the Trash like every other item type in Zimbra, as such items are marked for deletion instead. To mark a file or a folder for deletion, right-click on it and select "Mark for Deletion":

Items marked for deletion are displayed on the bottom of the file list with a strikethrough line and can be deleted permanently clicking on the "Delete Permanently" entry within the right-click context menu of a file marked for deletion while the "Restore" entry will unmark the file:

While any user with "Edit" or "Edit and Share" rights on an item or folder can mark it for deletion, only the original owner can delete it permanently.

Items marked for deletion cannot be accessed, so should a user try to do so a pop-up message will ask whether to restore the item and access it or to stop the attempt and leave it as marked for deletion.

InfoBox

The InfoBox is a collapsible element that contains all information and controls for the selected file or folder, as well as a preview of the file itself if in a compatible format (pictures, PDFs and more).

To display the Infobox, click on the "(i)" button on the top-right of the Zimbra Drive UI:

The infobox will appear on the right side of the screen:

Top-to-bottom, the InfoBox contains:

• The name of the selected file

• The preview of the file (or a format icon for unsupported formats)

• All action items available in the right-click context menu

• Share information

• Creation and edit information

• A customizable "Description" field

File Versioning

File versioning keeps track of all the versions of files stored in Zimbra Drive and allows end users to recover and download previous file versions.

To access the versioning menu of a file, simply right-click the file and select "File Versions" from the drop down menu.

The File Versioning Menu lists all stored versions of a file, sorted by date descending, and allows to open, download or permanently store each single version through the "options" button on the right side of every entry. On top of this, it is also allows to upload a new version or to purge all existing versions using the "Upload Version" and "Purge Versions" buttons at the bottom of the window.

Note	Files can only be opened for editing if Zimbra Docs is installed and the file type is supported.

By default, Zimbra Drive will save 20 versions for each file for up to 90 days. This can be changed by setting the following NG properties at global, COS or account level:

• driveMaxVersionRetentionDays: maximum retention time in days. Value between 0 (no time limit) and 365. Default 90.

• driveMaxVersionNumber: maximum number of versions to store. When reached, any newer version will replace the oldest one as in a FIFO queue. Value 0 (no limit) or higher. Default 20.

E.g.

• To set the maximum retention duration to 120 at global level, run zxsuite config global set attribute driveMaxVersionRetentionDays value 120

• To set the maximum number of stored version to 5 for the [email protected] account, run zxsuite config account set [email protected] attribute driveMaxVersionNumber value 5

• To reset the maximum retention duration at global level, run zxsuite config global empty attribute driveMaxVersionRetentionDays

Technical information

File Storage

While Briefcase files are stored as mail-like items within the mailbox’s folder tree, Zimbra Drive features a detached folder hierarchy based on nodes: thus, Zimbra Drive folders do not appear as mailbox folders (e.g. in the output of zmmailbox getAllFolders). Zimbra Drive metadata are stored in a dedicated HSQL Database while all files (including previous file versions and file previews) are stored in a dedicated folder within a volume’s root. File naming is now hash-based instead of id-based to achieve native deduplication, compression rules follow the volume’s settings

e.g. Filesystem path for a briefcase file: /opt/zimbra/store/0/[mID]/msg/0/[itemid]-[revision].msg Filesystem path for a Zimbra Drive file: /opt/zimbra/store/drive/[hash]-[revision].[extension]

Volumes

As of this release, Zimbra Drive files are stored in the Current Primary volume as any other item.

Integration with Zimbra Docs If the Zimbra Docs zimlet is correctly installed, dedicated document options will appear in the "New" button above the file list:

When right-clicking on a compatible file, an "Open with Docs" option will also appear:

Furthermore, Zimbra Docs will also allow for previews of compatible document formats to be displayed in the InfoBox.

URLs and Ports

To build URLs and links (e.g. for External Shares) Zimbra Drive uses the default Zimbra settings for the domain of the account in use - the zimbraPublicServiceHostname property is used for the URL itself while the zimbraPublicServicePort property is used for the port.

Should any of the two not be set up, the system will always fall back to the zimbraServiceHostname and zimbraMailPort or zimbraMailSSLPort server-level properties.

Zimbra Drive Backup and HSM

Backup NG

Zimbra Drive files are included in Backup NG, and both the RealTime Scanner and the SmartScan are aware of those and no additional actions must be taken in order to ensure the files' safety.

The Restore on New Account and External Restore modes will also restore Zimbra Drive files, while other restore modes such as the Undelete Restore do not operate on such files.

HSM NG

Zimbra Drive can store its data on a different volume than the default Current Primary one, and HSM policies can move Zimbra Drive files onto a different volume than the Current Secondary one, thus effectively allowing independent storage management for Zimbra Drive files.

When an HSM policy is applied, Zimbra Drive files will be handled under the "document" item type.

This setting is applied at the server level so that different mailbox servers can use different volumes.

Setting the Zimbra Drive Primary volume

To set the Zimbra Drive Primary volume, first find out the volumeID of the target volume by running zxsuite hsm getAllVolumes.

Once the volumeID has been identified, simply run

zxsuite config server set `zmhostname` attribute driveStore value [volumeID]

(where [volumeID] is the ID found with the previous command)

Setting the Zimbra Drive Secondary volume

To set the Zimbra Drive Secondary volume, find out the volumeID of the target volume as described in the previous paragraph and then run the following command

zxsuite config server set `zmhostname` attribute driveSecondaryStore value [volumeID]

Zimbra Drive Installation and Migration

Manually Install or Upgrade zimbra-drive-ng

1. As the root user, instruct yum to install the package.

   yum install zimbra-drive-ng

2. Switch to user zimbra.

   su - zimbra

3. Restart the Zimbra mailbox service for changes to take effect.

   zmmailboxdctl restart
   zxsuite config server set `zmhostname` attribute driveAllowOnUnsupportedZimbraVersion value true
   zxsuite drive doStartService module

Briefcase Migration

Briefcase data can be migrated to Zimbra Drive using the dedicated doImport CLI command:

zimbra@test:~$ zxsuite drive doImport

Syntax:
   zxsuite drive doImport {[email protected],test.com[,...]} [attr1 value1 [attr2 value2...]]

The command accepts a comma-separated list of targets to migrate, which can be either mailboxes or domains, and different target types can be used on the same command.

The following attributes can be used to customize the migration:

NAME	TYPE	EXPECTED VALUES	DEFAULT	DESCRIPTION
targets(M)	String[,..]	[email protected],test.com[,…​]		Comma separated list of targets to migrate
dryRun(O)	Boolean	true or false	false	Only perform a test run without affecting the data
allVersions(O)	Boolean	true or false	false	Migrate all versions of every file
deleteSources(O)	Boolean	true or false	false	Delete migrated files from the Briefcase
overwrite(O)	Boolean	true or false	false	Overwrite existing files
showIgnoredAccounts(O)	Boolean	true or false	false
ignoreQuota(O)	Boolean	true or false	false	Ignore mailbox quota when migrating