docs/html/configuration.html

Mon, 29 Jan 2024 11:19:49 +0100

author
Olaf Wintermann <olaf.wintermann@gmail.com>
date
Mon, 29 Jan 2024 11:19:49 +0100
changeset 803
008cc66ff9d6
parent 704
8b88efcbf56f
permissions
-rw-r--r--

use memset for newly created DavCfgRepository

704
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
1 <!DOCTYPE html>
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
2 <html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
3 <head>
704
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
4 <meta charset="utf-8" />
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
5 <meta name="generator" content="pandoc" />
704
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
283
0e36bb75a732 adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 273
diff changeset
7 <title>Configuration</title>
704
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
8 <style type="text/css">
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
9 code{white-space: pre-wrap;}
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
10 span.smallcaps{font-variant: small-caps;}
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
11 span.underline{text-decoration: underline;}
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
12 div.column{display: inline-block; vertical-align: top; width: 50%;}
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
13 </style>
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
14 <link rel="stylesheet" href="davdoc.css" />
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
15 <!--[if lt IE 9]>
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
16 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
17 <![endif]-->
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
18 </head>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
19 <body>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
20 <div class="header">
285
02d3e4b1245f adds some small fixes for 1.0 release
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 283
diff changeset
21 <a href="./index.html"><span>DavUtils documentation</span></a>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
22 </div>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
23 <div class="sidebar">
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
24 <div class="nav">
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
25 <h3>dav</h3>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
26 <ul>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
27 <li><a href="getting-started.html">Getting started</a></li>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
28 <li><a href="commands.html">Commands</a></li>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
29 <ul>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
30 <li><a href="list.html">list</a></li>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
31 <li><a href="get.html">get</a></li>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
32 <li><a href="put.html">put</a></li>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
33 <li><a href="mkdir.html">mkdir</a></li>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
34 <li><a href="remove.html">remove</a></li>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
35 <li><a href="copy.html">copy</a></li>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
36 <li><a href="move.html">move</a></li>
704
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
37 <li><a href="rename.html">rename</a></li>
429
1607450065ba this could be the 1.2 release
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
38 <li><a href="export.html">export</a></li>
1607450065ba this could be the 1.2 release
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
39 <li><a href="import.html">import</a></li>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
40 <li><a href="get-property.html">get-property</a></li>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
41 <li><a href="set-property.html">set-property</a></li>
320
12ed560c926c adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 307
diff changeset
42 <li><a href="remove-property.html">remove-property</a></li>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
43 <li><a href="lock.html">lock</a></li>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
44 <li><a href="unlock.html">unlock</a></li>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
45 <li><a href="info.html">info</a></li>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
46 <li><a href="date.html">date</a></li>
704
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
47 <li><a href="versioncontrol.html">versioncontrol</a></li>
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
48 <li><a href="list-versions.html">list-versions</a></li>
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
49 <li><a href="checkout.html">checkout</a></li>
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
50 <li><a href="checkin.html">checkin</a></li>
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
51 <li><a href="uncheckout.html">uncheckout</a></li>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
52 <li><a href="add-repository.html">add-repository</a></li>
429
1607450065ba this could be the 1.2 release
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
53 <li><a href="remove-repository.html">remove-repository</a></li>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
54 <li><a href="list-repositories.html">list-repositories</a></li>
704
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
55 <li><a href="repository-url.html">repository-url</a></li>
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
56 <li><a href="add-user.html">add-user</a></li>
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
57 <li><a href="remove-user.html">remove-user</a></li>
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
58 <li><a href="edit-user.html">edit-user</a></li>
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
59 <li><a href="list-users.html">list-users</a></li>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
60 <li><a href="check-config.html">check-config</a></li>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
61 </ul>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
62 <li><a href="configuration.html">Configuration</a></li>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
63 <li><a href="encryption.html">Encryption</a></li>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
64 </ul>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
65 </div>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
66 <div class="nav">
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
67 <h3>dav-sync</h3>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
68 <ul>
273
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
69 <li><a href="introduction.html">Introduction</a></li>
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
70 <li><a href="sync-commands.html">Commands</a></li>
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
71 <ul>
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
72 <li><a href="pull.html">pull</a></li>
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
73 <li><a href="push.html">push</a></li>
320
12ed560c926c adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 307
diff changeset
74 <li><a href="archive.html">archive</a></li>
704
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
75 <li><a href="restore.html">restore</a></li>
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
76 <li><a href="list-conflicts.html">list-conflicts</a></li>
273
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
77 <li><a href="resolve-conflicts.html">resolve-conflicts</a></li>
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
78 <li><a href="delete-conflicts.html">delete-conflicts</a></li>
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
79 <li><a href="trash-info.html">trash-info</a></li>
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
80 <li><a href="empty-trash.html">empty-trash</a></li>
704
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
81 <li><a href="list-versions.html">list-versions</a></li>
429
1607450065ba this could be the 1.2 release
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
82 <li><a href="add-tag.html">add-tag</a></li>
1607450065ba this could be the 1.2 release
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
83 <li><a href="remove-tag.html">remove-tag</a></li>
1607450065ba this could be the 1.2 release
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
84 <li><a href="set-tags.html">set-tags</a></li>
1607450065ba this could be the 1.2 release
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 320
diff changeset
85 <li><a href="list-tags.html">list-tags</a></li>
273
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
86 <li><a href="add-directory.html">add-directory</a></li>
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
87 <li><a href="list-directories.html">list-directories</a></li>
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
88 <li><a href="sync-check-config.html">check-config</a></li>
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
89 <li><a href="check-repositories.html">check-repositories</a></li>
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
90 </ul>
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
91 <li><a href="sync-configuration.html">Configuration</a></li>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
92 </ul>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
93 </div>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
94 </div>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
95
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
96 <!-- begin content -->
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
97 <div class="content">
704
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
98 <header>
283
0e36bb75a732 adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 273
diff changeset
99 <h1 class="title">Configuration</h1>
704
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
100 </header>
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
101 <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>
320
12ed560c926c adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 307
diff changeset
102 <p>The <em>config.xml</em> file is an XML file with <code>&lt;configuration&gt;</code> as root element. The <code>&lt;configuration&gt;</code> element can have the following child elements: <code>&lt;repository&gt;</code>, <code>&lt;http-proxy&gt;</code>, <code>&lt;https-proxy&gt;</code>, <code>&lt;key&gt;</code>, <code>&lt;namespace&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
103 <h2 id="repository">repository</h2>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
104 <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>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
105 <p>Required child elements: <code>&lt;name&gt;</code>, <code>&lt;url&gt;</code><br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
106 Optional elements: <code>&lt;user&gt;</code>, <code>&lt;password&gt;</code>, <code>&lt;default-key&gt;</code>, <code>&lt;full-encryption&gt;</code>, <code>&lt;content-encryption&gt;</code>, <code>&lt;decrypt-content&gt;</code>, <code>&lt;decrypt-name&gt;</code>, <code>&lt;cert&gt;</code>, <code>&lt;verification&gt;</code>, <code>&lt;ssl-version&gt;</code>, <code>&lt;authmethods&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
107 <h3 id="name">name</h3>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
108 <p>Unique repository identifer.</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
109 <p>Type: string<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
110 Example: <code>&lt;name&gt;myrepo&lt;/name&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
111 <h3 id="url">url</h3>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
112 <p>The url must point to a valid WebDAV compilant collection.</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
113 <p>Type: url<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
114 Example: <code>&lt;url&gt;https://example.com/webdav/repo1/&lt;/url&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
115 <h3 id="user">user</h3>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
116 <p>User used for authentication</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
117 <p>Type: string<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
118 Example: <code>&lt;user&gt;alice&lt;/user&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
119 <h3 id="password">password</h3>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
120 <p>A base64 encoded password used for authentication.</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
121 <p>Type: base64 string<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
122 Example: <code>&lt;password&gt;MTIzNDU2Nzg=&lt;/password&gt;</code></p>
704
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
123 <h3 id="stored-user">stored-user</h3>
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
124 <p>Credentials id used for authentication. The credentials must be stored in the secret store.</p>
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
125 <p>Type: string<br />
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
126 Example: <code>&lt;stored-user&gt;alice&lt;/stored-user&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
127 <h3 id="default-key">default-key</h3>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
128 <p>Identifer of the key used by default for encryption. There must be a configured key with this name.</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
129 <p>Type: string<br />
307
a4419589ea26 fixes wrong example in configuration.md
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 306
diff changeset
130 Example: <code>&lt;default-key&gt;mykey&lt;/default-key&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
131 <h3 id="full-encryption">full-encryption</h3>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
132 <p>If this element has the value of true, content and resource name encryption/decryption is enabled. Resources are only encrypted if the repository has a default-key or a key is specified via command line option. Because encryption and decryption is disabled by default, <code>false</code> has no effect for this element.</p>
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
133 <p>Type: boolean<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
134 Default: false<br />
306
4a1596b45ff2 fixes syntax error in configuration.md
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 294
diff changeset
135 Example: <code>&lt;full-encryption&gt;true&lt;/full-encryption&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
136 <h3 id="content-encryption">content-encryption</h3>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
137 <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>&lt;decrypt-content&gt;</code>.</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
138 <p>Type: boolean<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
139 Default: false<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
140 Example: <code>&lt;content-encryption&gt;true&lt;/content-encryption&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
141 <h3 id="decrypt-content">decrypt-content</h3>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
142 <p>Controls only the decryption of content. If <code>true</code> content is decrypted.</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
143 <p>Type: boolean<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
144 Default false<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
145 Example: <code>&lt;decrypt-content&gt;true&lt;/decrypt-content&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
146 <h3 id="decrypt-name">decrypt-name</h3>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
147 <p>Controls only the decryption of resource names. If <code>true</code> resource names are decrypted. This effects path to url resolution.</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
148 <p>Type: boolean<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
149 Default: false<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
150 Example: <code>&lt;decrypt-name&gt;true&lt;/decrypt-name&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
151 <h3 id="cert">cert</h3>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
152 <p>Path to a file containing certificates to verify the TLS connection to the server.</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
153 <p>Type: string<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
154 Example: <code>&lt;cert&gt;/etc/certs/cabundle.pem&lt;/cert&gt;</code></p>
704
8b88efcbf56f update html doc
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
155 <p>Note: This element does the same as curl’s <code>--cacert</code> option.</p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
156 <h3 id="verification">verification</h3>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
157 <p>This element can disable TLS certificate verification.</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
158 <p>Type: boolean<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
159 Default: true<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
160 Example: <code>&lt;verification&gt;false&lt;/verification&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
161 <h3 id="ssl-version">ssl-version</h3>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
162 <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>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
163 <p>Type: ssl version enum<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
164 Example: <code>&lt;ssl-version&gt;TLSv1.2&lt;/ssl-version&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
165 <h3 id="authmethods">authmethods</h3>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
166 <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>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
167 <p>Type: list of authmethod</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
168 <p>Default: basic<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
169 Example: <code>&lt;authmethods&gt;basic digest&lt;/authmethods&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
170 <h2 id="key">key</h2>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
171 <p>The <code>&lt;key&gt;</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>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
172 <p>Required child elements: <code>&lt;name&gt;</code>, <code>&lt;file&gt;</code><br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
173 Optional elements: <code>&lt;type&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
174 <h3 id="name-1">name</h3>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
175 <p>Unique key identifer.</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
176 <p>Type: string<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
177 Example: <code>&lt;name&gt;key1&lt;/name&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
178 <h3 id="file">file</h3>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
179 <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>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
180 <p>Type: string<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
181 Example: <code>&lt;path&gt;keys/key1.bin&lt;/path&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
182 <h3 id="type">type</h3>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
183 <p>Specifies the key type. Valid values are <code>aes128</code> or <code>aes256</code>.</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
184 <p>Type: aes type enum<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
185 Default: aes256<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
186 Example: <code>&lt;type&gt;aes128&lt;/type&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
187 <h2 id="http-proxy-https-proxy">http-proxy / https-proxy</h2>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
188 <p>Configuration for http and https proxies is the same. Both use the same elements, but https-proxy expects an https url.</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
189 <p>Required child elements: <code>&lt;url&gt;</code><br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
190 Optional elements: <code>&lt;user&gt;</code>, <code>&lt;password&gt;</code>, <code>&lt;no&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
191 <h3 id="url-1">url</h3>
273
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
192 <p>Specifies the proxy url.</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
193 <p>Type: url<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
194 Example: <code>&lt;url&gt;http://myproxy/&lt;/url&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
195 <h3 id="user-1">user</h3>
273
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
196 <p>User used for authentication with the proxy.</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
197 <p>Type: string<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
198 Example: <code>&lt;user&gt;alice&lt;/user&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
199 <h3 id="password-1">password</h3>
273
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
200 <p>A base64 encoded password used for authentication.</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
201 <p>Type: base64 string<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
202 Example: <code>&lt;password&gt;MTIzNDU2Nzg=&lt;/password&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
203 <h3 id="no">no</h3>
273
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
204 <p>A comma separated list of all hosts that should not be accessed through the proxy.</p>
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
205 <p>Type: string<br />
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
206 Example: <code>&lt;no&gt;host1, host2, host3&lt;/no&gt;</code></p>
320
12ed560c926c adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 307
diff changeset
207 <h2 id="namespace">namespace</h2>
12ed560c926c adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 307
diff changeset
208 <p>Configures an XML-namespace with prefix and uri. The prefix can be used with commands like <code>get-property</code>. The element must have the <code>prefix</code> and the <code>uri</code> attribute.</p>
12ed560c926c adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 307
diff changeset
209 <p>Type: no value Example: <code>&lt;namespace prefix=&quot;e&quot; uri=&quot;http://example.com/&quot; /&gt;</code></p>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
210 <h2 id="example-1-minimal-repository-configuration">Example 1: minimal repository configuration</h2>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
211 <p>A minimal configuration for a repository. If no user and/or password are configured, dav prompts for authentication informations if required.</p>
273
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
212 <pre><code>&lt;configuration&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
213 &lt;repository&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
214 &lt;name&gt;myrepo&lt;/name&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
215 &lt;url&gt;https://example.com/path/to/repo/&lt;/url&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
216 &lt;/repository&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
217 &lt;/configuration&gt;</code></pre>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
218 <h2 id="example-2-repository-with-authentication-informations">Example 2: repository with authentication informations</h2>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
219 <p>A typical configuration for easy accessing a repository without authentication prompt.</p>
273
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
220 <pre><code>&lt;configuration&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
221 &lt;repository&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
222 &lt;name&gt;myrepo&lt;/name&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
223 &lt;url&gt;https://example.com/path/to/repo/&lt;/url&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
224 &lt;user&gt;alice&lt;/user&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
225 &lt;password&gt;MTIzNDU2Nzg=&lt;/password&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
226 &lt;/repository&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
227 &lt;/configuration&gt;</code></pre>
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
228 <h2 id="example-3-repository-with-full-encryption">Example 3: repository with full encryption</h2>
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
229 <p>A configuration for a full encrypted repository. Additionally to the repository a key must be configured.</p>
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
230 <pre><code>&lt;configuration&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
231 &lt;repository&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
232 &lt;name&gt;myrepo&lt;/name&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
233 &lt;url&gt;https://example.com/path/to/repo/&lt;/url&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
234 &lt;user&gt;alice&lt;/user&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
235 &lt;password&gt;MTIzNDU2Nzg=&lt;/password&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
236 &lt;full-encryption&gt;true&lt;/full-encryption&gt;
294
dd5c0ebdf54f fixes dav startup without .dav dir
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 285
diff changeset
237 &lt;default-key&gt;mykey1&lt;/default-key&gt;
273
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
238 &lt;/repository&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
239
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
240 &lt;key&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
241 &lt;name&gt;mykey1&lt;/name&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
242 &lt;file&gt;keys/mykey1&lt;/file&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
243 &lt;type&gt;aes256&lt;/type&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
244 &lt;/key&gt;
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 266
diff changeset
245 &lt;/configuration&gt;</code></pre>
266
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
246 </div>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
247 <!-- end content -->
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
248 </body>
8c44c5919691 more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
249 </html>

mercurial