Thu, 19 Jul 2018 16:43:39 +0200
small help text adjustment
283
0e36bb75a732
adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
276
diff
changeset
|
1 | --- |
0e36bb75a732
adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
276
diff
changeset
|
2 | title: 'dav add-repository' |
0e36bb75a732
adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
276
diff
changeset
|
3 | --- |
273
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
4 | |
276
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
5 | This command runs an interactive assistant that creates a repository [configuration][1] and adds it to the config.xml file. |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
6 | |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
7 | [1]: ./configuration.html |
273
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
8 | |
c743721d566f
more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
266
diff
changeset
|
9 | **Command alias:** add-repo |
276
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
10 | |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
11 | The assistant firstly asks for a unique repository name. |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
12 | If you are not sure, which names are already in use, you can get a list of currently present repositories with [dav list-repositories][2]. |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
13 | Then you specifiy the base URL and optional authentication information. |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
14 | Please keep in mind, that the password is stored base64 encoded in your configuration. |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
15 | If you do not want this to happen, leave the password blank. |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
16 | `dav` will ask you for the password when accessing the repository. |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
17 | Beware that you don't use password prompt in background jobs, though. |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
18 | A call of `add-repository` may look like this. |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
19 | |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
20 | $ dav add-repository |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
21 | Each repository must have an unique name. |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
22 | name: myfirstrepo |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
23 | |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
24 | Specify the repository base url. |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
25 | url: https://mynas.local/webdav |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
26 | |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
27 | User for HTTP authentication. |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
28 | user (optional): mywebuser |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
29 | password (optional): |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
30 | |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
31 | [2]: ./list-repositories.html |
20a176d5a53e
adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents:
273
diff
changeset
|
32 |