Dietmar Maurer
cf95f616c5
add missing file docs/api-viewer/index.html
2021-02-21 10:04:23 +01:00
Dietmar Maurer
1adbc7c13c
docs: install API viewer
2021-02-21 09:06:58 +01:00
Dietmar Maurer
9d28974c27
adopt PVEAPI.js for PBS, rename to PBSAPI.js
2021-02-21 09:06:58 +01:00
Dietmar Maurer
3dbc35b5c1
copy api-viewer from pve-docs
2021-02-21 09:06:58 +01:00
Dietmar Maurer
7ca0ba4515
tape: add tape-job.cfg manual page
2021-02-15 07:05:39 +01:00
Thomas Lamprecht
70dc2ff3ab
docs/barcode: eslint auto-fixes
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-13 14:49:16 +01:00
Dietmar Maurer
81f5d03e8d
docs: update benchmark results
2021-02-13 10:52:19 +01:00
Dietmar Maurer
28eaff20bd
docs: fix target refs in user-management.rst
2021-02-13 10:23:02 +01:00
Dietmar Maurer
8d1a1b2976
docs: conv.py - add man pages to exclude_patterns
...
To avoid sphinx warnings.
2021-02-13 10:16:41 +01:00
Dietmar Maurer
92eaec53db
docs: add proxmox-backup service description
2021-02-13 09:48:21 +01:00
Dietmar Maurer
b3c2c57897
docs: add services.rst to section sysadmin
2021-02-13 09:40:36 +01:00
Dietmar Maurer
f458e97fda
docs: split out output-format.rst
2021-02-13 08:54:23 +01:00
Dietmar Maurer
80bf9ae99b
docs: add short descriptions for main binaries.
2021-02-13 08:43:54 +01:00
Dietmar Maurer
bebd4a7ca4
tape: generate proxmox-tape.1 manual page
2021-02-12 18:00:01 +01:00
Dietmar Maurer
9468e94412
tape: add pmt and pmtx command to tape-backup.rst
2021-02-12 17:45:55 +01:00
Dietmar Maurer
6b66c8507f
lto-barcode: fix page offset calibration
2021-02-12 13:34:19 +01:00
Dietmar Maurer
167e5406c3
Makefile: fix typo (s/madia-pool/media-pool/)
2021-02-12 12:18:25 +01:00
Dietmar Maurer
c111c9a931
tape: add manual page for tape.cfg
2021-02-12 12:09:08 +01:00
Dietmar Maurer
bb71e3a023
tape: add manual page for media-pool.cfg
2021-02-12 11:50:56 +01:00
Dietmar Maurer
96bcfb9b1f
docs: add hint how to edit/modify the datastore.cfg file
2021-02-11 14:20:16 +01:00
Dietmar Maurer
5b7f44555e
docs: add manual page for verification.cfg
2021-02-11 13:40:11 +01:00
Dietmar Maurer
2ca396c015
docs: add manual page for acl.cfg
2021-02-11 13:13:34 +01:00
Dietmar Maurer
d8dae16035
docs: add manual page fro sysc.cfg
2021-02-11 11:52:37 +01:00
Dietmar Maurer
6279b8f5a5
docs: add manukal page for remote.cfg
2021-02-11 11:25:15 +01:00
Dietmar Maurer
67cc79ec52
docs: add user.cfg.5 manual page
2021-02-10 16:51:05 +01:00
Dietmar Maurer
b9a09a9501
docs: add "Configuration Files" appendix
2021-02-10 11:28:56 +01:00
Dietmar Maurer
4a0d3a3e3f
docs: add datastore.cfg.5 man page
2021-02-10 11:05:02 +01:00
Dietmar Maurer
6477ebcf6f
copyright: adopt year
2021-02-10 09:56:33 +01:00
Dietmar Maurer
b22a9c14a4
docs: disable smartquotes
2021-02-09 08:36:09 +01:00
Dietmar Maurer
73a1da5ed6
pmt: document driver options
2021-02-08 08:34:31 +01:00
Dietmar Maurer
fbf8779388
doc: improve pmt/pmtx manual pages
2021-02-06 16:50:56 +01:00
Dietmar Maurer
3231c35fb8
doc: fix problems in pxar manual page
...
- Avoid doubled title (Description/Description)
- Avoid error with sphinx :ref: role
2021-02-06 16:21:36 +01:00
Aaron Lauterer
777690a121
docs/scanrefs: fix handling if ref is same as headline
...
If the ref is named the same as the headline (once normalized), sphinx
will return a 'idX' value in node['ids'][1] which we use for the label
ID. The headline is always present at index 0.
Checking for that and using index 0 in case we do get a 'idX' helps us
to avoid using the 'idX' as keys in our OnlineHelpInfo.js and actually
use the intended key.
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2021-02-06 07:49:21 +01:00
Aaron Lauterer
a98e228766
docs: fix references to changed refs
...
With commit ec1ae7e631
some refs were
changed by getting prefixes and such. We need to adapt the places that
reference them as well
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2021-02-06 07:47:56 +01:00
Dietmar Maurer
085655b21b
Merge branch 'master' of ssh://proxdev.maurer-it.com/rust/proxmox-backup
2021-02-05 12:53:43 +01:00
Dietmar Maurer
4c209d6b10
install pmt binary
2021-02-05 12:42:20 +01:00
Thomas Lamprecht
ec1ae7e631
docs/online-help: prefix some refs with their chapter name
...
and fix some issues from referenced named the same as their heading
they anchor too.
This should be fixed for real in our python plugin to scan for such
references, its probably a bug there, but as most of the problematic
ones where wrong (missing chapter prefix) anyway changing them is OK
too.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-05 11:42:06 +01:00
Thomas Lamprecht
02dce8cad0
docs: index: update copyright years
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-04 16:06:38 +01:00
Thomas Lamprecht
efc09f63cc
docs: tech overview: avoid 'we' and other small style fixes/additions
...
"we" should be avoided, it's never quite clear who is "we" in the
context here and it leads to some technical wrong meanings, e.g., we
(here assumed to be "we developers") do not read any backup data, the
Proxmox Backup client does.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-04 12:27:14 +01:00
Thomas Lamprecht
3253d8a2e4
docs: tech overfiew: fix line length
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-04 12:05:27 +01:00
Dominik Csapak
1531185dd0
docs: explain some technical details about datastores/chunks
...
adds explanations for:
* what datastores are
* their relation with snapshots/chunks
* basic information about chunk directory structures
* fixed-/dynamically-sized chunks
* special handling of encrypted chunks
* hash collision probability
* limitation of file-based backups
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2021-02-04 11:30:42 +01:00
Thomas Lamprecht
04cec92e8d
update copyright years
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-03 12:04:27 +01:00
Thomas Lamprecht
2f617a4548
docs: tfa: add screenshots
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-03 10:36:18 +01:00
Thomas Lamprecht
f9fcac51a5
docs: add initial TFA documentation
...
better than nothing..
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-02-01 19:46:24 +01:00
Dominik Csapak
627d000098
tape: change changer-drive-id to changer-drivenum
...
because it changed in the config
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2021-01-28 15:11:22 +01:00
Dietmar Maurer
b2fc6f9228
fix build: commit missing file
2021-01-27 18:13:58 +01:00
Dietmar Maurer
b06edeca02
remove generated file synopsis.rst (no need to track in git)
2021-01-27 12:38:02 +01:00
Dietmar Maurer
c972704477
install pmtx binary
2021-01-27 11:36:15 +01:00
Dominik Csapak
66d066964c
docs/tape: fix some typos and improve wording
...
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2021-01-26 12:39:06 +01:00
Dietmar Maurer
8ba47929a0
tape: add docu about paperkey
2021-01-23 15:34:28 +01:00
Dietmar Maurer
794b0fe9ce
tape: document hardware encryption
2021-01-23 15:19:28 +01:00
Dylan Whyte
44a5f38bc4
docs: clarify that client-server communication is secure
...
This clarifies the fact that all communication between client and server
uses TLS for secure communication.
Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2021-01-22 16:07:44 +01:00
Dietmar Maurer
6dd0513546
tape: allocate new media set when pool encryption key changes
2021-01-20 15:43:39 +01:00
Oguz Bektas
bad6e32075
docs: fix typo in client manpage
...
Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
2021-01-18 13:52:11 +01:00
Dietmar Maurer
4cfb123448
tape: update restore docu
2021-01-15 09:44:46 +01:00
Dietmar Maurer
9738dd545f
tape: docu - explain manual backups and tape cleaning
2021-01-12 17:26:15 +01:00
Dietmar Maurer
0bce2118e7
tape: improve docu
2021-01-12 16:37:23 +01:00
Dietmar Maurer
e84b801c2e
tape: improve retention period docu
2021-01-11 07:11:17 +01:00
Dietmar Maurer
44ce25e7ac
tape: docu - improve Administration section
2021-01-08 19:17:31 +01:00
Dietmar Maurer
3a2cc5c66e
tape: minor docu update in retention policy
2021-01-08 19:01:38 +01:00
Dietmar Maurer
3838ce3330
tape: add retention policy docu
2021-01-08 17:34:58 +01:00
Dietmar Maurer
59217472aa
tape: improve media set docu
2021-01-08 16:53:46 +01:00
Dietmar Maurer
08d8b2a4fd
tape: add some media pool docu
2021-01-08 08:46:25 +01:00
Dietmar Maurer
632756b6fb
tape: more docs
2021-01-06 16:13:58 +01:00
Dietmar Maurer
04eba29c55
tape: document tape drive configuration
2021-01-06 16:00:31 +01:00
Dietmar Maurer
0912878ecf
tape: document new export-slots feature
2021-01-06 14:11:35 +01:00
Dietmar Maurer
a174854a0d
tape: improve tape changer docs
2021-01-06 09:45:36 +01:00
Dietmar Maurer
54d968664a
tape: update user docu
2020-12-21 12:13:35 +01:00
Dietmar Maurer
8001c82e81
tape: update user docu - howto label tapes
2020-12-20 10:41:40 +01:00
Dietmar Maurer
baefbc444e
tape: update user docu
2020-12-20 09:16:09 +01:00
Dietmar Maurer
4a227b54bf
add LTO barcode generator App
2020-12-19 17:39:48 +01:00
Dietmar Maurer
8a192bedde
tape: update user docu
2020-12-19 16:56:54 +01:00
Dietmar Maurer
d5efa18ae4
tape: update user docu
2020-12-19 15:13:38 +01:00
Dietmar Maurer
5f79dc2805
tape: start user documentation
2020-12-19 11:14:56 +01:00
Fabian Grünbichler
2ea5abcd65
docs: replace openssl command with client
...
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2020-12-17 06:46:59 +01:00
Thomas Lamprecht
7680525eec
docs: prune-sim: folluwp: add missing semicolon
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-12-16 10:08:11 +01:00
Fabian Ebner
39478aa52c
prune sim: correctly keep track of already included backups
...
This needs to happen in a separate loop, because some time intervals are not
subsets of others, i.e. weeks and months. Previously, with a daily backup
schedule, having:
* a backup on Sun, 06 Dec 2020 kept by keep-daily
* a backup on Sun, 29 Nov 2020 kept by keep-weekly
would lead to the backup on Mon, 30 Nov 2020 to be selected for keep-monthly,
because the iteration did not yet reach the backup on Sun, 29 Nov 2020 that
would mark November as being covered.
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-12-15 14:03:18 +01:00
Thomas Lamprecht
6a99b930c4
followup: use arrow function for sorting
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-12-15 13:45:51 +01:00
Fabian Ebner
f6ce45b373
prune sim: fix #3192 : by fixing usage of sort()
...
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-12-15 13:45:51 +01:00
Dietmar Maurer
abf9b6da42
docs: fix renamed commands
2020-11-25 08:03:11 +01:00
Fabian Ebner
21b552848a
prune sim: make numberfields more similar to PBS's
...
by creating a new class that adds a clear trigger and also uses the
clear-trigger image. Code was taken from the one in PBS's prune window,
but we have default values here, so a bit of adapting was necessary. For
example, we don't want to reset to the original value (which might have
been one of the defaults) when clearing, but always to 'null'.
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-11-19 09:47:51 +01:00
Thomas Lamprecht
f507580c3f
docs: faq: fix first releases
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-11 10:14:01 +01:00
Thomas Lamprecht
291b786076
docs: fix prune retention example
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-11 10:14:01 +01:00
Thomas Lamprecht
0a0ba0785b
prune sim: avoid colon to separate keep desc from count
...
hack for space issues for monthly keeps and >9 counts
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-11 08:20:13 +01:00
Thomas Lamprecht
6ed79592f2
prune sim: make backup schedule a form, bind update button to its validity
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-11 08:11:46 +01:00
Thomas Lamprecht
4c75ee3471
prune sim: do not use unecesarry variable, declare in line
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-11 08:11:16 +01:00
Thomas Lamprecht
6f997da8cd
prune sim: set min-heigth for calendar day cells
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-11 08:10:43 +01:00
Aaron Lauterer
a4971d5f90
docs: add ref for sysadmin host admin section
...
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2020-11-10 13:53:21 +01:00
Fabian Ebner
477ebe6b78
docs: user management: avoid some inconsistencies
...
The space between '--' and 'path' in two of the commands was wrong. The other
changes make the names of the store and token consistent with the rest of the
section and should improve readability.
Also add the Datastore.Verify permission in the output of the command:
proxmox-backup-manager user permissions john@pbs --path /datastore/store1
A DatastoreAdmin now has this permission and that's what john@pbs is in the
example.
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-11-10 13:47:52 +01:00
Thomas Lamprecht
8b62cbe752
docs: update package repositories
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-10 13:14:04 +01:00
Fabian Ebner
81f99362d9
docs: installation: don't mention ext3 as an option anymore
...
Support for ext3 was removed by commit 0abf0d3683b74421eca24ba61d1d4e100d35211a
in pve-installer.
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-11-10 13:13:44 +01:00
Dylan Whyte
c5608cf86c
encryption: add best practice for storing master key
...
Further clarify that the paperkey should be a last resort
recovery option, after a password manager and usb drive.
Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
2020-11-10 12:51:30 +01:00
Aaron Lauterer
0247f794e9
docs: add network management reference
...
needed in order for the help button in the network edit window to work.
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2020-11-10 11:50:17 +01:00
Aaron Lauterer
710f787c41
docs: add maintenance chapter prefix to verification ref
...
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2020-11-10 11:50:12 +01:00
Aaron Lauterer
d8916a326c
scanrefs: only scan docs, not JS files
...
This is a temporary hack until we find a sensible way to scan the
proxmox-widget-toolkit JS files as well.
Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
2020-11-10 11:50:09 +01:00
Fabian Ebner
924d6d4072
prune sim: show count for rule
...
and rename 'all zero' to 'keep-all' to make it consistent with the prune dialog
in PBS.
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-11-10 11:47:37 +01:00
Thomas Lamprecht
bb26843cd6
ui/docs: add get help onlineHelp
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-10 10:35:35 +01:00
Thomas Lamprecht
ee0ab12dd0
ui: move disks/directory stuff to tab panel
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-10 10:15:44 +01:00
Thomas Lamprecht
d5f7755467
docs: online help scanner: also include help tool links
...
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2020-11-10 10:15:08 +01:00
Fabian Ebner
f5d9f2534b
mount zpools created via API under /mnt/datastore
...
as we do for other file systems
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
2020-11-10 09:25:58 +01:00