comparison: docs/html/configuration.html
docs/html/configuration.html
- changeset 273
- c743721d566f
- parent 266
- 8c44c5919691
- child 283
- 0e36bb75a732
equal
deleted
inserted
replaced
| 272:b321a3be0a38 | 273:c743721d566f |
|---|---|
| 41 </ul> | 41 </ul> |
| 42 </div> | 42 </div> |
| 43 <div class="nav"> | 43 <div class="nav"> |
| 44 <h3>dav-sync</h3> | 44 <h3>dav-sync</h3> |
| 45 <ul> | 45 <ul> |
| 46 <li><a href=".">.</a></li> | 46 <li><a href="introduction.html">Introduction</a></li> |
| 47 <li><a href="sync-commands.html">Commands</a></li> | |
| 48 <ul> | |
| 49 <li><a href="pull.html">pull</a></li> | |
| 50 <li><a href="push.html">push</a></li> | |
| 51 <li><a href="resolve-conflicts.html">resolve-conflicts</a></li> | |
| 52 <li><a href="delete-conflicts.html">delete-conflicts</a></li> | |
| 53 <li><a href="trash-info.html">trash-info</a></li> | |
| 54 <li><a href="empty-trash.html">empty-trash</a></li> | |
| 55 <li><a href="add-directory.html">add-directory</a></li> | |
| 56 <li><a href="list-directories.html">list-directories</a></li> | |
| 57 <li><a href="sync-check-config.html">check-config</a></li> | |
| 58 <li><a href="check-repositories.html">check-repositories</a></li> | |
| 59 </ul> | |
| 60 <li><a href="sync-configuration.html">Configuration</a></li> | |
| 47 </ul> | 61 </ul> |
| 48 </div> | 62 </div> |
| 49 </div> | 63 </div> |
| 50 | 64 |
| 51 <!-- begin content --> | 65 <!-- begin content --> |
| 61 <p>Unique repository identifer.</p> | 75 <p>Unique repository identifer.</p> |
| 62 <p>Type: string<br /> | 76 <p>Type: string<br /> |
| 63 Example: <code><name>myrepo</name></code></p> | 77 Example: <code><name>myrepo</name></code></p> |
| 64 <h3 id="url">url</h3> | 78 <h3 id="url">url</h3> |
| 65 <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> |
| 66 <p>Type: string<br /> | 80 <p>Type: url<br /> |
| 67 Example: <code><url>https://example.com/webdav/repo1/</url></code></p> | 81 Example: <code><url>https://example.com/webdav/repo1/</url></code></p> |
| 68 <h3 id="user">user</h3> | 82 <h3 id="user">user</h3> |
| 69 <p>User used for authentication</p> | 83 <p>User used for authentication</p> |
| 70 <p>Type: string<br /> | 84 <p>Type: string<br /> |
| 71 Example: <code><user>alice</user></code></p> | 85 Example: <code><user>alice</user></code></p> |
| 136 <h2 id="http-proxy-https-proxy">http-proxy / https-proxy</h2> | 150 <h2 id="http-proxy-https-proxy">http-proxy / https-proxy</h2> |
| 137 <p>Configuration for http and https proxies is the same. Both use the same elements, but https-proxy expects an https url.</p> | 151 <p>Configuration for http and https proxies is the same. Both use the same elements, but https-proxy expects an https url.</p> |
| 138 <p>Required child elements: <code><url></code><br /> | 152 <p>Required child elements: <code><url></code><br /> |
| 139 Optional elements: <code><user></code>, <code><password></code>, <code><no></code></p> | 153 Optional elements: <code><user></code>, <code><password></code>, <code><no></code></p> |
| 140 <h3 id="url-1">url</h3> | 154 <h3 id="url-1">url</h3> |
| 155 <p>Specifies the proxy url.</p> | |
| 156 <p>Type: url<br /> | |
| 157 Example: <code><url>http://myproxy/</url></code></p> | |
| 141 <h3 id="user-1">user</h3> | 158 <h3 id="user-1">user</h3> |
| 159 <p>User used for authentication with the proxy.</p> | |
| 160 <p>Type: string<br /> | |
| 161 Example: <code><user>alice</user></code></p> | |
| 142 <h3 id="password-1">password</h3> | 162 <h3 id="password-1">password</h3> |
| 163 <p>A base64 encoded password used for authentication.</p> | |
| 164 <p>Type: base64 string<br /> | |
| 165 Example: <code><password>MTIzNDU2Nzg=</password></code></p> | |
| 143 <h3 id="no">no</h3> | 166 <h3 id="no">no</h3> |
| 167 <p>A comma separated list of all hosts that should not be accessed through the proxy.</p> | |
| 168 <p>Type: string<br /> | |
| 169 Example: <code><no>host1, host2, host3</no></code></p> | |
| 144 <h2 id="example-1-minimal-repository-configuration">Example 1: minimal repository configuration</h2> | 170 <h2 id="example-1-minimal-repository-configuration">Example 1: minimal repository configuration</h2> |
| 145 <p>A minimal configuration for a repository. If no user and/or password are configured, dav prompts for authentication informations if required.</p> | 171 <p>A minimal configuration for a repository. If no user and/or password are configured, dav prompts for authentication informations if required.</p> |
| 146 <pre><code><repository> | 172 <pre><code><configuration> |
| 147 <name>myrepo</name> | 173 <repository> |
| 148 <url>https://example.com/path/to/repo/</url> | 174 <name>myrepo</name> |
| 149 </repository></code></pre> | 175 <url>https://example.com/path/to/repo/</url> |
| 176 </repository> | |
| 177 </configuration></code></pre> | |
| 150 <h2 id="example-2-repository-with-authentication-informations">Example 2: repository with authentication informations</h2> | 178 <h2 id="example-2-repository-with-authentication-informations">Example 2: repository with authentication informations</h2> |
| 151 <p>A typical configuration for easy accessing a repository without authentication prompt.</p> | 179 <p>A typical configuration for easy accessing a repository without authentication prompt.</p> |
| 152 <pre><code><repository> | 180 <pre><code><configuration> |
| 153 <name>myrepo</name> | 181 <repository> |
| 154 <url>https://example.com/path/to/repo/</url> | 182 <name>myrepo</name> |
| 155 <user>alice</user> | 183 <url>https://example.com/path/to/repo/</url> |
| 156 <password>MTIzNDU2Nzg=</password> | 184 <user>alice</user> |
| 157 </repository></code></pre> | 185 <password>MTIzNDU2Nzg=</password> |
| 186 </repository> | |
| 187 </configuration></code></pre> | |
| 188 <h2 id="example-3-repository-with-full-encryption">Example 3: repository with full encryption</h2> | |
| 189 <p>A configuration for a full encrypted repository. Additionally to the repository a key must be configured.</p> | |
| 190 <pre><code><configuration> | |
| 191 <repository> | |
| 192 <name>myrepo</name> | |
| 193 <url>https://example.com/path/to/repo/</url> | |
| 194 <user>alice</user> | |
| 195 <password>MTIzNDU2Nzg=</password> | |
| 196 <full-encryption>true</full-encryption> | |
| 197 </repository> | |
| 198 | |
| 199 <key> | |
| 200 <name>mykey1</name> | |
| 201 <file>keys/mykey1</file> | |
| 202 <type>aes256</type> | |
| 203 </key> | |
| 204 </configuration></code></pre> | |
| 158 </div> | 205 </div> |
| 159 <!-- end content --> | 206 <!-- end content --> |
| 160 </body> | 207 </body> |
| 161 </html> | 208 </html> |
