WebDAV (Web Distributed Authoring and Versioning) is a communications protocol that provides access to the file system on the staging server similar to FTP/SFTP and can be used in lieu of FTP/SFTP. Unlike FTP/SFTP, when file management is performed using WebDAV, Omni CMS treats the files as if they were being managed via the Omni CMS interface. This includes permissions/access control, checking files in and out, renaming, adding, deleting, etc. WebDAV functionality (aka verbs) such as rename, delete, get, and put integrate with Omni CMS.
WebDAV is provided by default for an account and must be enabled on a per-site basis and for each level 9 or level 10 user that needs it. Once enabled in Omni CMS, a WebDAV client can be used to connect to the staging server. This view of the system provides restricted access to both the OMNI-RESOURCES and the OMNI-INF folders for a site.
When allowing WebDAV access in user settings, note the WebDAV URL. This is used when configuring settings for the WebDAV client, and is the path to the site. A specific folder can be appended to it and used for the WebDAV client configuration.
Asset files are not accessible for editing via WebDAV.
Authentication MethodsLink to this section
You can log in to an Omni CMS site using WebDAV using LDAP or Omni CMS login credentials. CAS and Shibboleth authentication is not supported for WebDAV, as the user's password must be stored inside Omni CMS; CAS and Shibboleth both store passwords separately from Omni CMS, which WebDAV cannot access during the authentication process. If you have LDAP configured for single sign-on, you need to set a password in your account settings to authenticate via WebDAV.
If WebDAV is activated for a site but users in the site do not have passwords added into the system, Omni CMS prompts administrators to give a password to the user.
Supported ClientsLink to this section
The integration of WebDAV into Omni CMS supports a number of WebDAV clients. It is always recommended to use the most up-to-date version of the below clients to ensure they support TLS 1.2 or greater. Older version may also be supported depending upon encryption settings and support of TLS 1.2.
- Adobe Dreamweaver (Web development, both Windows and Mac) CC 2017+
- Coda (FTP/SFTP/WebDAV client, Mac), version 2.7+
- Cyberduck (FTP/SFTP/WebDAV client, both Windows and Mac), version 7.2+
- Interarchy (FTP/SFTP/WebDAV client, Mac), version 10.0.7+
- Mac OS X Finder (Mac), for OS X 10.9+
- Oxygen XML Editor v20+
- Transmit (FTP/SFTP/WebDAV client, Mac), version 5.0+
NotesLink to this section
- When troubleshooting connection errors, WebDAV must be enabled for each site, as well as for the administrator. If not enabled at one of these levels, the WebDAV client can't connect.
- Use caution when granting staging server access as an administrator is able to delete the site files from the staging server.
- Users may need to refresh their browser windows in both Omni CMS and the WebDAV client to see changes made by one or the other, if both are active at the same time.
- Files and folders can only be moved within the WebDAV-enabled site. Moving files across sites is not supported. (One alternative to be considered is copying files to a local computer and then to the desired site.)
- Naming and renaming a file doesn't conform to the site′s pre-defined regex settings. Special characters are permitted upon upload and renaming file or folders. Users need to be careful as some special characters can cause Omni CMS to stop responding to the file. Error behavior in this case can include preview and rename not functioning. If a problem character is present in a file that was uploaded or renamed via a WebDAV client into Omni CMS, the user needs to use the WebDAV client to rename the file.
- Uploading non-binary files (text) via WebDAV is permitted. Uploading binary files via WebDAV to the Omni CMS staging server is permitted as long as binary management is enabled.
- The WebDAV client, if it supports locking, checks out files to the user in Omni CMS. If a file is checked out to another user in Omni CMS, then the file is locked to the WebDAV client; the client can't edit it but can view a read-only copy of the file.
- Omni CMS can override locks that are initiated by a WebDAV client. When this occurs, the corresponding WebDAV client still holds the lock even though it is now invalid. However, Omni CMS correctly denies access if the WebDAV client tries to act on the (now invalidly locked) file. An exception to this is Dreamweaver allows a lock override.