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

331 Commits

Author SHA1 Message Date
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
Thomas Lamprecht
030464d3a9 docs: s/DataStore/Datastore/ 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-10 09:24:13 +01:00
Aaron Lauterer
407f3fb994 scanrefs: remove term prefix from title 
It can happen, that a title is defined as term in the following way:
:term:`My title`

This patch checks for it and strips the leading part and the last `.

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
 2020-11-09 16:35:29 +01:00
Dylan Whyte
8f7cd96df4 installation: minor wording fix 
very minor but worthwhile edits

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2020-11-09 15:18:44 +01:00
Dylan Whyte
4accbc5853 backup-client: encryption: discuss paperkey command 
adds a paragraph to the encryption section about
encoding the master key into a qr code for printing

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2020-11-09 15:18:44 +01:00
Thomas Lamprecht
b690bb69eb prune sim: align documentation style with sphinx/alabaster ones 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-08 14:02:27 +01:00
Thomas Lamprecht
8a40e22691 docs: scroll navigation to current active section 
Add a custom JavaScript file to all HTML rendered docs output.

For now it only hosts a small code snipped which gets the current
active section link and bring it into view.
Needs to be triggered after DOM is initially loaded (which is still
before *all* resources like images, iframes, ... are necessarily
loaded), else the query cannot work.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-08 13:29:09 +01:00
Thomas Lamprecht
f5c6a2c956 prune sim: slight layout adaptions 
add some margin to the calendar table, to not make it seem glued to
the left and top, this follow what ExtJS does in general.

Further, adapt layout flex so that docs has 2/5 and calendar has 3/5
of space on small screens (e.g., 720p), makes it look much better
there.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-08 13:24:27 +01:00
Thomas Lamprecht
3896f80cb3 docs: expand prune section, mention simulator, add onlineHelp refs 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-07 15:51:09 +01:00
Thomas Lamprecht
60d2a6157a prune sim: make prune options panel scrollable 
Else it's cutoff on 720p resolution

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-07 14:33:15 +01:00
Thomas Lamprecht
b83b12cf80 prune sim: add daily 00:00 as predefined schedule in selector 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-07 14:08:41 +01:00
Thomas Lamprecht
86847f487b prune sim: allow simulating up to 5 years 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-07 14:08:41 +01:00
Thomas Lamprecht
1b03910dea prune sim: spell out PBS, add some flex to layout 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-07 14:08:41 +01:00
Thomas Lamprecht
435a6c5e0a prune sim: fine tune calendar layout/style 
Avoid black on white, to much contrast hurts the eye, use a dark grey
instead.

Highlight Sundays, and show month boundaries explicitly with strong
dashed border.

Factor out some manual set styles to classes and use them instead,
decoupling logic and styling a bit more.

Use span elements for plain text stuff, which should not be a block
(e.g., div) element.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-07 14:08:41 +01:00
Thomas Lamprecht
1f4befe136 prune sim: enable calendar by default 
it has a really good non-intrusive layout now, so show it's glory by
default.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-07 13:36:58 +01:00
Thomas Lamprecht
7f0f366675 prune sim: do not continue with reload if we caught an exception 
as we then try to dereference hours which is null, for example.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-07 13:35:58 +01:00
Thomas Lamprecht
362e69610c prune sim: set update button handler directly 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-07 13:35:26 +01:00
Thomas Lamprecht
bad26df102 prune sim: factor out toggling color, and default to true 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-07 13:34:20 +01:00
Thomas Lamprecht
790627b4bf prune sim: avoid unnecessary viewmodel formula 
we set a reference on the checkbox, so we get this for free

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-07 13:33:08 +01:00
Thomas Lamprecht
6de14a55ed prune sim: fix numberfield spinner scroll with firefox 
copied over from widget toolkit

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-07 13:32:04 +01:00
Thomas Lamprecht
8b24c6880a prune sim: eslint fixes, do not define console 
really not required nowadays, and we do not use it anyway here..

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-07 13:31:14 +01:00
Thomas Lamprecht
5174956548 prune sim: improve documentation layout 
Better line height, some margin on the edges, and max width to avoid
very long lines on wide displays.

Avoid to much contrast by using black on white, use a very dark grey
instead.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-07 13:28:50 +01:00
Thomas Lamprecht
10db4717f1 docs: maintenance: document notifications 
can surely be improved, just to have anything..

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-11-06 17:52:15 +01:00
Dietmar Maurer
beeadb8a4b Remove reference to backup@pam 2020-11-06 16:32:35 +01:00
Dylan Whyte
b997524912 Add screenshots 
For:
- api tokens
- new user management interface
- updatae server administration

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2020-11-06 16:30:59 +01:00
Dylan Whyte
cc4a9d250a maintenance: add verification and prune to section 
Includes new screen shots of interface

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2020-11-06 16:29:59 +01:00
Dylan Whyte
6227b9bab0 Update where to find certain items since GUI update 
- Sync jobs in datastore
- "User management" is now section of Access Control

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2020-11-06 16:28:47 +01:00
Dylan Whyte
f608e74c8b datastore: description of new datastore view 
- Add screenshots from new datastore view
- Add description of comment field in create datastore window
- Add description of each tab in the datastore panel
- Update instructions to add datastore from GUI

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2020-11-06 16:28:16 +01:00
Dylan Whyte
08379a21d1 backup-client: add section on change-owner command 
Add section "Changing the Owner of a Backup Group"

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2020-11-06 16:27:20 +01:00
Dylan Whyte
8f1d972149 installation & gui: Formatting fixup 
Fix some minor formatting errors in the docs

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2020-11-06 16:26:09 +01:00
Dietmar Maurer
6823fdc7f9 ui: improve prune simulator layout 2020-11-06 12:12:59 +01:00
Fabian Ebner
3323798b54 include prune simulator in build 
Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
Signed-off-by: Dietmar Maurer <dietmar@proxmox.com>
 2020-11-06 09:59:24 +01:00
Fabian Ebner
67fd09791f create prune simulator 
A stand-alone ExtJS app that allows experimenting with different backup
schedules and prune parameters.

The HTML for the documentation was taken from the PBS docs and adapted to the
context of the simulator.

For performance reasons, the week table does not use
subcomponents, but raw HTML.

Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
 2020-11-06 09:13:43 +01:00
Fabian Grünbichler
9de7c71a81 docs: extend managing remotes 
with information about required privileges and limitations

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
 2020-11-02 21:13:24 +01:00
Thomas Lamprecht
90e94aa280 docs: client: avoid that repo gets detected as email address 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-10-30 17:08:08 +01:00
Thomas Lamprecht
c0af05e143 docs: fixup bad RST table format 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-10-30 17:05:49 +01:00
Thomas Lamprecht
4aef06f1b6 docs: add token example to client, and reformat a bit 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2020-10-30 17:01:22 +01:00
Fabian Grünbichler
034cf70b72 docs: add API tokens to documentation 
Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
 2020-10-30 16:46:19 +01:00