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

413 Commits

Author SHA1 Message Date
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
Dylan Whyte
7ccbce03d3 docs: language and formatting fixup 
Some minor langague and formatting fixes to sections: Proxmox VE
Integration, pxar Command Line Tool, Managing Remotes, Maintenance
Tasks, Host System Administration, Network Management, and Technical
Overview.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2021-10-12 08:31:37 +02:00
Dylan Whyte
5fb852afed docs: backup-client: langauge and formatting fixup 
also remove todo item for scheduling garbage collect with cron, and add
note about schedule configuration through proxmox-backup-manager/PBS GUI

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2021-10-12 08:30:39 +02:00
Dylan Whyte
60589e6066 docs: Update for new features/functionality 
Update GUI section and GUI instructions to reflect current layout and
features

List OpenID connect in possible realms (user management)

Link Access Control section when referring to it (user management)

Include Tape roles in access control section

Minor formatting changes

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2021-10-12 08:28:29 +02:00
Dylan Whyte
717ce40612 docs: language and formatting fixup 
Some minor changes to the sections: Introduction, Installation,
Terminology, GUI, Storage, and User Management

Mention tape backup in main features

Update epilog.rst with link for 'LXC'.
Remove FIXME from epilog.rst (I believe this was a note to repair
the not-yet-created pbs wiki link).

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2021-10-12 08:26:13 +02:00
Thomas Lamprecht
a294588409 docs: troubleshooting: reformat & adapt 
Text-width should be 80 cc in the docs.

Avoid using relative paths in examples, they only confuse users as
one has less of a specific idea what the example may do. Rather use a
"descriptive" example path.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-09-22 07:41:47 +02:00
Hannes Laimer
5a83930667 docs/technical-overview: add troubleshooting section 2021-09-22 07:29:00 +02:00
Dominik Csapak
f7885eb263 docs: proxmox-backup-debug: add info about the 'api' subcommand 
and mention PROXMOX_DEBUG_API_CODE and that its dangerous.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-09-21 15:10:48 +02:00
Dominik Csapak
a48d534d39 docs: add proxmox-backup-debug to the list of command line tools 
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-09-21 15:10:48 +02:00
Wolfgang Bumiller
df12c9ec4e add proxmox-backup-debug debian package 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
 2021-09-02 11:25:50 +02:00
Lorenz Stechauner
400e90cfbe docs/file-formats: fix typo 
Signed-off-by: Lorenz Stechauner <l.stechauner@proxmox.com>
 2021-08-03 09:17:33 +02:00
Dominik Csapak
a5f30a562b docs: tape: add instructions on how to restore the catalog 
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
 2021-07-26 13:41:38 +02:00
Thomas Lamprecht
65ab4ca976 docs: simplify list of ENV var alternative 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-07-22 10:21:40 +02:00
Dietmar Maurer
99a73fad15 doc: Document new environment variabless to specify secret values 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-07-22 10:10:40 +02:00
Thomas Lamprecht
a5d51b0c4f docs: tape: drop technology preview admonitions 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-07-13 16:48:05 +02:00
Thomas Lamprecht
13a2445744 buildsys: docs: clean: also clean generated JS files 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-07-03 21:44:13 +02:00
Thomas Lamprecht
1ce1a5e5cc docs: installation: drop debian-release specific note 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-07-03 01:44:53 +02:00
Thomas Lamprecht
6f66a0ca71 docs: faq: update support table 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-07-03 01:44:09 +02:00
Thomas Lamprecht
62a5b3907b docs: initial update to repositories for bullseye 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-07-02 19:02:13 +02:00
Dominik Csapak
85417b2a88 docs: build api-viewer from widget-toolkit-dev 
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
 2021-06-28 14:26:40 +02:00
Dominik Csapak
d738669066 docs: add Toolkit.js to lto-barcode 
and generate a single js file for it

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
 2021-06-28 14:26:40 +02:00
Dominik Csapak
442d6da8fb docs: add Toolkit.js to prune simulator 
from proxmox-widget-toolkit-dev and not as normal dependency,
else we would have to ship widget-toolkit on the wiki

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
 2021-06-28 14:26:40 +02:00
Dominik Csapak
62f10a01db docs/prune-simulator: remove displayField for Calendar Field 
in extjs 7.0, specifying displayField overwrites the displayTpl,
which we want to use here, so remove it

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
 2021-06-28 14:26:40 +02:00
Thomas Lamprecht
5aaa81ab89 docs: add short initial http-proxy docs 
better than nothing and something to point to in the UI

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-05-21 18:23:35 +02:00
Dominik Csapak
37ff72720b docs/api-viewer: improve rendering of array format 
by showing
'[format, ...]'
where 'format' is the simple format from the type of the items

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-05-11 09:12:55 +02:00
Thomas Lamprecht
3c06eba17a docs: online help info: surpress warnings during scan 
We get lots of warnings due to sphinx complaining about missing
includes for generated synopsis. We do not reference to any of those
for now, so we can ignore that now and supress all standard and
warning output.

Note: Errors are still reported.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-05-07 11:51:30 +02:00
Dominik Csapak
ae5b1e188f docs: tape: clarify LTO-4/5 support 
some features we need (e.g. READ POSITION long form) are only officially
available with LTO-5, but work on many LTO-4 drives, so move LTO-4 to
'best-effort' support.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
 2021-05-04 13:21:44 +02:00
Dominik Csapak
5bf9b0b0bb docs: user-management: add note about untrusted certificates for webauthn 
Since currently it works fine with untrusted certs, but that may change
anytime.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
 2021-05-03 12:01:23 +02:00
Dylan Whyte
f4bb2510b9 docs: tape: replace changer overview screenshot 
Replace previous screenshot with one that shows a more realistic amount
of drives.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2021-04-14 14:41:00 +02:00
Dietmar Maurer
7afb98a912 docs: fix tape.cfg format description 2021-04-14 14:30:20 +02:00
Dietmar Maurer
3847008e1b docs: pmt - remove old linux driver options 2021-04-14 14:26:39 +02:00
Dietmar Maurer
f6ed2eff47 docs: move tape config/syntax to appendix 2021-04-14 14:25:10 +02:00
Thomas Lamprecht
384a2b4d4f docs: faq: fix encryption link 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-04-14 14:18:05 +02:00
Thomas Lamprecht
910177a388 docs: pve-integration: mention gui integration 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-04-14 14:18:05 +02:00
Dietmar Maurer
54311a38c6 docs: update proxmox-tape status output 2021-04-14 14:03:45 +02:00
Dietmar Maurer
10439718e2 docs: use defininition list for tape Terminology 
To avoid those strange line breaks in Field list labels.
 2021-04-14 13:25:29 +02:00
Thomas Lamprecht
ebddccef5f docs: gui: add short tape backup section 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-04-14 12:47:05 +02:00
Thomas Lamprecht
9cfe0ff350 docs: include tape backup in TOC 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-04-14 12:47:05 +02:00
Thomas Lamprecht
295bae14b7 docs: tape: add a bit of text to changers for better image flow 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
 2021-04-14 12:47:05 +02:00
Dylan Whyte
53939bb438 docs: tape screenshots 
Add tape screenshots throughout the tape docs with some references to the GUI

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
 2021-04-14 12:47:05 +02:00