comparison: docs/html/configuration.html
docs/html/configuration.html
- changeset 285
- 02d3e4b1245f
- parent 283
- 0e36bb75a732
- child 294
- dd5c0ebdf54f
equal
deleted
inserted
replaced
| 284:8e7ef0675946 | 285:02d3e4b1245f |
|---|---|
| 8 <style type="text/css">code{white-space: pre;}</style> | 8 <style type="text/css">code{white-space: pre;}</style> |
| 9 <link rel="stylesheet" href="davdoc.css" type="text/css" /> | 9 <link rel="stylesheet" href="davdoc.css" type="text/css" /> |
| 10 </head> | 10 </head> |
| 11 <body> | 11 <body> |
| 12 <div class="header"> | 12 <div class="header"> |
| 13 <span>davutils documentation</span> | 13 <a href="./index.html"><span>DavUtils documentation</span></a> |
| 14 </div> | 14 </div> |
| 15 <div class="sidebar"> | 15 <div class="sidebar"> |
| 16 <div class="nav"> | 16 <div class="nav"> |
| 17 <h3>dav</h3> | 17 <h3>dav</h3> |
| 18 <ul> | 18 <ul> |
| 69 </div> | 69 </div> |
| 70 <p>The main configuration file for <em>dav</em> is <code>$HOME/.dav/config.xml</code> and is used for configuring repositories, proxies and encryption keys. This configuration is also used by <em>dav-sync</em>. The file is created automaticaly if it doesn't exist.</p> | 70 <p>The main configuration file for <em>dav</em> is <code>$HOME/.dav/config.xml</code> and is used for configuring repositories, proxies and encryption keys. This configuration is also used by <em>dav-sync</em>. The file is created automaticaly if it doesn't exist.</p> |
| 71 <p>The <em>config.xml</em> file is an XML file with <code><configuration></code> as root element. The <code><configuration></code> element can have the following child elements: <code><repository></code>, <code><http-proxy></code>, <code><https-proxy></code>, <code><key></code></p> | 71 <p>The <em>config.xml</em> file is an XML file with <code><configuration></code> as root element. The <code><configuration></code> element can have the following child elements: <code><repository></code>, <code><http-proxy></code>, <code><https-proxy></code>, <code><key></code></p> |
| 72 <h2 id="repository">repository</h2> | 72 <h2 id="repository">repository</h2> |
| 73 <p>This element is used to configure a repository. A repository must have a unique name to identify the repository and a url pointing to the root collection for this repository.</p> | 73 <p>This element is used to configure a repository. A repository must have a unique name to identify the repository and a url pointing to the root collection for this repository.</p> |
| 74 <p>Required child elements: <code><name></code>, <code><url></code><br /> | 74 <p>Required child elements: <code><name></code>, <code><url></code><br />Optional elements: <code><user></code>, <code><password></code>, <code><default-key></code>, <code><full-encryption></code>, <code><content-encryption></code>, <code><decrypt-content></code>, <code><decrypt-name></code>, <code><cert></code>, <code><verification></code>, <code><ssl-version></code>, <code><authmethods></code></p> |
| 75 Optional elements: <code><user></code>, <code><password></code>, <code><default-key></code>, <code><full-encryption></code>, <code><content-encryption></code>, <code><decrypt-content></code>, <code><decrypt-name></code>, <code><cert></code>, <code><verification></code>, <code><ssl-version></code>, <code><authmethods></code></p> | |
| 76 <h3 id="name">name</h3> | 75 <h3 id="name">name</h3> |
| 77 <p>Unique repository identifer.</p> | 76 <p>Unique repository identifer.</p> |
| 78 <p>Type: string<br /> | 77 <p>Type: string<br />Example: <code><name>myrepo</name></code></p> |
| 79 Example: <code><name>myrepo</name></code></p> | |
| 80 <h3 id="url">url</h3> | 78 <h3 id="url">url</h3> |
| 81 <p>The url must point to a valid WebDAV compilant collection.</p> | 79 <p>The url must point to a valid WebDAV compilant collection.</p> |
| 82 <p>Type: url<br /> | 80 <p>Type: url<br />Example: <code><url>https://example.com/webdav/repo1/</url></code></p> |
| 83 Example: <code><url>https://example.com/webdav/repo1/</url></code></p> | |
| 84 <h3 id="user">user</h3> | 81 <h3 id="user">user</h3> |
| 85 <p>User used for authentication</p> | 82 <p>User used for authentication</p> |
| 86 <p>Type: string<br /> | 83 <p>Type: string<br />Example: <code><user>alice</user></code></p> |
| 87 Example: <code><user>alice</user></code></p> | |
| 88 <h3 id="password">password</h3> | 84 <h3 id="password">password</h3> |
| 89 <p>A base64 encoded password used for authentication.</p> | 85 <p>A base64 encoded password used for authentication.</p> |
| 90 <p>Type: base64 string<br /> | 86 <p>Type: base64 string<br />Example: <code><password>MTIzNDU2Nzg=</password></code></p> |
| 91 Example: <code><password>MTIzNDU2Nzg=</password></code></p> | |
| 92 <h3 id="default-key">default-key</h3> | 87 <h3 id="default-key">default-key</h3> |
| 93 <p>Identifer of the key used by default for encryption. There must be a configured key with this name.</p> | 88 <p>Identifer of the key used by default for encryption. There must be a configured key with this name.</p> |
| 94 <p>Type: string<br /> | 89 <p>Type: string<br />Example: <code><key>mykey</key></code></p> |
| 95 Example: <code><key>mykey</key></code></p> | |
| 96 <h3 id="full-encryption">full-encryption</h3> | 90 <h3 id="full-encryption">full-encryption</h3> |
| 97 <p>If this element has the value of true, content and resource name encryption/decryption is enabled. Because encryption and decryption is disabled by default, <code>false</code> has no effect for this element.</p> | 91 <p>If this element has the value of true, content and resource name encryption/decryption is enabled. Because encryption and decryption is disabled by default, <code>false</code> has no effect for this element.</p> |
| 98 <p>Type: boolean<br /> | 92 <p>Type: boolean<br />Default: false<br />Example: `<full-encryption>true</full-encryption></p> |
| 99 Default: false<br /> | |
| 100 Example: `<full-encryption>true</full-encryption></p> | |
| 101 <h3 id="content-encryption">content-encryption</h3> | 93 <h3 id="content-encryption">content-encryption</h3> |
| 102 <p>This element enables only content encryption and decryption. A value of <code>false</code> disables content encryption, but it does not disables content decryption, if this is enabled with <code><decrypt-content></code>.</p> | 94 <p>This element enables only content encryption and decryption. A value of <code>false</code> disables content encryption, but it does not disables content decryption, if this is enabled with <code><decrypt-content></code>.</p> |
| 103 <p>Type: boolean<br /> | 95 <p>Type: boolean<br />Default: false<br />Example: <code><content-encryption>true</content-encryption></code></p> |
| 104 Default: false<br /> | |
| 105 Example: <code><content-encryption>true</content-encryption></code></p> | |
| 106 <h3 id="decrypt-content">decrypt-content</h3> | 96 <h3 id="decrypt-content">decrypt-content</h3> |
| 107 <p>Controls only the decryption of content. If <code>true</code> content is decrypted.</p> | 97 <p>Controls only the decryption of content. If <code>true</code> content is decrypted.</p> |
| 108 <p>Type: boolean<br /> | 98 <p>Type: boolean<br />Default false<br />Example: <code><decrypt-content>true</decrypt-content></code></p> |
| 109 Default false<br /> | |
| 110 Example: <code><decrypt-content>true</decrypt-content></code></p> | |
| 111 <h3 id="decrypt-name">decrypt-name</h3> | 99 <h3 id="decrypt-name">decrypt-name</h3> |
| 112 <p>Controls only the decryption of resource names. If <code>true</code> resource names are decrypted. This effects path to url resolution.</p> | 100 <p>Controls only the decryption of resource names. If <code>true</code> resource names are decrypted. This effects path to url resolution.</p> |
| 113 <p>Type: boolean<br /> | 101 <p>Type: boolean<br />Default: false<br />Example: <code><decrypt-name>true</decrypt-name></code></p> |
| 114 Default: false<br /> | |
| 115 Example: <code><decrypt-name>true</decrypt-name></code></p> | |
| 116 <h3 id="cert">cert</h3> | 102 <h3 id="cert">cert</h3> |
| 117 <p>Path to a file containing certificates to verify the TLS connection to the server.</p> | 103 <p>Path to a file containing certificates to verify the TLS connection to the server.</p> |
| 118 <p>Type: string<br /> | 104 <p>Type: string<br />Example: <code><cert>/etc/certs/cabundle.pem</cert></code></p> |
| 119 Example: <code><cert>/etc/certs/cabundle.pem</cert></code></p> | |
| 120 <p>Note: This element does the same as curl's <code>--cacert</code> option.</p> | 105 <p>Note: This element does the same as curl's <code>--cacert</code> option.</p> |
| 121 <h3 id="verification">verification</h3> | 106 <h3 id="verification">verification</h3> |
| 122 <p>This element can disable TLS certificate verification.</p> | 107 <p>This element can disable TLS certificate verification.</p> |
| 123 <p>Type: boolean<br /> | 108 <p>Type: boolean<br />Default: true<br />Example: <code><verification>false</verification></code></p> |
| 124 Default: true<br /> | |
| 125 Example: <code><verification>false</verification></code></p> | |
| 126 <h3 id="ssl-version">ssl-version</h3> | 109 <h3 id="ssl-version">ssl-version</h3> |
| 127 <p>Specifies the SSL version to attempt to use. The value must be one of this strings: TLSv1, TLSv1.0, TLSv1.1, TLSv1.2, SSLv2, SSLv3</p> | 110 <p>Specifies the SSL version to attempt to use. The value must be one of this strings: TLSv1, TLSv1.0, TLSv1.1, TLSv1.2, SSLv2, SSLv3</p> |
| 128 <p>Type: ssl version enum<br /> | 111 <p>Type: ssl version enum<br />Example: <code><ssl-version>TLSv1.2</ssl-version></code></p> |
| 129 Example: <code><ssl-version>TLSv1.2</ssl-version></code></p> | |
| 130 <h3 id="authmethods">authmethods</h3> | 112 <h3 id="authmethods">authmethods</h3> |
| 131 <p>Controls which http authentication methods are used. Multiple methods can be used. The value must be one or more authentication methods separated by space. Valid authentication methods are: basic, digest, negotiate, ntlm, any, none</p> | 113 <p>Controls which http authentication methods are used. Multiple methods can be used. The value must be one or more authentication methods separated by space. Valid authentication methods are: basic, digest, negotiate, ntlm, any, none</p> |
| 132 <p>Type: list of authmethod</p> | 114 <p>Type: list of authmethod</p> |
| 133 <p>Default: basic<br /> | 115 <p>Default: basic<br />Example: <code><authmethods>basic digest</authmethods></code></p> |
| 134 Example: <code><authmethods>basic digest</authmethods></code></p> | |
| 135 <h2 id="key">key</h2> | 116 <h2 id="key">key</h2> |
| 136 <p>The <code><key></code> element configures a key used for encryption. A key must have a unique name, which is stored in the properties of encrypted resources. To decrypt resources, dav looks for configured keys with this name, therefore the name of the key should never changed and must be the same on all hosts accessing the same repository.</p> | 117 <p>The <code><key></code> element configures a key used for encryption. A key must have a unique name, which is stored in the properties of encrypted resources. To decrypt resources, dav looks for configured keys with this name, therefore the name of the key should never changed and must be the same on all hosts accessing the same repository.</p> |
| 137 <p>Required child elements: <code><name></code>, <code><file></code><br /> | 118 <p>Required child elements: <code><name></code>, <code><file></code><br />Optional elements: <code><type></code></p> |
| 138 Optional elements: <code><type></code></p> | |
| 139 <h3 id="name-1">name</h3> | 119 <h3 id="name-1">name</h3> |
| 140 <p>Unique key identifer.</p> | 120 <p>Unique key identifer.</p> |
| 141 <p>Type: string<br /> | 121 <p>Type: string<br />Example: <code><name>key1</name></code></p> |
| 142 Example: <code><name>key1</name></code></p> | |
| 143 <h3 id="file">file</h3> | 122 <h3 id="file">file</h3> |
| 144 <p>Path to the content of the key. The file should contain 32 (aes256) or 16 (aes128) bytes. If value is not an absolut path, it must be relative to the dav config directory <em>$HOME/.dav/</em>.</p> | 123 <p>Path to the content of the key. The file should contain 32 (aes256) or 16 (aes128) bytes. If value is not an absolut path, it must be relative to the dav config directory <em>$HOME/.dav/</em>.</p> |
| 145 <p>Type: string<br /> | 124 <p>Type: string<br />Example: <code><path>keys/key1.bin</path></code></p> |
| 146 Example: <code><path>keys/key1.bin</path></code></p> | |
| 147 <h3 id="type">type</h3> | 125 <h3 id="type">type</h3> |
| 148 <p>Specifies the key type. Valid values are <code>aes128</code> or <code>aes256</code>.</p> | 126 <p>Specifies the key type. Valid values are <code>aes128</code> or <code>aes256</code>.</p> |
| 149 <p>Type: aes type enum<br /> | 127 <p>Type: aes type enum<br />Default: aes256<br />Example: <code><type>aes128</type></code></p> |
| 150 Default: aes256<br /> | |
| 151 Example: <code><type>aes128</type></code></p> | |
| 152 <h2 id="http-proxy-https-proxy">http-proxy / https-proxy</h2> | 128 <h2 id="http-proxy-https-proxy">http-proxy / https-proxy</h2> |
| 153 <p>Configuration for http and https proxies is the same. Both use the same elements, but https-proxy expects an https url.</p> | 129 <p>Configuration for http and https proxies is the same. Both use the same elements, but https-proxy expects an https url.</p> |
| 154 <p>Required child elements: <code><url></code><br /> | 130 <p>Required child elements: <code><url></code><br />Optional elements: <code><user></code>, <code><password></code>, <code><no></code></p> |
| 155 Optional elements: <code><user></code>, <code><password></code>, <code><no></code></p> | |
| 156 <h3 id="url-1">url</h3> | 131 <h3 id="url-1">url</h3> |
| 157 <p>Specifies the proxy url.</p> | 132 <p>Specifies the proxy url.</p> |
| 158 <p>Type: url<br /> | 133 <p>Type: url<br />Example: <code><url>http://myproxy/</url></code></p> |
| 159 Example: <code><url>http://myproxy/</url></code></p> | |
| 160 <h3 id="user-1">user</h3> | 134 <h3 id="user-1">user</h3> |
| 161 <p>User used for authentication with the proxy.</p> | 135 <p>User used for authentication with the proxy.</p> |
| 162 <p>Type: string<br /> | 136 <p>Type: string<br />Example: <code><user>alice</user></code></p> |
| 163 Example: <code><user>alice</user></code></p> | |
| 164 <h3 id="password-1">password</h3> | 137 <h3 id="password-1">password</h3> |
| 165 <p>A base64 encoded password used for authentication.</p> | 138 <p>A base64 encoded password used for authentication.</p> |
| 166 <p>Type: base64 string<br /> | 139 <p>Type: base64 string<br />Example: <code><password>MTIzNDU2Nzg=</password></code></p> |
| 167 Example: <code><password>MTIzNDU2Nzg=</password></code></p> | |
| 168 <h3 id="no">no</h3> | 140 <h3 id="no">no</h3> |
| 169 <p>A comma separated list of all hosts that should not be accessed through the proxy.</p> | 141 <p>A comma separated list of all hosts that should not be accessed through the proxy.</p> |
| 170 <p>Type: string<br /> | 142 <p>Type: string<br />Example: <code><no>host1, host2, host3</no></code></p> |
| 171 Example: <code><no>host1, host2, host3</no></code></p> | |
| 172 <h2 id="example-1-minimal-repository-configuration">Example 1: minimal repository configuration</h2> | 143 <h2 id="example-1-minimal-repository-configuration">Example 1: minimal repository configuration</h2> |
| 173 <p>A minimal configuration for a repository. If no user and/or password are configured, dav prompts for authentication informations if required.</p> | 144 <p>A minimal configuration for a repository. If no user and/or password are configured, dav prompts for authentication informations if required.</p> |
| 174 <pre><code><configuration> | 145 <pre><code><configuration> |
| 175 <repository> | 146 <repository> |
| 176 <name>myrepo</name> | 147 <name>myrepo</name> |
