This section may contain outdated information about UI. It will be updated soon.

The main purpose of the WebDAV add-on is to facilitate access to files stored in the file storage via the WebDAV protocol. This feature enables users to conveniently open and edit files using desktop applications (such as Word, Excel, LibreOffice, etc.) without the necessity of repeatedly downloading and uploading files to the web application.

Additionally, the add-on offers the following supplementary functionalities:

  • Document version control. Enabling versioning for a document ensures that a new version is generated on the server each time the document is modified.

  • Customizable conflict resolution policies to support collaborative document editing.

  • Ability to manage document access permissions.

  • UI components for managing files and document versions.

  • Integration with external systems through static links for seamless file access.


This add-on requires the Enterprise subscription. If you don’t have the subscription, see how to get the trial version below.

For automatic installation through Jmix Marketplace, follow instructions in the Add-ons section.

For manual installation, follow the steps below.

  1. Configure access to the premium repository.

    • Add the premium repository to your build.gradle:

      repositories {
          // ...
          maven {
              url = 'https://global.repo.jmix.io/repository/premium'
              credentials {
                  username = rootProject['premiumRepoUser']
                  password = rootProject['premiumRepoPass']
    • Add premium repository credentials to ~/.gradle/gradle.properties:


      Get the repository credentials from your license key: the first part of the key before dash is the repository user name, the part after dash is the password. For example, if your key is 123456123456-abcdefabcdef, then the user name is 123456123456 and the password is abcdefabcdef.

  2. Add dependencies to your build.gradle:

    implementation 'io.jmix.webdav:jmix-webdav-starter'
    implementation 'io.jmix.webdav:jmix-webdav-rest-starter'
    implementation 'io.jmix.webdav:jmix-webdav-flowui-starter'

Trial Version

You can get a trial version of the add-on by visiting your profile page. Just click on the Get Enterprise trial button in the Subscriptions section.

Trial versions of commercial add-ons will stop working in 28 days after requesting the trial Enterprise subscription. An application including expired trial add-ons will not run.


Desktop applications use basic authentication for server connections via WebDAV, so you have to setup HTTPS for your web application. Refer to the Configuring HTTPS section for guidance on configuring HTTPS on localhost for development purposes.

Minimal Requirements

The minimum version of Microsoft Office needed to access documents via the WebDAV protocol is MS Office 2010 SP2 or higher. For LibreOffice, the minimum required version is 6.3.

To verify the installed versions of Microsoft Office and Service Pack (SP) on your computer, open MS Word and navigate to the Product Information section via File → Help. Service Pack 2 for MS Office 2010 (and subsequent versions) should display the following number: 14.0.7015.1000 (or higher). To update your Service Pack, click on this link.