Commit Graph

51 Commits

Author SHA1 Message Date
Dietmar Maurer 747c3bc087 administration-guide.rst: move Encryption headline up one level 2020-08-07 07:10:12 +02:00
Dietmar Maurer c23e257c5a administration-guide.rst: fix headline (avoid compile error) 2020-08-07 06:56:58 +02:00
Dylan Whyte 16a18dadba admin-guide: add section explaining master keys
Adds a section under encryption which goes into detail on how to
use a master key to store and recover backup encryption keys.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2020-08-07 06:54:37 +02:00
Dylan Whyte a83674ad48 administration-guide: fix typo that breaks example command
The ' ' (space) between 'etc/ **/*.txt' resulted in the example command's output
not matching the given example output. Removing this space fixes the command.
2020-07-28 10:59:53 +02:00
Thomas Lamprecht 0c1c492d48 docs: fix some typos
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-21 13:01:21 +02:00
Thomas Lamprecht 255ed62166 docs: GC followup
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-21 12:58:47 +02:00
Aaron Lauterer 8314ca9c10 docs: fix #2851 Add note about GC grace period
Adding a note about the garbage collection's grace period due to the
default atime behavior should help to avoid confusion as to why space is
not freed immediately.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2020-07-21 12:51:41 +02:00
Thomas Lamprecht 538c2b6dcf followup: fixup the directory number, refactor
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-20 14:39:02 +02:00
Stoiko Ivanov e9b44bec01 docs: add note on supported filesystems
certain filesystems cannot be used as chunkstores, because they don't
support 2^16 subdirectories (e.g. ext4 with certain features disabled
or ext3 - see ext4(5))

reported via our community forum:
https://forum.proxmox.com/threads/emlink-too-many-links.73108/

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2020-07-20 14:10:39 +02:00
Dylan Whyte aef4976801 docs: admin guide: fix grammatical errors and improve English
Mostly fixed typos and grammatical errors.
Improved wording in some sections to make instructions/advice clearer.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2020-07-20 14:10:39 +02:00
Thomas Lamprecht 78ee20d72d docs: fix typo s/PBS_REPOSTOR/PBS_REPOSITOR/
Reported-by: Piotr Paszkowski aka patefoniQ
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-13 19:23:50 +02:00
Stoiko Ivanov 22231524e2 docs: expand datastore documentation
document retention settings and schedules per datastore with
some minimal examples.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2020-07-09 15:04:26 +02:00
Stoiko Ivanov 9634ca07db docs: add remotes and sync-jobs and schedules
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
2020-07-09 15:04:26 +02:00
Thomas Lamprecht 24406ebc0c docs: move host sysadmin out to own chapter, fix ZFS one
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-07-08 18:15:33 +02:00
Oguz Bektas 8c6e5ce23c improve administration guide
fixing some typos and grammar errors.

added example file layout for datastores.

Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
2020-07-08 14:20:49 +02:00
Dietmar Maurer a66d5898a1 docs/administration-guide.rst: fix prune command output 2020-05-05 07:24:27 +02:00
Dietmar Maurer 96feecd621 administration-guide.rst: update snapshot list output 2020-05-04 13:14:03 +02:00
Dietmar Maurer f9dcfa4149 administration-guide.rst: add section "Proxmox VE integration" 2020-05-04 12:41:38 +02:00
Dietmar Maurer 26d29e0ec7 pdf docs: scale down monospace font 2020-05-03 08:23:35 +02:00
Dietmar Maurer 8df51d4852 administration-guide.rst: add role definitions 2020-05-02 16:40:20 +02:00
Dietmar Maurer 8f3b3cc1f9 administration-guide.rst: add example to disable/remove a user 2020-05-02 11:21:05 +02:00
Dietmar Maurer 17ec699d79 administration-guide.rst: start user management docs 2020-05-02 11:11:36 +02:00
Aaron Lauterer 4f3db187cf Docu: first proof reading
This is a first proof reading of the currently existing documentation.

