tyler/proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: add token example to client, and reformat a bit

Browse Source 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2020-10-30 17:01:18 +01:00
parent 034cf70b72
commit 4aef06f1b6
2 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/backup-client.rst
View File

@ -12,31 +12,31 @@ on the backup server.
[[username@]server[:port]:]datastore [[username@]server[:port]:]datastore
The default value for ``username`` is ``root@pam``. If no server is specified, The default value for ``username`` is ``root@pam``. If no server is specified,
the default is the local host (``localhost``). the default is the local host (``localhost``).
You can specify a port if your backup server is only reachable on a different You can specify a port if your backup server is only reachable on a different
port (e.g. with NAT and port forwarding). port (e.g. with NAT and port forwarding).
Note that if the server is an IPv6 address, you have to write it with Note that if the server is an IPv6 address, you have to write it with square
square brackets (e.g. [fe80::01]). brackets (for example, `[fe80::01]`).
You can pass the repository with the ``--repository`` command You can pass the repository with the ``--repository`` command line option, or
line option, or by setting the ``PBS_REPOSITORY`` environment by setting the ``PBS_REPOSITORY`` environment variable.
variable.
Here some examples of valid repositories and the real values Here some examples of valid repositories and the real values
================================ ============ ================== =========== ================================ ================= ================== ===========
Example User Host:Port Datastore Example User Host:Port Datastore
================================ ============ ================== =========== ================================ ================= ================== ===========
mydatastore ``root@pam`` localhost:8007 mydatastore mydatastore ``root@pam`` localhost:8007 mydatastore
myhostname:mydatastore ``root@pam`` myhostname:8007 mydatastore myhostname:mydatastore ``root@pam`` myhostname:8007 mydatastore
user@pbs@myhostname:mydatastore ``user@pbs`` myhostname:8007 mydatastore user@pbs@myhostname:mydatastore ``user@pbs`` myhostname:8007 mydatastore
192.168.55.55:1234:mydatastore ``root@pam`` 192.168.55.55:1234 mydatastore user@pbs!token@host:store ``user@pbs!token`` myhostname:8007 mydatastore
[ff80::51]:mydatastore ``root@pam`` [ff80::51]:8007 mydatastore 192.168.55.55:1234:mydatastore ``root@pam`` 192.168.55.55:1234 mydatastore
[ff80::51]:1234:mydatastore ``root@pam`` [ff80::51]:1234 mydatastore [ff80::51]:mydatastore ``root@pam`` [ff80::51]:8007 mydatastore
================================ ============ ================== =========== [ff80::51]:1234:mydatastore ``root@pam`` [ff80::51]:1234 mydatastore
================================ ================= ================== ===========
Environment Variables Environment Variables
--------------------- ---------------------
@ -45,16 +45,16 @@ Environment Variables
The default backup repository. The default backup repository.
``PBS_PASSWORD`` ``PBS_PASSWORD``
When set, this value is used for the password required for the When set, this value is used for the password required for the backup server.
backup server. You can also set this to a API token secret.
``PBS_ENCRYPTION_PASSWORD`` ``PBS_ENCRYPTION_PASSWORD``
When set, this value is used to access the secret encryption key (if When set, this value is used to access the secret encryption key (if
protected by password). protected by password).
``PBS_FINGERPRINT`` When set, this value is used to verify the server ``PBS_FINGERPRINT`` When set, this value is used to verify the server
certificate (only used if the system CA certificates cannot certificate (only used if the system CA certificates cannot validate the
validate the certificate). certificate).
Output Format Output Format

2
docs/user-management.rst
View File

@ -102,7 +102,7 @@ API tokens serve two purposes:
An API token consists of two parts: an identifier consisting of the user name, An API token consists of two parts: an identifier consisting of the user name,
the realm and a tokenname (``user@realm!tokenname``), and a secret value. Both the realm and a tokenname (``user@realm!tokenname``), and a secret value. Both
need to be provided to the client in place of the user ID (``user@realm``) and need to be provided to the client in place of the user ID (``user@realm``) and
the user password. the user password, respectively.
The API token is passed from the client to the server by setting the The API token is passed from the client to the server by setting the
``Authorization`` HTTP header with method ``PBSAPIToken`` to the value ``Authorization`` HTTP header with method ``PBSAPIToken`` to the value