Sat, 22 Jun 2019 16:36:52 +0200
move some properties to new namespace
for properties encryption we need to decide which props must be encrypted and the plan is, to decide by namespace
283
0e36bb75a732
adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
282
diff
changeset
|
1 | --- |
0e36bb75a732
adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
282
diff
changeset
|
2 | title: 'Getting started' |
0e36bb75a732
adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
282
diff
changeset
|
3 | --- |
265
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
4 | |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
5 | ### Test |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
6 | |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
7 | After successful installation you can test dav with your WebDAV server. |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
8 | |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
9 | dav list http://example.com/webdav/ |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
10 | |
282
3070d72f54af
more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
11 | This lists all child resources of the specified collection. If you are unfamiliar to WebDAV terminology this means basically listing all files in a directory, similar to the ls unix tool. Actually you can also write `dav ls` instead of `dav list` and there is also an `-l` option similarly to the unix tool `ls`. |
265
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
12 | |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
13 | ### Create a repository |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
14 | |
282
3070d72f54af
more minor improvements to the documentation
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
15 | All dav commands are expecting an url argument, but it may be a bit cumbersome to type a full url every time. But you can configure a repository in the dav configuration file ($HOME/.dav/config.xml) with the servers url, optional authentication information and other options. Afterwards you can access a webdav server just with the repository name and an optional path. |
265
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
16 | |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
17 | So when you have created a repository with the name myserv and the url http://example.com/webdav/, you can just type |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
18 | |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
19 | dav list myserv |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
20 | |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
21 | You can add a path to the repository name to access an other url |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
22 | |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
23 | dav list myserv/mycollection/ |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
24 | |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
25 | This lists the content of http://example.com/webdav/mycollection/ |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
26 | |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
27 | The easiest way to create a repository is with the add-repository command. This is a simple configuration assistant. |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
28 | |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
29 | $ dav add-repository |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
30 | Each repository must have an unique name. |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
31 | name: myserv |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
32 | |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
33 | Specify the repository base url. |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
34 | url: http://example.com/webdav/ |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
35 | |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
36 | User for HTTP authentication. |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
37 | user (optional): myuser |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
38 | password (optional): |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
39 | |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
40 | |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
41 | Added repository: myserv (http://example.com/webdav/) |
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
42 | |
273
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
43 | You can also configure the config.xml yourself, check out [the config.xml spec][1]. |
265
ee9e63c437c4
adds documentation for most dav commands
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff
changeset
|
44 | |
273
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
45 | [1]: ./configuration.html |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
265
diff
changeset
|
46 |