tyler/proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
6,534 Commits 2 Branches 54 Tags 14 MiB
e87e4499fd
Commit Graph

452 Commits

Author SHA1 Message Date
Thomas Lamprecht
e87e4499fd docs: fix some typos 
The s/Namesapce/Namespace/ one was reported in the forum [0] and so I
figured I do a quick scan for others too using codespell.

[0]: https://forum.proxmox.com/threads/109724/post-472744

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-26 13:08:52 +02:00
Thomas Lamprecht
f71a4ce6d6 docs: client usage: add some hints for namespace 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-17 13:55:21 +02:00
Thomas Lamprecht
a3b1026753 docs: some textwidth cleanups 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-17 13:55:04 +02:00
Thomas Lamprecht
2e9a9f94a4 update online help reference info 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-17 13:30:11 +02:00
Thomas Lamprecht
ed9797d67e storage: add some initial namespace docs 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-17 13:29:02 +02:00
Thomas Lamprecht
56f0ce27ac docs: storage: refer to options 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-17 13:28:50 +02:00
Thomas Lamprecht
67d4131158 docs: basic maintenance mode section 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-17 13:28:24 +02:00
Thomas Lamprecht
acbb19498a docs: also mention Sync in heading of Managing Remotes 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-17 13:28:05 +02:00
Thomas Lamprecht
187ec50488 docs: refer more to screenshots all over the place 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-17 13:27:37 +02:00
Thomas Lamprecht
b3116e5680 docs: update and add screenshots 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-17 13:27:09 +02:00
Thomas Lamprecht
14f140d1c5 docs: storage: show gui disk management screenshot 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-17 09:47:56 +02:00
Thomas Lamprecht
1d592668ac docs: update/add some screenshots 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-17 09:47:56 +02:00
Thomas Lamprecht
2c0fae66b3 docs: certs: fix odd image referencing and drop duplicate usage 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-16 19:27:06 +02:00
Stoiko Ivanov
cbd7db1d7f docs: certificates 
manually adapt to differences between PMG and PBS

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
 2022-05-16 19:27:06 +02:00
Stoiko Ivanov
6189b956b6 docs: add certificate-management.rst 
the file certificate-managment.rst is generated from the pmg-docs repo

