Difference between revisions of "WebDAV access"

From OpenKM Documentation
Jump to: navigation, search
 
(35 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
{{TOCright}} __TOC__
 +
 +
While OpenKM has had WebDAV support since early versions, the new WebDAV implementation in version 5.1.8 brings improved WebDAV compatibility, thanks to its use of the excellent open-source [http://milton.io/ Milton WebDAV API for Java]. The [http://milton.ettrema.com/ Milton project] maintains a detailed [http://milton.io/guide/compat/ WebDAV client compatibility list] that describes a "Recipe for broad client compatibility."
 +
 
Below you there is a list of WebDAV clientes grouped by Operating System. Once you have installed any of these tools, you can access to OpenKM repository with this URL:
 
Below you there is a list of WebDAV clientes grouped by Operating System. Once you have installed any of these tools, you can access to OpenKM repository with this URL:
  
−
  http://your-domain.com/OpenKM/repository/default/okm:root.
+
  http://your-domain.com/OpenKM/webdav
 +
 
 +
To enhance compatibility, starting with OpenKM 5.0.4 when an WebDAV path is like '''/okm:root/myfile.txt''' it is translated to '''/okm_root/myfile.txt''' because some WebDAV clients does not like character : in the path. Starting with OpenKM 5.1 we have added a new configuration parameter called '''system.webdav.fix''' to make this behavior configurable.
 +
 
 +
If you click in the WebDAV's clipboard icon, the WebDAV URL of this document or folder will be copied into the clipboard, so you can paste it into an email, for example.
 +
 
 +
[[File:Webdav clipboard.png|center]]
  
 
{{Note|Since OpenKM 5.0 WebDAV is disabled by default. If you want to enable it, add
 
{{Note|Since OpenKM 5.0 WebDAV is disabled by default. If you want to enable it, add
Line 7: Line 17:
 
   system.webdav≠on
 
   system.webdav≠on
  
−
to your [[OpenKM.cfg]] configuration file.}}
+
to your [[OpenKM.cfg]] configuration file. Starting with OpenKM 5.1 this property will be renamed to:
 +
 
 +
  system.webdav.server≠on
 +
 
 +
And should be changed from '''Administration''' > '''Configuration'''.
 +
}}
  
 
== Windows ==
 
== Windows ==
Line 15: Line 30:
 
* http://www.webdrive.com/ (The recommended option and create a new document version when you save the modifications)
 
* http://www.webdrive.com/ (The recommended option and create a new document version when you save the modifications)
  
−
{{Note|[http://greenbytes.de/tech/webdav/webdav-redirector-list.html This page from Greenbytes] is an excellent resource to analyze & fix problems with your Windows WebDAV client.}}
+
{{Note|Starting with OpenKM 5.1.8 WebDAV URL is http://host:8080/OpenKM/webdav/okm:root.}}
 +
 
 +
=== WebDrive ===
 +
Probably this is the best choice if you are under Windows, because of its stability and ease of configuration. WebDrive 10 (Version 10.00, Build 2521) has been roughly tested with OpenKM 5.1.9 to enhance compatibility effort. This is the supported configuration to work with OpenKM WebDAV connector:
 +
 
 +
{| align="center"
 +
! align="center" | Program Settings
 +
! align="center" | Site Options
 +
|-
 +
|[[File:WebDrive Program Settings.png|430px|center|una cosa]]
 +
|[[File:WebDrive Site Options.png|430px|center]]
 +
|}
 +
 
 +
Also is recommended to set these OpenKM options:
 +
 
 +
[[File:OpenKM_WebDAV_Options.png|center]]
 +
 
 +
=== Windows Web Folders ===
 +
Out of the box, Windows (XP, 7) has some native support for the WebDAV protocol, but there are some well-known issues. Please consult the following articles in case of any problem.
 +
 
 +
{{Note|Be aware that there are multiple versions of WebDAV Microsoft libraries (and different flavors of bugs). To avoid some frustration if the steps below don't work for you, [[http://support.microsoft.com/?kbid=892211 Update Windows XP for Web Folders]], or take more information about [http://greenbytes.de/tech/webdav/webfolder-client-list.html Web Folder Client (MSDAIPP.DLL) Versions and Issues].}}
 +
 
 +
{{Note|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 on . However, SSL connections do bring improved security. [http://greenbytes.de/tech/webdav/webdav-redirector-list.html This page from Greenbytes] is an excellent resource to analyze & fix problems with your Windows WebDAV client.}}
 +
 
 +
Perform the following steps in Internet Explorer:
 +
 
 +
* Select File -> Open.
 +
* Fill in URL like http://localhost:8080:/OpenKM/webdav
 +
* Check "Open as Web Folder".
 +
* Click OK.
 +
 
 +
=== Windows XP's My Network Places ===
 +
This enables you to access OpenKM from almost any Windows XP application that supports 'Network Places' in the standard File dialog:
 +
 
 +
* Open networking
 +
* Connect as network resource
 +
* Write url http://host:8080/OpenKM/webdav
 +
* Write user and password
 +
 
 +
* Open the Registry Editor utility (regedit.exe).
 +
* Into '''HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\WebClient\Parameters''' look for '''TypeUseBasicAuth''' and replace the default value (1) by 2 allowing BasicAuth through NON SSL connections.
 +
* Then map your drive using this address: \\localhost:8080/OpenKM/repository/default/okm_root/
 +
 
 +
{{Note|Starting with OpenKM 5.1.8 the WebDAV URL is \\localhost:8080/OpenKM/webdav/okm_root/.}}
 +
 
 +
See also: [http://forum.openkm.com/viewtopic.php?f=4&t=5183&p=12123 Forum: OpenKM + Webdav + Windows 7 => finally working].
 +
 
 +
=== Windows slow WebDAV performance ===
 +
If you have a slow webdav connection in windows 7 please follow the instructions in [http://oddballupdate.com/2009/12/18/fix-slow-webdav-performance-in-windows-7/ Fix Slow WebDAV Performance in Windows 7]. ''It turns out to be a windows issue, not OpenKM''.
 +
 
 +
Furthermore in Windows 7/Vista you need to add your certificate (if its 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):
 +
 
 +
# Get the certificate from the server administrator in CER format or download it from Firefox.
 +
# Start windows Certificate Manager: in “cmd” type certmgr.msc
 +
# Select on the left “Trusted Root Certification Authorities”
 +
# In the menu “Actions” -> “All Tasks” select “Import” and then “Next”
 +
# Browse for the location of certificate file you saved earlier on your computer and click “Open”.
 +
# You will get a few more warning messages. Just say to go through with it until the certificate is accepted.
 +
 
 +
Then you can map webdav content as a network drive without any other software. The folder should be:
 +
https://server:port/OpenKM/repository/default/
  
−
You can try connecting directly using windows networking:
+
To make sure that everything is ok with certificates, open the address using IE. If no warning pops up then its a go.
−
* open networking
+
 
−
* connect as network resource
+
This allows you 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 lock).
−
* write url http://host:8080/OpenKM/repository/default/okm:root
+
 
−
* write user and password
+
'''Note''': For Windows XP there is a fix (KB907306).
 +
 
 +
=== Turn off file locking ===
 +
Choose "Run" in the start menu and type "regedit". Now modify or create this configuration para meter:
 +
 
 +
[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\WebClient\Parameters]
 +
"SupportLocking"=dword:00000000
 +
 
 +
=== More info ===
 +
* [http://forum.openkm.com/viewtopic.php?f=4&t=5183&p=12123 Forum: OpenKM + Webdav + Windows 7 => finally working].
 +
* [https://ecommunities.belgium.be/ecomnlsupport/help/_en_US/webdav/wd_clientsonxp_bg.html|Understanding WebDAV Clients on Windows XP]
 +
* [http://myweblocker.lcisd.org/client/webdav.aspx#windows|School Web Lockers Webdav For MS Windows]
  
 
== Mac ==
 
== Mac ==
−
From OSX you can use:
+
From OS X you can use:
  
 
* http://cyberduck.ch/
 
* http://cyberduck.ch/
 
* http://www.webdrive.com/ (Yes, there is a version for Macintosh OS/X)
 
* http://www.webdrive.com/ (Yes, there is a version for Macintosh OS/X)
 +
 +
=== Mac OS X Finder ===
 +
The OpenKM repository can be accessed easily with the Mac OS X Finder.
 +
 +
* First select in the Finder "Go" and "Connect to Server...".
 +
* Fill in the WebDAV URL http://localhost:8080/OpenKM/webdav
 +
* Enter a username and password...
 +
* And the document repository is accessible!
  
 
== Linux ==
 
== Linux ==
Line 34: Line 129:
 
* http://dav.sourceforge.net/
 
* http://dav.sourceforge.net/
 
* http://savannah.nongnu.org/projects/davfs2
 
* http://savannah.nongnu.org/projects/davfs2
 +
 +
For example, in Ubuntu or any Debian-based Linux distro you can install this utility this way:
 +
 +
$ sudo aptitude install davfs2
 +
 +
Make a mount point:
 +
 +
$ mkdir ~/okmdav
 +
 +
And mount it:
 +
 +
$ sudo mount.davfs "http://localhost:8080/OpenKM/repository/default" ~/okmdav
 +
 +
{{Note|Starting with OpenKM 5.1.8 WebDAV URL is http://host:8080/OpenKM/webdav.}}
 +
 +
To ease the process, add this entry to /etc/fstab:
 +
 +
  http://dms:8080/OpenKM/webdav /home/username/webdav davfs noauto,user,rw 0 0
 +
 +
And then in user's home dir, look for '''./davfs2/davfs2.conf'''. There you'll find a '''if_match_bug 1''' line, uncomment it.
  
 
See also:
 
See also:

Latest revision as of 12:21, 8 May 2014

While OpenKM has had WebDAV support since early versions, the new WebDAV implementation in version 5.1.8 brings improved WebDAV compatibility, thanks to its use of the 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."

Below you there is a list of WebDAV clientes grouped by Operating System. Once you have installed any of these tools, you can access to OpenKM repository with this URL: 

http://your-domain.com/OpenKM/webdav

To enhance compatibility, starting with OpenKM 5.0.4 when an WebDAV path is like /okm:root/myfile.txt it is translated to /okm_root/myfile.txt because some WebDAV clients does not like character : in the path. Starting with OpenKM 5.1 we have added a new configuration parameter called system.webdav.fix to make this behavior configurable.

If you click in the WebDAV's clipboard icon, the WebDAV URL of this document or folder will be copied into the clipboard, so you can paste it into an email, for example.

Webdav clipboard.png

Nota clasica.png Since OpenKM 5.0 WebDAV is disabled by default. If you want to enable it, add 
 system.webdav≠on

to your OpenKM.cfg configuration file. Starting with OpenKM 5.1 this property will be renamed to: 

 system.webdav.server≠on

And should be changed from Administration > Configuration.


Windows

From Windows you can access OpenKM repository exposed via WebDAV using one o this tools:


Nota clasica.png Starting with OpenKM 5.1.8 WebDAV URL is http://host:8080/OpenKM/webdav/okm:root.

WebDrive

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

Program Settings Site Options
una cosa
WebDrive Site Options.png

Also is recommended to set these OpenKM options:

OpenKM WebDAV Options.png

Windows Web Folders

Out of the box, Windows (XP, 7) has some native support for the WebDAV protocol, but there are some well-known issues. Please consult the following articles in case of any problem.


Nota clasica.png Be aware that there are multiple versions of WebDAV Microsoft libraries (and different flavors of bugs). To avoid some frustration if the steps below don't work for you, [Update Windows XP for Web Folders], or take more information about Web Folder Client (MSDAIPP.DLL) Versions and Issues.


Nota clasica.png 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 on . However, SSL connections do bring improved security. This page from Greenbytes is an excellent resource to analyze & fix problems with your Windows WebDAV client.

Perform the following steps in Internet Explorer:

Windows XP's My Network Places

This enables you to access OpenKM from almost any Windows XP application that supports 'Network Places' in the standard File dialog:

  • Open the Registry Editor utility (regedit.exe).
  • Into HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\WebClient\Parameters look for TypeUseBasicAuth and replace the default value (1) by 2 allowing BasicAuth through NON SSL connections.
  • Then map your drive using this address: \\localhost:8080/OpenKM/repository/default/okm_root/

Nota clasica.png Starting with OpenKM 5.1.8 the WebDAV URL is \\localhost:8080/OpenKM/webdav/okm_root/.

See also: Forum: OpenKM + Webdav + Windows 7 => finally working.

Windows slow WebDAV performance

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 OpenKM.

Furthermore in Windows 7/Vista you need to add your certificate (if its 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 windows Certificate Manager: in “cmd” type certmgr.msc
  3. Select on the left “Trusted Root Certification Authorities”
  4. In the menu “Actions” -> “All Tasks” select “Import” and then “Next”
  5. Browse for the location of certificate file you saved earlier on your computer and click “Open”.
  6. You will get a few more warning messages. Just say to go through with it until the certificate is accepted.

Then you can map webdav content as a network drive without any other software. The folder should be: https://server:port/OpenKM/repository/default/

To make sure that everything is ok with certificates, open the address using IE. If no warning pops up then its a go.

This allows you 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 lock).

Note: For Windows XP there is a fix (KB907306).

Turn off file locking

Choose "Run" in the start menu and type "regedit". Now modify or create this configuration para meter: 

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

More info

Mac

From OS X you can use:

Mac OS X Finder

The OpenKM repository can be accessed easily with the Mac OS X Finder.

  • First select in the Finder "Go" and "Connect to Server...".
  • Fill in the WebDAV URL http://localhost:8080/OpenKM/webdav
  • Enter a username and password...
  • And the document repository is accessible!

Linux

From Linux you can use:

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

$ sudo aptitude install davfs2

Make a mount point: 

$ mkdir ~/okmdav

And mount it: 

$ sudo mount.davfs "http://localhost:8080/OpenKM/repository/default" ~/okmdav

Nota clasica.png Starting with OpenKM 5.1.8 WebDAV URL is http://host:8080/OpenKM/webdav.

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

 http://dms:8080/OpenKM/webdav /home/username/webdav davfs noauto,user,rw 0 0

And then in user's home dir, look for ./davfs2/davfs2.conf. There you'll find a if_match_bug 1 line, uncomment it.

See also:

Retrieved from "https://www.openkm.com/wiki/index.php?title=WebDAV_access&oldid=11475"