diff -r b321a3be0a38 -r c743721d566f docs/html/configuration.html --- a/docs/html/configuration.html Thu Aug 03 14:32:36 2017 +0200 +++ b/docs/html/configuration.html Thu Aug 03 18:29:00 2017 +0200 @@ -43,7 +43,21 @@

dav-sync

Configuration

@@ -63,7 +77,7 @@ Example: <name>myrepo</name>

url

The url must point to a valid WebDAV compilant collection.

Type: string
+

Type: url
Example: <url>https://example.com/webdav/repo1/</url>

user

User used for authentication

@@ -138,23 +152,56 @@

Required child elements: <url>
Optional elements: <user>, <password>, <no>

url

Specifies the proxy url.

Type: url
+Example: <url>http://myproxy/</url>

user

User used for authentication with the proxy.

Type: string
+Example: <user>alice</user>

password

A base64 encoded password used for authentication.

Type: base64 string
+Example: <password>MTIzNDU2Nzg=</password>

no

A comma separated list of all hosts that should not be accessed through the proxy.

Type: string
+Example: <no>host1, host2, host3</no>

Example 1: minimal repository configuration

A minimal configuration for a repository. If no user and/or password are configured, dav prompts for authentication informations if required.

<repository>
-    <name>myrepo</name>
-    <url>https://example.com/path/to/repo/</url>
-</repository>

<configuration>
+    <repository>
+        <name>myrepo</name>
+        <url>https://example.com/path/to/repo/</url>
+    </repository>
+</configuration>

Example 2: repository with authentication informations

A typical configuration for easy accessing a repository without authentication prompt.

<repository>
-    <name>myrepo</name>
-    <url>https://example.com/path/to/repo/</url>
-    <user>alice</user>
-    <password>MTIzNDU2Nzg=</password>
-</repository>

<configuration>
+    <repository>
+        <name>myrepo</name>
+        <url>https://example.com/path/to/repo/</url>
+        <user>alice</user>
+        <password>MTIzNDU2Nzg=</password>
+    </repository>
+</configuration>

Example 3: repository with full encryption

A configuration for a full encrypted repository. Additionally to the repository a key must be configured.

<configuration>
+    <repository>
+        <name>myrepo</name>
+        <url>https://example.com/path/to/repo/</url>
+        <user>alice</user>
+        <password>MTIzNDU2Nzg=</password>
+        <full-encryption>true</full-encryption>
+    </repository>
+    
+    <key>
+        <name>mykey1</name>
+        <file>keys/mykey1</file>
+        <type>aes256</type>
+    </key>
+</configuration>