by running:
```
asciidoc -b $(pwd)/asciidoc/pmg-docbook \
-f asciidoc/asciidoc-pmg.conf -o - pmg-ssl-certificate.adoc | \
pandoc -f docbook -t rst --shift-heading-level-by=1 \
-o certificate-mangement-auto.rst

sed -ri 's/__/_/' certificate-mangement-auto.rst
sed -ri 's/\{pmg\}/`Proxmox Backup`_/g' certificate-mangement-auto.rst
sed -ri 's/\{PMG\}/`Proxmox Backup`_/g' certificate-mangement-auto.rst
sed -ri 's/Proxmox Mail Gateway/`Proxmox Backup`_/g' \
certificate-mangement-auto.rst
sed -ri 's/pmg-([a-zA-Z0-9_-]*).png/pbs-\1.png/g' \
certificate-mangement-auto.rst
sed -ri 's/pmgproxy/proxmox-backup-proxy/g' \
certificate-mangement-auto.rst
sed -ri 's/pmgconfig/proxmox-backup-manager/g' \
certificate-mangement-auto.rst
sed -ri 's/pmg-daily/proxmox-backup-daily-update/g' \
certificate-mangement-auto.rst
sed -ri 's/\/etc\/pmg\/node.conf/\/etc\/proxmox-backup\/node.cfg/g' \
certificate-mangement-auto.rst
sed -ri 's/\/etc\/pmg\/acme/\/etc\/proxmox-backup\/acme/g' \
certificate-mangement-auto.rst
sed -ri \
's/\/etc\/pmg\/pmg-api.pem/\/etc\/proxmox-backup\/proxy.pem/g' \
certificate-mangement-auto.rst
sed -ri 's/screenshot/screenshots/g' certificate-mangement-auto.rst

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
 2022-05-16 19:27:06 +02:00
Thomas Lamprecht
c2add820a4 docs: add certificate related screenshots 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-16 19:27:06 +02:00
Stoiko Ivanov
e1dc2d2210 docs: use case-matching keys for glossary 
this silences warnings a la:
```
WARNING: term container not found in case sensitive match.made a
reference to Container instead
```
the issue is purely cosmetic during build, and should vanish in a newer
version of sphinx-doc [0].

[0] https://github.com/sphinx-doc/sphinx/issues/7636

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
 2022-05-16 19:27:06 +02:00
Stoiko Ivanov
bffc923420 docs: cleanup and readd command-line-tools 
the collection of descriptions of our cli tools was dropped in
04e24b14f0

I'll readd it to the sysadmin.rst, since the (related) service daemons
also got moved here.

additionally add the newly added cli-tools to both
command-line-tools.rst and command-syntax.rst, and put both in the same
order

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
 2022-05-16 19:27:06 +02:00
Stoiko Ivanov
c760a67278 docs: silence duplicate label warnings. 
by reindroducing the trailing ',' after local-zfs.rst
and adding the missing 'traffic-control.rst' to the list
of files/patterns to be excluded.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
 2022-05-16 19:27:06 +02:00
Thomas Lamprecht
067c77329b docs: acl path: add a namespace related example 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-16 18:10:13 +02:00
Fabian Grünbichler
8c4131708a docs: add namespace section to sync documentation 
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
 2022-05-16 18:09:15 +02:00
Thomas Lamprecht
44df558d66 docs: terminology: add namespaces and slightly restructure 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-16 15:28:00 +02:00
Thomas Lamprecht
1d9ba1cc8b docs: add "Objects and Paths" section and fix perm scrot 
we show the add-user one twice in this chapter, one should actually
be add-permission

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-16 10:56:19 +02:00
Thomas Lamprecht
597398cb48 docs: rework access control, list available privileges 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-05-16 08:00:40 +02:00
Dominik Csapak
74391d1c32 docs: tape: add information about namespaces 
which are backed up, how to use the new parameters and how to map
them during restore

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
 2022-05-13 15:45:17 +02:00
Dominik Csapak
fca84a4b94 docs: tape/restore: mention single snapshot restore 
what it is, how to use it and the caveats

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
 2022-05-13 15:45:17 +02:00
Dominik Csapak
602319f9fc docs: tape: remove note about global content namespace 
that is actually not true, we save the datastore in the chunk archives
as well as the snapshot archives, otherwise we could not backup
multiple datastores to a single media-set.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
 2022-05-13 15:45:17 +02:00
Stoiko Ivanov
5225817de6 docs: zfs: update documentation about ZED 
This closely follows commit aa425868069818167ff0a3cca5c64a2acc88173e
in pve-docs.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
 2022-05-12 10:08:30 +02:00
Stoiko Ivanov
0ae5f76277 docs: local-zfs: minor cleanup and adaptation 
fixes a few small glitches in the markup.

rephrases a few PVEisms (PBS will not swap when starting a backup to
an external storage)

add zstd to available compression algorithms

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
 2022-05-12 10:08:30 +02:00
Stoiko Ivanov
09d903034f docs: system-booting: (re)add screenshots 
add the grub+systemdboot screen from a PBS system (taken via
spice-viewer).

The alingment of left/right looked better to me than keeping both on the
right).

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
 2022-05-12 10:08:30 +02:00
Stoiko Ivanov
9eb804006c docs: add system-booting from pve-docs 
and transform to reST.

semantic changes to the content are:
* s/{pve}/`Proxmox Backup`_/g
* changing footnotes to parenthesized notes (did not see footnote use in
  the current docs)
* removed the comment about systems setup before the introduction of
  p-b-t (which was introduced before pbs)

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
 2022-05-12 10:08:30 +02:00
Stoiko Ivanov
6e3391c85b docs: sysadmin: adapt kernel-specifics for PBS 
while all statements here are technically true - adding all
virtualization improvements is not relevant for proxmox backup in most
cases.
The intel nic driver seems like a left-over from a time (pre PVE 5.1)
where the pve-kernel included the out-of-tree drivers.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
 2022-05-12 10:08:30 +02:00
Stefan Sterz
684a402931 fix #3067: docs: add markdown primer from pve to pbs 
this copies the markdown primer from the pve docs to allow access to
it via the help buttons in the gui

Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>
 2022-04-25 08:39:39 +02:00
Fabian Ebner
b2df21bb02 docs: client: file exclusion: add note about leading slash 
It's not documented yet and not intuitive:
https://forum.proxmox.com/threads/98810
https://forum.proxmox.com/threads/107143

Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
 2022-04-06 16:59:00 +02:00
Stefan Sterz
171a00ca97 tape, docs, api: fix miscellaneous typos 
Signed-off-by: Stefan Sterz <s.sterz@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-03-11 12:52:06 +01:00
Thomas Lamprecht
eb080f361a docs: tape: minor wording tweaks 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-03-09 10:44:37 +01:00
Dominik Csapak
bd0300917e docs: improve tape-backup examples 
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
 2022-03-09 10:44:37 +01:00
Dominik Csapak
9c96e5368a docs: add tape schedule examples 
just a few examples how one could configure tape pools and jobs.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
 2022-03-01 08:10:53 +01:00
Dominik Csapak
83b5076dce docs: explain retention time for event allocation policy in more detail 
'when the calendar event' triggers was too vague, it could mean for
the current media-set or the next time. Apart from that, it was not
technically correct all the time, since we take the start time of
the next media set if that exists first.

The idea here is that we begin the retention when the media set is
finished.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
 2022-03-01 08:08:18 +01:00
Matthias Heiserer
b0427dda76 docs: fix typo in tape backup 
Signed-off-by: Matthias Heiserer <m.heiserer@proxmox.com>
 2022-02-03 13:12:02 +01:00
Thomas Lamprecht
c10a6755f0 docs: fix some typos 
the `congestion` typo has been mentioned in the forum:
https://forum.proxmox.com/threads/proxmox-backup-server-2-1-released.100240/#post-443370

fixed a few surrounding ones and ones that `codespell` found in
addition to that.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2022-01-12 15:19:59 +01:00
Dominik Csapak
149b969d9a docs: remotes: note that protected flags will not be synced 
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
 2021-11-23 13:53:03 +01:00
Dominik Csapak
56d3b59c71 docs: backup-client: fix wrong ':ref:' 
there is no 'backup server' reference we can link to here, and it would
not make sense anyway.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
 2021-11-23 13:53:03 +01:00
Thomas Lamprecht
4954d3130b docs: add/update tc related screenshots & content, document tc for sync-job 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-11-22 16:05:22 +01:00
Dietmar Maurer
e201104d0b docs: update traffic control docs (use HumanBytes) 
Signed-off-by: Dietmar Maurer <dietmar@proxmox.com>
 2021-11-22 09:07:05 +01:00
Thomas Lamprecht
df32530750 docs: remote sync: adapt to changed filter param and add some examples 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-11-18 10:40:19 +01:00
Fabian Grünbichler
01ae7bfaf2 docs: mention group filter in sync docs 
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
Reviewed-by: Dominik Csapak <d.csapak@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-11-18 10:36:57 +01:00
Dietmar Maurer
96ec3801a9 docs: add traffic control section 
Signed-off-by: Dietmar Maurer <dietmar@proxmox.com>
 2021-11-15 13:43:11 +01:00
Dylan Whyte
2bc1250c28 docs: language fixup: faq and appendix 
minor formatting and language fixes to the faq section and the appendix

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2021-11-02 07:12:07 +01:00
Dominik Csapak
38517ca053 docs: add info about protection flag to client docs 
and mention that sync/pull does not sync the protected flag

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2021-10-28 11:31:32 +02:00