EditLive! 9 Documentation : realm

WebDAV support has been removed in EditLive! 9.1

This element contains the settings required for a user to authenticate themselves to a realm on a Web server. EditLive! supports the following forms of Web server authentication:

Basic
Digest
NTLM

Configuration Element Tree Structure

<editLive>
     ...
     <authentication>
          <realm ... />
     </authentication>
     ...
</editLive>

Required Attributes

realm

The realm for which this authentication information applies. For basic and digest authentication the realm is specified in the Web server configuration; in NTLM authentication the realm is equivalent to the host name.

For NTLM authentication, the realm attribute should contain the value of the host to be accessed. For example, if the URL for the protected area was http://www.yourserver.com/webDAV and this required NTLM authentication, then the realm attribute would be www.yourserver.com (i.e. realm="www.yourserver.com").

Optional Attributes

domain

The domain on which the specified realm can be accessed.

This attribute is not needed when using either the basic or digest authentication types.

password

The password to be used when accessing the realm.

username

The username to be used when accessing the realm.

Examples

This example demonstrates how to configure the <realm> element for use with a basic or digest authentication method. In this example the realm being accessed is the protected realm. The username to be used is EditLive and the corresponding password is Ephox.

<editLive>
    ...
    <authentication>
        <realm realm="protected" 
            username="EditLive" 
            password="Ephox" />
    </authentication>
    ...
</editLive>

This example demonstrates how to configure the <realm> element for use with a NTLM authentication method. In this example the protected area being accessed is designated by the URL http://yourserver.com/protected and thus resides on the yourserver.com host which can be found on the intranet network domain. The username to be used is EditLive and the corresponding password is Ephox.

<editLive>
    ...
    <authentication>
        <realm realm="yourserver.com" 
            domain="intranet"
            username="EditLive" 
            password="Ephox"        
        />
    </authentication>
    ...
</editLive>

Remarks

The <realm> element can appear multiple times within the <authentication> element.

The <realm> element must be a complete tag; it cannot contain a tag body. Therefore, the tag must be closed in the same line. See the example below:

<realm realm=... />

In the case of all the authentication details not being provided in the configuration file, the end user will be prompted for the details required. The details provided in the configuration file, if any, will be supplied to the end user when prompted. For example, if only the username and domain are supplied by the configuration file, the end user will be prompted and will only have to supply the correct password.