Fri, 01 Jun 2018 19:08:46 +0200
updates copyright notice
283
0e36bb75a732
adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
273
diff
changeset
|
1 | --- |
0e36bb75a732
adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
273
diff
changeset
|
2 | title: 'Configuration' |
0e36bb75a732
adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
273
diff
changeset
|
3 | --- |
266
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
4 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
5 | The main configuration file for *dav* is `$HOME/.dav/config.xml` and is used for configuring repositories, proxies and encryption keys. This configuration is also used by *dav-sync*. The file is created automaticaly if it doesn't exist. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
6 | |
320
12ed560c926c
adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
307
diff
changeset
|
7 | The *config.xml* file is an XML file with `<configuration>` as root element. The `<configuration>` element can have the following child elements: `<repository>`, `<http-proxy>`, `<https-proxy>`, `<key>`, `<namespace>` |
266
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
8 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
9 | ## repository |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
10 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
11 | 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. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
12 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
13 | Required child elements: `<name>`, `<url>` \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
14 | Optional elements: `<user>`, `<password>`, `<default-key>`, `<full-encryption>`, `<content-encryption>`, `<decrypt-content>`, `<decrypt-name>`, `<cert>`, `<verification>`, `<ssl-version>`, `<authmethods>` |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
15 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
16 | ### name |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
17 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
18 | Unique repository identifer. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
19 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
20 | Type: string \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
21 | Example: `<name>myrepo</name>` |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
22 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
23 | ### url |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
24 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
25 | The url must point to a valid WebDAV compilant collection. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
26 | |
273
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
27 | Type: url \ |
266
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
28 | Example: `<url>https://example.com/webdav/repo1/</url>` |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
29 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
30 | ### user |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
31 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
32 | User used for authentication |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
33 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
34 | Type: string \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
35 | Example: `<user>alice</user>` |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
36 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
37 | ### password |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
38 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
39 | A base64 encoded password used for authentication. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
40 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
41 | Type: base64 string \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
42 | Example: `<password>MTIzNDU2Nzg=</password>` |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
43 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
44 | ### default-key |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
45 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
46 | Identifer of the key used by default for encryption. There must be a configured key with this name. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
47 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
48 | Type: string \ |
307
a4419589ea26
fixes wrong example in configuration.md
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
306
diff
changeset
|
49 | Example: `<default-key>mykey</default-key>` |
266
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
50 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
51 | ### full-encryption |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
52 | |
286
8dc2952dd5dc
fixes missing default-key in example config
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
283
diff
changeset
|
53 | 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, `false` has no effect for this element. |
266
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
54 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
55 | Type: boolean \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
56 | Default: false \ |
306
4a1596b45ff2
fixes syntax error in configuration.md
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
286
diff
changeset
|
57 | Example: `<full-encryption>true</full-encryption>` |
266
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
58 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
59 | ### content-encryption |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
60 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
61 | This element enables only content encryption and decryption. A value of `false` disables content encryption, but it does not disables content decryption, if this is enabled with `<decrypt-content>`. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
62 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
63 | Type: boolean \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
64 | Default: false \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
65 | Example: `<content-encryption>true</content-encryption>` |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
66 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
67 | ### decrypt-content |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
68 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
69 | Controls only the decryption of content. If `true` content is decrypted. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
70 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
71 | Type: boolean \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
72 | Default false \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
73 | Example: `<decrypt-content>true</decrypt-content>` |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
74 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
75 | ### decrypt-name |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
76 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
77 | Controls only the decryption of resource names. If `true` resource names are decrypted. This effects path to url resolution. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
78 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
79 | Type: boolean \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
80 | Default: false \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
81 | Example: `<decrypt-name>true</decrypt-name>` |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
82 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
83 | ### cert |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
84 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
85 | Path to a file containing certificates to verify the TLS connection to the server. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
86 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
87 | Type: string \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
88 | Example: `<cert>/etc/certs/cabundle.pem</cert>` |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
89 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
90 | Note: This element does the same as curl's `--cacert` option. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
91 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
92 | ### verification |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
93 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
94 | This element can disable TLS certificate verification. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
95 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
96 | Type: boolean \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
97 | Default: true \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
98 | Example: `<verification>false</verification>` |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
99 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
100 | ### ssl-version |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
101 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
102 | 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 |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
103 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
104 | Type: ssl version enum \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
105 | Example: `<ssl-version>TLSv1.2</ssl-version>` |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
106 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
107 | ### authmethods |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
108 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
109 | 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 |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
110 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
111 | Type: list of authmethod |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
112 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
113 | Default: basic \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
114 | Example: `<authmethods>basic digest</authmethods>` |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
115 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
116 | ## key |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
117 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
118 | The `<key>` 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. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
119 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
120 | Required child elements: `<name>`, `<file>` \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
121 | Optional elements: `<type>` |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
122 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
123 | ### name |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
124 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
125 | Unique key identifer. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
126 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
127 | Type: string \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
128 | Example: `<name>key1</name>` |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
129 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
130 | ### file |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
131 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
132 | 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 *$HOME/.dav/*. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
133 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
134 | Type: string \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
135 | Example: `<path>keys/key1.bin</path>` |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
136 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
137 | ### type |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
138 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
139 | Specifies the key type. Valid values are `aes128` or `aes256`. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
140 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
141 | Type: aes type enum \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
142 | Default: aes256 \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
143 | Example: `<type>aes128</type>` |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
144 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
145 | ## http-proxy / https-proxy |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
146 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
147 | Configuration for http and https proxies is the same. Both use the same elements, but https-proxy expects an https url. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
148 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
149 | Required child elements: `<url>` \ |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
150 | Optional elements: `<user>`, `<password>`, `<no>` |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
151 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
152 | ### url |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
153 | |
273
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
154 | Specifies the proxy url. |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
155 | |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
156 | Type: url \ |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
157 | Example: `<url>http://myproxy/</url>` |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
158 | |
266
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
159 | ### user |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
160 | |
273
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
161 | User used for authentication with the proxy. |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
162 | |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
163 | Type: string \ |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
164 | Example: `<user>alice</user>` |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
165 | |
266
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
166 | ### password |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
167 | |
273
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
168 | A base64 encoded password used for authentication. |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
169 | |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
170 | Type: base64 string \ |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
171 | Example: `<password>MTIzNDU2Nzg=</password>` |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
172 | |
266
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
173 | ### no |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
174 | |
273
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
175 | A comma separated list of all hosts that should not be accessed through the proxy. |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
176 | |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
177 | Type: string \ |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
178 | Example: `<no>host1, host2, host3</no>` |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
179 | |
320
12ed560c926c
adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
307
diff
changeset
|
180 | ## namespace |
12ed560c926c
adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
307
diff
changeset
|
181 | |
12ed560c926c
adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
307
diff
changeset
|
182 | Configures an XML-namespace with prefix and uri. The prefix can be used with commands like `get-property`. The element must have the `prefix` and the `uri` attribute. |
12ed560c926c
adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
307
diff
changeset
|
183 | |
12ed560c926c
adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
307
diff
changeset
|
184 | Type: no value |
12ed560c926c
adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
307
diff
changeset
|
185 | Example: `<namespace prefix="e" uri="http://example.com/" />` |
12ed560c926c
adds documentation for new features
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
307
diff
changeset
|
186 | |
266
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
187 | ## Example 1: minimal repository configuration |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
188 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
189 | A minimal configuration for a repository. If no user and/or password are configured, dav prompts for authentication informations if required. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
190 | |
273
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
191 | <configuration> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
192 | <repository> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
193 | <name>myrepo</name> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
194 | <url>https://example.com/path/to/repo/</url> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
195 | </repository> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
196 | </configuration> |
266
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
197 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
198 | ## Example 2: repository with authentication informations |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
199 | |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
200 | A typical configuration for easy accessing a repository without authentication prompt. |
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
201 | |
273
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
202 | <configuration> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
203 | <repository> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
204 | <name>myrepo</name> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
205 | <url>https://example.com/path/to/repo/</url> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
206 | <user>alice</user> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
207 | <password>MTIzNDU2Nzg=</password> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
208 | </repository> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
209 | </configuration> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
210 | |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
211 | ## Example 3: repository with full encryption |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
212 | |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
213 | A configuration for a full encrypted repository. Additionally to the repository a key must be configured. |
266
8c44c5919691
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
214 | |
273
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
215 | <configuration> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
216 | <repository> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
217 | <name>myrepo</name> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
218 | <url>https://example.com/path/to/repo/</url> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
219 | <user>alice</user> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
220 | <password>MTIzNDU2Nzg=</password> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
221 | <full-encryption>true</full-encryption> |
286
8dc2952dd5dc
fixes missing default-key in example config
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
283
diff
changeset
|
222 | <default-key>mykey1</default-key> |
273
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
223 | </repository> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
224 | |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
225 | <key> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
226 | <name>mykey1</name> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
227 | <file>keys/mykey1</file> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
228 | <type>aes256</type> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
229 | </key> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
230 | </configuration> |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
231 |