Magnolia 4.5 reached end of life on June 30, 2016. This branch is no longer supported, see End-of-life policy.
Web-based Distributed Authoring and Versioning (WebDAV) is an extension of the HTTP/1.1 protocol. The purpose of this protocol is to present Web content as a writable medium in addition to being a readable medium. WebDAV on Wikipedia and the WebDAV website provide information on this protocol. The WebDAV module implements the protocol for accessing Magnolia's repository on an author instance. This allows users to edit resources and templates on the client computer.
An example of WebDav in use is a designer editing CSS files located in the
resources repository using a design tool installed on their computer. Another example is a developer editing Freemarker templates located in the
templates workspace using a local tool that provides FreeMarker syntax highlighting and helper functions.
WedDav is a community module. The module is not installed by default. You can download the module from Magnolia Store and our Nexus repository.
To install the WedDAV module, please see the general module installation instructions.
You need to install the following jars from the downloaded bundle:
The module is dependent on a number of libraries that should already be installed in
Failure to add all of the jar files will lead to serious errors. For example, if you do not add the
jackrabbit-jcr-server-2.4.5.jar, when you try to access
http://localhost:8080/author/.webdav/templates you will see the following error:
java.lang.NullPointerException info.magnolia.cms.filters.ServletDispatchingFilter.doFilter(ServletDispatchingFilter.java:123) info.magnolia.cms.filters.AbstractMgnlFilter.doFilter(AbstractMgnlFilter.java:91)
See general module uninstalling instructions and advice.
Watch a video of WebDAV. The clip is from Magnolia 4.2, but is still relevant for 4.5.
The module allows you to access the following workspaces in the
The content available is the same content you see in AdminCentral:
Once the client establishes a WebDAV connection to the repository, the content is displayed like local content and you can edit it accordingly. You cannot access files that are children of other files in AdminCentral.
Always create and delete files in AdminCentral in order to maintain consistency. The WedDAV client will display the new files. You can then edit them on the client computer.
Use the URLs listed below to access a Magnolia workspace with WebDAV.
The WebDAV module defines it's own security client callback filter that ensures Magnolia authentication when users access a workspace with WebDAV. Users login with their Magnolia credentials.
The filter is registered in the filter chain in
class: WebdavClientCallback is the callback for WebDAV clients. It accepts if the header is set correspondingly. Accepts is evaluated depending on WebDAV specific headers. Adds a
realmNameto the header of the response (like
BasicClientCallback), but does not extend
davAgentPattern: The pattern that triggers the filter.
You need to configure your client computer to communicate with Magnolia workspaces. Once the connection is made, content within the workspaces can be modified as if it resided on the client computer. Depending on the type of client, content can be edited directly or transferred to the client and then transferred back to the workspace. This allows users to use their preferred editing tools on the client computer instead of editing within Magnolia.
In most cases, the connection consists of mapping the client's internal filesystem to a workspace in the repository. Folders and files in the repository appear as any other folder or file on the client. There must be a separate mapping for each workspace.
To map a workspace in OS X:
Repeat this procedure for each workspace.
To map a workspace in Linux:
mount -t davfs2 <directory>
directoryis the directory that should be mapped to the workspace.
Connecting to a WebDAV server with Windows is problematic. You can try the options below or connect using a WebDav client.
To map a network drive:
If the mapping completes successfully you can see the selected drive in Windows Explorer. If the mapping does not complete successfully try adding the repository as a network location.
To add a network location:
If neither methods succeeds, see the support matrix of alternative tools on the Magnolia Wiki.
Mini-Redirector is a Microsoft WebDAV client that is provided as part of Windows 8, Windows 7 and Windows Vista. The client is not installed by default on Windows Server 2008 and later versions. To enable it install the Desktop Experience feature.
If you are using BitKinex, for Server-Site Map configuration you need to set the Type path to
Directory WebDAV. By default the path is set to