fixes (hopefully all):
* spelling
* grammar

Tries to increase readabilty and ease of understanding by simplifying
and restructing some sentences and paragraphs. Filler words which add
to the cognitive load but don't add anything are removed
(most notably `also`).
2020-04-15 06:52:59 +02:00
Dietmar Maurer 53ea655669 docs/administration-guide.rst: add small section to explain output-format 2020-02-28 12:26:39 +01:00
Christian Ebner cee53b34df docs: add documentation for pxar
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2020-02-25 10:49:20 +01:00
Christian Ebner e899d33e49 docs: fix typo
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2020-02-20 10:16:51 +01:00
Christian Ebner 50b8f9dd67 docs: Add documentation for .pxarexclude files
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2020-02-20 10:16:28 +01:00
Dietmar Maurer 3243f93ce7 administration-guide.rst: documnet new PBS_FINGERPRINT env var 2020-02-11 12:06:02 +01:00
Christian Ebner f0188322ed docs: fix typos
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2020-01-31 07:05:52 +01:00
Christian Ebner c7971d7f8f docs: Add documentation for mounting pxar archives via FUSE.
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2020-01-31 07:05:40 +01:00
Christian Ebner 3f0983b7a3 docs: Extend documentation on interactive restore with catalog shell.
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2020-01-30 07:02:50 +01:00
Dietmar Maurer 3c50a9d82e administration-guide.rst: fix catalog command syntax 2019-12-18 12:58:18 +01:00
Dietmar Maurer 236a396aa1 src/api2/admin/datastore.rs - prune: log retention options 2019-12-14 16:32:16 +01:00
Dietmar Maurer e1c356ec06 docs/administration-guide.rst: document garbage collection 2019-12-14 15:52:25 +01:00
Dietmar Maurer 102d8d4136 src/backup/prune.rs: implement --keep-hourly 2019-12-07 11:23:33 +01:00
Dietmar Maurer 1af6637004 docs/administration-guide.rst: add hint about ISO week date 2019-12-07 10:45:43 +01:00
Dietmar Maurer 84322d8c75 docs/administration-guide.rst: doc prune --dry-run 2019-12-06 19:20:05 +01:00
Dietmar Maurer 02d22dec4d docs/administration-guide.rst: explain how prune handles uncomplete backups 2019-12-05 11:27:42 +01:00
Dietmar Maurer 52b2be979d docs/administration-guide.rst: improve prune docs 2019-12-05 09:43:46 +01:00
Dietmar Maurer 6e5a0c03fa docs/administration-guide.rst: add prune docs 2019-12-04 13:46:57 +01:00
Dietmar Maurer ac456d85e8 docs/administration-guide.rst: describe login/logout 2019-12-04 10:47:41 +01:00
Dietmar Maurer ed858b0af4 docs/administration-guide.rst: minor cleanups 2019-12-03 16:58:34 +01:00
Dietmar Maurer 64b85116eb docs/administration-guide.rst: explain restore 2019-12-03 16:19:30 +01:00
Dietmar Maurer 5a499f3281 docs/administration-guide.rst: add encryption section 2019-12-03 15:24:04 +01:00
Dietmar Maurer a129fdd9cc docs/administration-guide.rst: improve section "Creating Backups" 2019-12-03 11:59:00 +01:00
Dietmar Maurer 57905a61b1 docs/administration-guide.rst: improve section "Backup Content" 2019-12-03 09:04:49 +01:00
Dietmar Maurer 85e139b70f docs/administration-guide.rs: add 'Backup Content' section. 2019-11-17 16:51:40 +01:00
Dietmar Maurer fea8789cba docs/administration-guide.rst: add section termonology 2019-11-17 09:55:21 +01:00
Dietmar Maurer 85325c2502 docs/administration-guide.rs: move sysadmin.rst to the end 2019-11-17 09:09:51 +01:00
Dietmar Maurer c4f1b69f4e docs: add sysadmin.rst, cleanups 2019-11-15 13:24:45 +01:00