Enable WebDAV

Once WebDAV is enabled, you can access the OpenKM repository with this URL:

http://your-domain.com:8080/openkm/webdav

Caution

If you plan to use WebDAV, avoid using certain characters in folders and documents like “%” because they won’t be accessible from a WebDAV client.

Go to Administration > Configuration parameters:

Field / Property	Type	Description
system.webdav.server	Boolean	Enable WebDAV service. By default,  it is disabled. true
system.webdav.fix	Boolean	The character “:” may cause problems with some WebDAV clients. Enabling this parameter will replace the character “:” in the URL with “_”. By default, it is disabled. It’s recommended to enable this parameter to prevent compatibility problems with some WebDAV clients. A path like /okm:root/myfile.txt will be translated to /okm_root/myfile.txt true

Tip

OpenKM WebDAV is based on excellent Open Source Milton WebDAV API for Java. The Milton project maintains a detailed WebDAV client compatibility list that describes a “Recipe for broad client compatibility.”

Linux

From Linux you can use:

• http://dav.sourceforge.net/
• http://savannah.nongnu.org/projects/davfs2

For example, in Ubuntu or any Debian-based Linux distro you can install this utility as follows:

$ sudo aptitude install davfs2

Make a mount point:

$ sudo mkdir ~/okmdav

And mount it:

$ sudo mount.davfs "http://your-domain.com:8080/openkm/webdav" ~/okmdav

To ease the process, add this entry to your /etc/fstab:

http://your-domain.com:8080/openkm/webdav /home/username/webdav davfs noauto,user,rw 0 0

And then in the user’s home directory, look for ./davfs2/davfs2.conf. There you’ll find a if_match_bug 1 line. Uncomment it.

See also:

• Ubuntu: Mounting remote filesystem using davfs2 (FUSE)

Windows

Install a WebDAV client for Windows.

Danger

We don’t recommend using the default Windows WebDAV support because it is buggy.

Here you have several options:

• https://cyberduck.io/ (Best interoperability with WebDAV servers)
• http://www.netdrive.net/ (Free for home use but does not handle document versioning properly)
• http://www.webdrive.com/ (This is the recommended option and will create a new document version when you save modifications)
• WebDAV Clients on Windows XP

Windows 10

Windows 10 WebDAV support has been improved. Follow these steps to add the OpenKM repository as a network resource:

• Right-click on “This PC”
• Choose “Map network drive…”
• Click on “Connect to a Web site that you can use to store your documents and pictures” link
• A new dialog will open. Here you only have to click the “Next” button
• Click on “Choose a custom network location” and then on the “Next” button
• Write your URL like this http://your-domain.com:8080/openkm/webdav
• Enter your username and password.
• Choose a name for this connection

If you get an error when connecting to the WebDAV resource, follow these steps:

• Go to OpenKM > Administration > Config and enable the system.webdav.fix configuration parameter
• Go to the Windows server and open the Registry Editor utility (regedit.exe).
• Go to  HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\WebClient\Parameters, look for BasicAuthLevel and replace the default value “1” by “2”.
• Map your drive using this address: \\your-domain.com:8080/openkm/repository/default/okm_root/

Danger

Due to how Windows 10 establishes WebDAV connections, a WebDAV connection using a Windows 10 network location will not continue to work after you restart your computer - you will need to delete an existing connection and follow the steps below each time you need to connect to OpenKM.

To establish a persistent WebDAV connection that you can reuse after restarting your computer, we recommend downloading and using Cyberduck instead of connecting with a Windows network location.

WebDrive

Probably this is the best choice if you are using Windows, because of its stability and ease of configuration. WebDrive 10 (Version 10.00, Build 2521) has been tested with OpenKM to improve compatibility. This is the supported configuration to work with the OpenKM WebDAV connector:

 Windows Web Folders

Perform the following steps in Internet Explorer:

• Select File -> Open.
• Enter the URL as http://your-domain.com:8080/openkm/webdav
• Check “Open as Web Folder”.
• Click OK.

Danger

There are some well-known issues. Please consult the following articles in case of any problems.

• Be aware that there are multiple versions of Microsoft’s WebDAV libraries (and different types of bugs). To avoid some frustration if these steps don’t work for you, see Update Windows XP for Web Folders; more information at  Web Folder Client (MSDAIPP.DLL) Versions and Issues.
• Windows Vista and Windows 7 both restrict access to WebDAV servers that use Basic HTTP authentication on non-SSL connections. This restriction can be solved by changing a registry key. Read more online. However, SSL connections do bring improved security. This page from Greenbytes is an excellent resource to analyse & fix problems with your Windows WebDAV client.

Windows XP’s “My Network Places”

Windows XP supports ‘Network Places’ in the standard File dialog:

• Open networking.
• Connect as a network resource.
• Enter the URL http://your-domain.com:8080/openkm/webdav
• Enter your username and password.
• Open the Registry Editor utility (regedit.exe).
• Go to  HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\WebClient\Parameters, look for TypeUseBasicAuth and replace the default value “1” with “2”, allowing BasicAuth through non-SSL connections.
• Map your drive using this address: \\your-domain.com:8080/openkm/repository/default/okm_root/

More information at our OpenKM Forum.

Other tools

• RaiDrive

Mac

Install any WebDAV client for Mac. Here are some options:

• https://cyberduck.io/ (Best interoperability with WebDAV servers)
• http://www.webdrive.com/ (There is a version for Mac OS X)

Mac OS X Finder

• In the Finder, select “Go” and “Connect to Server…”.
• Enter the WebDAV URL http://your-domain:8080/openkm/webdav
• Enter a username and password.
• Then the document repository is accessible!

Troubleshooting

Slow WebDAV performance on Windows

If you have a slow WebDAV connection in Windows 7, please follow the instructions in Fix Slow WebDAV Performance in Windows 7. It turns out to be a Windows issue, not an OpenKM issue.

Furthermore, in Windows 7/Vista you need to add your certificate (if it’s not issued by a verified CA) into Windows if you plan to use WebDAV over SSL (and, like me, do not compensate with Digest auth):

1. Get the certificate from the server administrator in CER format or download it from Firefox.
2. Start the Windows Certificate Manager: in the command line type certmgr.msc
3. In the left pane, select Trusted Root Certification Authorities.
4. In the menu Actions > All Tasks select Import and then Next.
5. Browse for the location of the certificate file you saved earlier on your computer and click Open.
6. You will get a few more warning messages. Just proceed through them until the certificate is accepted.

Then map WebDAV content as a network drive without any additional software. The folder should be: http://your-domain:8080/openkm/webdav

To make sure that everything is OK with certificates, open the address using IE. If no warning is shown, then the certificate is fine.

Caution

This allows you only to read/view files. If you need write access over a network drive you need to disable File Locking (Windows does not support WebDAV file locking).

For more information Web Lockers WebDAV For MS Windows

Caution

For Windows XP there is a fix (KB907306).

Turn off file locking

If you need write access over a network drive you need to disable File Locking (Windows does not support WebDAV file locking).

Execute the Registry Editor tool: in the command line type regedit. Modify or create this configuration parameter:

[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\WebClient\Parameters]
"SupportLocking"=dword:00000000