comparison: docs/src/configuration.md
docs/src/configuration.md
- changeset 273
- c743721d566f
- parent 266
- 8c44c5919691
- child 283
- 0e36bb75a732
equal
deleted
inserted
replaced
| 272:b321a3be0a38 | 273:c743721d566f |
|---|---|
| 21 | 21 |
| 22 ### url | 22 ### url |
| 23 | 23 |
| 24 The url must point to a valid WebDAV compilant collection. | 24 The url must point to a valid WebDAV compilant collection. |
| 25 | 25 |
| 26 Type: string \ | 26 Type: url \ |
| 27 Example: `<url>https://example.com/webdav/repo1/</url>` | 27 Example: `<url>https://example.com/webdav/repo1/</url>` |
| 28 | 28 |
| 29 ### user | 29 ### user |
| 30 | 30 |
| 31 User used for authentication | 31 User used for authentication |
| 148 Required child elements: `<url>` \ | 148 Required child elements: `<url>` \ |
| 149 Optional elements: `<user>`, `<password>`, `<no>` | 149 Optional elements: `<user>`, `<password>`, `<no>` |
| 150 | 150 |
| 151 ### url | 151 ### url |
| 152 | 152 |
| 153 Specifies the proxy url. | |
| 154 | |
| 155 Type: url \ | |
| 156 Example: `<url>http://myproxy/</url>` | |
| 157 | |
| 153 ### user | 158 ### user |
| 154 | 159 |
| 160 User used for authentication with the proxy. | |
| 161 | |
| 162 Type: string \ | |
| 163 Example: `<user>alice</user>` | |
| 164 | |
| 155 ### password | 165 ### password |
| 156 | 166 |
| 167 A base64 encoded password used for authentication. | |
| 168 | |
| 169 Type: base64 string \ | |
| 170 Example: `<password>MTIzNDU2Nzg=</password>` | |
| 171 | |
| 157 ### no | 172 ### no |
| 173 | |
| 174 A comma separated list of all hosts that should not be accessed through the proxy. | |
| 175 | |
| 176 Type: string \ | |
| 177 Example: `<no>host1, host2, host3</no>` | |
| 158 | 178 |
| 159 ## Example 1: minimal repository configuration | 179 ## Example 1: minimal repository configuration |
| 160 | 180 |
| 161 A minimal configuration for a repository. If no user and/or password are configured, dav prompts for authentication informations if required. | 181 A minimal configuration for a repository. If no user and/or password are configured, dav prompts for authentication informations if required. |
| 162 | 182 |
| 163 <repository> | 183 <configuration> |
| 164 <name>myrepo</name> | 184 <repository> |
| 165 <url>https://example.com/path/to/repo/</url> | 185 <name>myrepo</name> |
| 166 </repository> | 186 <url>https://example.com/path/to/repo/</url> |
| 187 </repository> | |
| 188 </configuration> | |
| 167 | 189 |
| 168 ## Example 2: repository with authentication informations | 190 ## Example 2: repository with authentication informations |
| 169 | 191 |
| 170 A typical configuration for easy accessing a repository without authentication prompt. | 192 A typical configuration for easy accessing a repository without authentication prompt. |
| 171 | 193 |
| 172 <repository> | 194 <configuration> |
| 173 <name>myrepo</name> | 195 <repository> |
| 174 <url>https://example.com/path/to/repo/</url> | 196 <name>myrepo</name> |
| 175 <user>alice</user> | 197 <url>https://example.com/path/to/repo/</url> |
| 176 <password>MTIzNDU2Nzg=</password> | 198 <user>alice</user> |
| 177 </repository> | 199 <password>MTIzNDU2Nzg=</password> |
| 178 | 200 </repository> |
| 201 </configuration> | |
| 202 | |
| 203 ## Example 3: repository with full encryption | |
| 204 | |
| 205 A configuration for a full encrypted repository. Additionally to the repository a key must be configured. | |
| 206 | |
| 207 <configuration> | |
| 208 <repository> | |
| 209 <name>myrepo</name> | |
| 210 <url>https://example.com/path/to/repo/</url> | |
| 211 <user>alice</user> | |
| 212 <password>MTIzNDU2Nzg=</password> | |
| 213 <full-encryption>true</full-encryption> | |
| 214 </repository> | |
| 215 | |
| 216 <key> | |
| 217 <name>mykey1</name> | |
| 218 <file>keys/mykey1</file> | |
| 219 <type>aes256</type> | |
| 220 </key> | |
| 221 </configuration> | |
| 222 |
