tyler/proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
5,170 Commits 2 Branches 54 Tags 14 MiB
56d98ba966
Commit Graph

379 Commits

Author SHA1 Message Date
Dylan Whyte
dce9dd6f70 Add section "Disk Management" 
Add the section "Disk Management" to the admin guide, explaining
the use of the "disk" subcommand of "proxmox-backup-manager"

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2020-08-25 09:27:48 +02:00
Thomas Lamprecht
71c4a3138f docs: fix PBS wiki link 
rst/sphinx and comments are a PITA...

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-08-21 11:09:41 +02:00
Dylan Whyte
a8d69fcf05 Add "Benchmarking" section 
This adds the "Benchmarking" section which discusses
the proxmox-backup-client benchmark subcommand.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2020-08-18 14:24:08 +02:00
Dylan Whyte
1e68497c03 Add section describing acl tool 
This adds a section how to use the acl subcommand
to manage user access control

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2020-08-18 14:24:08 +02:00
Dylan Whyte
74fc844787 Correct erroneous instructions and add clarity 
This patch changes the following:
- Provide extra clarity to instruction and information where
  appropriate.
- Fix examples and content that would lead to erroneous behavior
  in a command.
- Insert section about installing on Debian into a caution block

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2020-08-18 14:24:08 +02:00
Dylan Whyte
4cda7603c4 minor language and formatting fixup 
this fixes minor grammatical errors throughout the pbs docs
and rewords certain sections for improved readability.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2020-08-18 14:24:08 +02:00
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
32dc4c4604 introduction: language improvement (fix typos, grammar, wording) 
Fix typos and grammatical errors.
Reword some sentences for better readability.
Clean up the list found under "Software Stack", so that it maintains a consistent
style throughout.

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-07-30 12:02:54 +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
Dylan Whyte
02f82148cf docs: pxar create: update docs to match current behavior 
This removes parts of the previous explanation of the tool that are no longer
correct, and adds an explanation of '--exclude' parameter, instead.

Adds more clarity to the command, by use of '/path/to/source' to signify
source directory.

Specify that the pattern matching style of the exclude parameter is that of
gitignore's syntax.
 2020-07-28 10:59:42 +02:00
Dylan Whyte
d12720c796 docs: epilog: point "Proxmox Backup" hyperlink to pbs wiki 
This changes the "Proxmox Backup" hyperlink, which is referred to throughout the
Proxmox Backup Server documentation. Following this patch, it now points to the
pbs wiki page, rather than the unpublished product page.

