docs/html/configuration.html

changeset 273
c743721d566f
parent 266
8c44c5919691
child 283
0e36bb75a732
--- 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 @@
 	<div class="nav">
 		<h3>dav-sync</h3>
 			<ul>
-				<li><a href=".">.</a></li>
+				<li><a href="introduction.html">Introduction</a></li>
+				<li><a href="sync-commands.html">Commands</a></li>
+					<ul>
+						<li><a href="pull.html">pull</a></li>
+						<li><a href="push.html">push</a></li>
+						<li><a href="resolve-conflicts.html">resolve-conflicts</a></li>
+						<li><a href="delete-conflicts.html">delete-conflicts</a></li>
+						<li><a href="trash-info.html">trash-info</a></li>
+						<li><a href="empty-trash.html">empty-trash</a></li>
+						<li><a href="add-directory.html">add-directory</a></li>
+						<li><a href="list-directories.html">list-directories</a></li>
+						<li><a href="sync-check-config.html">check-config</a></li>
+						<li><a href="check-repositories.html">check-repositories</a></li>
+					</ul>
+				<li><a href="sync-configuration.html">Configuration</a></li>
 			</ul>
 	</div>
 </div>
@@ -63,7 +77,7 @@
 Example: <code>&lt;name&gt;myrepo&lt;/name&gt;</code></p>
 <h3 id="url">url</h3>
 <p>The url must point to a valid WebDAV compilant collection.</p>
-<p>Type: string<br />
+<p>Type: url<br />
 Example: <code>&lt;url&gt;https://example.com/webdav/repo1/&lt;/url&gt;</code></p>
 <h3 id="user">user</h3>
 <p>User used for authentication</p>
@@ -138,23 +152,56 @@
 <p>Required child elements: <code>&lt;url&gt;</code><br />
 Optional elements: <code>&lt;user&gt;</code>, <code>&lt;password&gt;</code>, <code>&lt;no&gt;</code></p>
 <h3 id="url-1">url</h3>
+<p>Specifies the proxy url.</p>
+<p>Type: url<br />
+Example: <code>&lt;url&gt;http://myproxy/&lt;/url&gt;</code></p>
 <h3 id="user-1">user</h3>
+<p>User used for authentication with the proxy.</p>
+<p>Type: string<br />
+Example: <code>&lt;user&gt;alice&lt;/user&gt;</code></p>
 <h3 id="password-1">password</h3>
+<p>A base64 encoded password used for authentication.</p>
+<p>Type: base64 string<br />
+Example: <code>&lt;password&gt;MTIzNDU2Nzg=&lt;/password&gt;</code></p>
 <h3 id="no">no</h3>
+<p>A comma separated list of all hosts that should not be accessed through the proxy.</p>
+<p>Type: string<br />
+Example: <code>&lt;no&gt;host1, host2, host3&lt;/no&gt;</code></p>
 <h2 id="example-1-minimal-repository-configuration">Example 1: minimal repository configuration</h2>
 <p>A minimal configuration for a repository. If no user and/or password are configured, dav prompts for authentication informations if required.</p>
-<pre><code>&lt;repository&gt;
-    &lt;name&gt;myrepo&lt;/name&gt;
-    &lt;url&gt;https://example.com/path/to/repo/&lt;/url&gt;
-&lt;/repository&gt;</code></pre>
+<pre><code>&lt;configuration&gt;
+    &lt;repository&gt;
+        &lt;name&gt;myrepo&lt;/name&gt;
+        &lt;url&gt;https://example.com/path/to/repo/&lt;/url&gt;
+    &lt;/repository&gt;
+&lt;/configuration&gt;</code></pre>
 <h2 id="example-2-repository-with-authentication-informations">Example 2: repository with authentication informations</h2>
 <p>A typical configuration for easy accessing a repository without authentication prompt.</p>
-<pre><code>&lt;repository&gt;
-    &lt;name&gt;myrepo&lt;/name&gt;
-    &lt;url&gt;https://example.com/path/to/repo/&lt;/url&gt;
-    &lt;user&gt;alice&lt;/user&gt;
-    &lt;password&gt;MTIzNDU2Nzg=&lt;/password&gt;
-&lt;/repository&gt;</code></pre>
+<pre><code>&lt;configuration&gt;
+    &lt;repository&gt;
+        &lt;name&gt;myrepo&lt;/name&gt;
+        &lt;url&gt;https://example.com/path/to/repo/&lt;/url&gt;
+        &lt;user&gt;alice&lt;/user&gt;
+        &lt;password&gt;MTIzNDU2Nzg=&lt;/password&gt;
+    &lt;/repository&gt;
+&lt;/configuration&gt;</code></pre>
+<h2 id="example-3-repository-with-full-encryption">Example 3: repository with full encryption</h2>
+<p>A configuration for a full encrypted repository. Additionally to the repository a key must be configured.</p>
+<pre><code>&lt;configuration&gt;
+    &lt;repository&gt;
+        &lt;name&gt;myrepo&lt;/name&gt;
+        &lt;url&gt;https://example.com/path/to/repo/&lt;/url&gt;
+        &lt;user&gt;alice&lt;/user&gt;
+        &lt;password&gt;MTIzNDU2Nzg=&lt;/password&gt;
+        &lt;full-encryption&gt;true&lt;/full-encryption&gt;
+    &lt;/repository&gt;
+    
+    &lt;key&gt;
+        &lt;name&gt;mykey1&lt;/name&gt;
+        &lt;file&gt;keys/mykey1&lt;/file&gt;
+        &lt;type&gt;aes256&lt;/type&gt;
+    &lt;/key&gt;
+&lt;/configuration&gt;</code></pre>
 </div>
 <!-- end content -->
 </body>

mercurial