*Note: This change is only a temporary measure, while the product page
(https://www.proxmox.com/proxmox-backup) is in development.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2020-07-23 10:43:17 +02:00
Moayad Almalat
482409641f docs: remove duplicate feature 
Signed-off-by: Moayad Almalat <m.almalat@proxmox.com>
 2020-07-23 10:29:08 +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
65418a0763 docs: introduction: rewording and fixing of minor errors 
Reworded one sentence for improved readability.
Fixed some minor language errors.

Signed-off-by: Dylan Whyte <d.whyte@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
34389132d9 docs: installation: add note where to find the webinterface 
As the 8007 vs 8006 port is new and could confuse people, especially
if they did not used the PBS installer.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-07-14 07:35:59 +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
Thomas Lamprecht
e1897b363b docs: add secure-apt 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-07-10 14:12:51 +02:00
Thomas Lamprecht
33a87bc39a docs: reference PDF variant in HTML output 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-07-09 21:31:38 +02:00
Thomas Lamprecht
7ba2c1c386 docs: add initial basic software stack definition 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-07-09 17:09:05 +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
Wolfgang Bumiller
512d50a455 typos 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2020-07-09 09:34:58 +02:00
Thomas Lamprecht
b2bfb46835 docs: package repos: drop non-tests for now 
they won't work and thus just confuse people, re-add them once we're
releasing final.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-07-08 18:17:55 +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
Thomas Lamprecht
1f24d9114c docs: add missing todos 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-07-08 18:14:17 +02:00
Oguz Bektas
859fe9c1fb add local-zfs.rst 
content is > 90% same as local-zfs.adoc in pve-docs.

adapted the format for .rst

fixed some typos and wrote some parts slightly different (wording).

Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
 2020-07-08 16:49:40 +02:00
Thomas Lamprecht
067fe514e6 docs: fix repo paths 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-07-08 15:41:09 +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
Thomas Lamprecht
56b814e378 docs: add getting help section 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-07-07 13:24:39 +02:00
Thomas Lamprecht
0c136efe30 docs: features: minor wording 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-07-07 13:23:17 +02:00
Thomas Lamprecht
cdead6cd12 docs: drop initial out of context sentence 
the footer mentions sphinx and this feels weird to read as user
(which doesn't really cares what language/format the source of the
docs are in)

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-07-07 13:22:03 +02:00
Thomas Lamprecht
3a9988638b docs: move todolist to own document, don't link in release build 
It is always build for html, but not linked if the devbuild tag isn't
set. This tag is set in the Makefile if the $(BUILD_MODE) variable
isn't "release".

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-07-06 14:44:53 +02:00
Thomas Lamprecht
8a25809573 docs: sync up copyright years 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-07-04 17:57:47 +02:00
Thomas Lamprecht
d87b193b0b docs: todo: avoid leaking build details, link only 
One can just search for them... If really wanted, we could set it to
true for dev builds (i.e., no DEB_VERSION defined)

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-07-04 17:54:00 +02:00
Thomas Lamprecht
1f6a4f587a docs: do not hardcode version 
use the debian package ones, if not defined we're doing a dev build

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-07-04 17:51:58 +02:00
Thomas Lamprecht
d2c7ef09ba docs: rework and add a bit to introduction 
Contributed-by: Daniela Häsler <daniela@proxmox.com>
[ discussed and edited some parts live with me, Thomas ]
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-07-03 18:58:17 +02:00
Thomas Lamprecht
27f86f997e docs: fix index title 
Contributed-by: Daniela Häsler <daniela@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-07-03 18:57:04 +02:00
Thomas Lamprecht
5f249127b2 docs: sync version with the package versions 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-05-25 20:10:38 +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
25cf09065f docs: use OpenSans as main font 
Most people also read PDFs online ...
 2020-05-04 10:48:09 +02:00
Dietmar Maurer
fc598cdbe1 docs: use better fonts for PDFs 
Font XCharter and Lato have better quality.
 2020-05-04 10:15:27 +02:00
Dietmar Maurer
bca294a17c docs/conf.py: avoid font scale option 2020-05-04 09:02:10 +02:00
Dietmar Maurer
a02e8b1e95 docs/conf.py: fix baselineskip in code-blocks with scaled font 2020-05-03 09:22:01 +02:00
Dietmar Maurer
26d29e0ec7 pdf docs: scale down monospace font 2020-05-03 08:23:35 +02:00
Dietmar Maurer
15d74eaaf4 use xetex to generate pdf 
To correctly handle unicode art in code blocks...
 2020-05-03 07:48:55 +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
Dietmar Maurer
f40cf85212 docs/epilig.rst: remove fuse to avoid RST warnings 2020-02-28 11:55:25 +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
Christian Ebner
d58de5db19 docs: s/RUST/Rust/ 
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
 2020-01-30 07:02:50 +01:00
Fabian Grünbichler
da0e1e4021 various packaging fixes, bump version 
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
 2019-12-20 12:55:32 +01:00
Oguz Bektas
22b20d04b4 docs: fix typo in introduction.rst 
Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
 2019-12-18 17:14:58 +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
720776b81e generate separate proxmox-backup-docs package 2019-12-13 14:15:07 +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
5ab52d9a8a docs/command-syntax.rst: include catalog-shell-synopsis.rst 2019-12-06 13:46:02 +01:00
Dietmar Maurer
4bf0cc3b41 proxmox-backup-client/man1.rst: include catalog shell commands 2019-12-06 10:08:11 +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
c5ff124143 docs/Makefile: remove paper settings (we set that in conf.py) 2019-12-03 16:51:43 +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
2938a0a788 docs/installation.rst: replace FIXME with todo items 2019-12-03 08:32:03 +01:00
Dietmar Maurer
b10bf87117 docs/introduction.rst: improve "Why Backup" section. 2019-12-03 08:18:52 +01:00
Dietmar Maurer
45cc157f7c docs: add backup reader protocol 2019-11-22 06:59:37 +01:00
Dietmar Maurer
e4a5ab8ddb add pxar.1 manual page 2019-11-17 17:13:59 +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
7ee2198e3b docs/introduction.rst: improve section Architecture 2019-11-17 08:47:22 +01:00
Dietmar Maurer
bd61cafc69 docs/introduction.rst: add todo items 2019-11-16 11:50:56 +01:00
Dietmar Maurer
6a1cb69171 docs: improve introduction.rst 2019-11-16 11:43:14 +01:00
Dietmar Maurer
210cb53654 docs: enable sphinx todo items 2019-11-16 11:16:04 +01:00
Dietmar Maurer
c4f1b69f4e docs: add sysadmin.rst, cleanups 2019-11-15 13:24:45 +01:00
Dietmar Maurer
cb01363cfa docs: rename deployment-guide.rst -> administration-guide.rst 
and join with admin-guide.rst
 2019-11-15 12:35:31 +01:00
Dietmar Maurer
861f8b8f44 docs/conf.py: add exclude_pattern package-repositories.rst 
The file is inlcuded with 'include' directive. Exclude it to avoid
avoid warning about duplicate label definition.
 2019-11-15 11:55:31 +01:00
Dietmar Maurer
58ea88c8ab docs: add more ... 2019-11-13 13:10:56 +01:00
Dietmar Maurer
022b8350d9 add license for docs (GFDL) 2019-11-11 19:45:44 +01:00
Dietmar Maurer
fdd471d590 docs/introduction.rst: Add License Section (AGPL3) 2019-11-11 19:21:27 +01:00
Dietmar Maurer
2501c57c2b docs/introduction.rst: add feature Encryption, replace LZ4 with Zstandard 2019-11-11 19:07:35 +01:00
Dietmar Maurer
d2a8d597e4 introduction.rst: Add short Architecture section 2019-11-11 13:26:08 +01:00
Dietmar Maurer
7391b4cf71 package-repositories.rst: new file 2019-11-11 12:28:04 +01:00
Dietmar Maurer
028bd254ac add manual page for proxmox-backup-manager 2019-11-11 09:17:55 +01:00
Dietmar Maurer
177db84b82 docs/backup-protocol.rst: add backup protocol docs 2019-06-04 17:33:12 +02:00
Dietmar Maurer
164d961729 docs/index.rst: cleanup 2019-03-19 12:22:57 +01:00
Dietmar Maurer
998b827a5d start file format docu 2019-03-16 16:44:45 +01:00
Dietmar Maurer
d49746481c docs: remove generated-index.rst and search-page.rst 
This does not work as expected.
 2019-03-05 18:36:22 +01:00
Dietmar Maurer
b933ed7f80 docs: add manual page for proxmox-backup-proxy 2019-03-05 18:14:48 +01:00
Dietmar Maurer
b246b2a635 docs: define author and version inside epilog.rst 2019-03-05 17:42:48 +01:00
Dietmar Maurer
59b9c7ef5a docs: add support link 2019-03-02 18:23:48 +01:00
Dietmar Maurer
6253aa50a3 docs: add "What is Proxmox Backup" 2019-03-02 18:08:00 +01:00
Dietmar Maurer
0c56b0e693 docs: improve section "Why Backup" 2019-03-02 17:51:18 +01:00
Dietmar Maurer
efd3e76bda docs: add more features 2019-03-02 16:56:01 +01:00
Dietmar Maurer
3147e56a74 docs: add epilog.rst to define common things. 2019-03-02 10:31:32 +01:00
Dietmar Maurer
1757747836 docs/glossary.rst: add hyperlinks 2019-02-28 19:23:48 +01:00
Dietmar Maurer
d823802ea1 docs: add glossary.rst 2019-02-28 19:09:55 +01:00
Dietmar Maurer
f13c36c856 docs: use exclude_pattern instead of :orphan: 
Seems rst2man cannot handle :orphan:
 2019-02-28 16:28:53 +01:00
Dietmar Maurer
7e688b7149 docs: improve ducument structure 2019-02-27 18:35:05 +01:00
Dietmar Maurer
7ef486ae06 build doc with sphinx 2019-02-27 17:42:31 +01:00
Dietmar Maurer
2e05a1ca7d docs/Makefile: fix make dependency 2019-02-24 16:19:39 +01:00
Dietmar Maurer
f0b5a3adfa docs/proxmox-backup.rst: start writing docs 2019-02-24 15:52:04 +01:00
Dietmar Maurer
bb5c770758 start generating manual pages 
Depend on docutils-doc
 2019-02-24 10:18:38 +01:00