tsarevvv/proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: link all screenshots to their image file

Browse Source 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2022-11-28 17:15:42 +01:00
parent b287a702b7
commit 5565e454c2
10 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/certificate-management.rst
View File

@ -50,6 +50,7 @@ interface.
.. image:: images/screenshots/pbs-gui-certs-upload-custom.png .. image:: images/screenshots/pbs-gui-certs-upload-custom.png
:target: _images/pbs-gui-certs-upload-custom.png
:align: right :align: right
:alt: Upload a custom certificate :alt: Upload a custom certificate
@ -80,6 +81,7 @@ ACME Account
^^^^^^^^^^^^ ^^^^^^^^^^^^
.. image:: images/screenshots/pbs-gui-acme-create-account.png .. image:: images/screenshots/pbs-gui-acme-create-account.png
:target: _images/pbs-gui-acme-create-account.png
:align: right :align: right
:alt: Create ACME Account :alt: Create ACME Account
@ -123,6 +125,7 @@ used in such cases. This challenge is fulfilled by creating a certain
DNS record in the domain’s zone. DNS record in the domain’s zone.
.. image:: images/screenshots/pbs-gui-acme-create-challenge-plugin.png .. image:: images/screenshots/pbs-gui-acme-create-challenge-plugin.png
:target: _images/pbs-gui-acme-create-challenge-plugin.png
:align: right :align: right
:alt: Create ACME Account :alt: Create ACME Account
@ -142,6 +145,7 @@ You can add new or manage existing domain entries under
``Certificates``, or using the ``proxmox-backup-manager`` command. ``Certificates``, or using the ``proxmox-backup-manager`` command.
.. image:: images/screenshots/pbs-gui-acme-add-domain.png .. image:: images/screenshots/pbs-gui-acme-add-domain.png
:target: _images/pbs-gui-acme-add-domain.png
:align: right :align: right
:alt: Add a Domain for ACME verification :alt: Add a Domain for ACME verification

6
docs/gui.rst
View File

@ -29,6 +29,7 @@ Login
----- -----
.. image:: images/screenshots/pbs-gui-login-window.png .. image:: images/screenshots/pbs-gui-login-window.png
:target: _images/pbs-gui-login-window.png
:align: right :align: right
:alt: PBS login window :alt: PBS login window
@ -44,6 +45,7 @@ GUI Overview
------------ ------------
.. image:: images/screenshots/pbs-gui-dashboard.png .. image:: images/screenshots/pbs-gui-dashboard.png
:target: _images/pbs-gui-dashboard.png
:align: right :align: right
:alt: PBS GUI Dashboard :alt: PBS GUI Dashboard
@ -92,6 +94,7 @@ Administration
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^
.. image:: images/screenshots/pbs-gui-administration-serverstatus.png .. image:: images/screenshots/pbs-gui-administration-serverstatus.png
:target: _images/pbs-gui-administration-serverstatus.png
:align: right :align: right
:alt: Administration: Server Status overview :alt: Administration: Server Status overview
@ -107,6 +110,7 @@ tasks and information. These are:
* **Tasks**: Task history with multiple filter options * **Tasks**: Task history with multiple filter options
.. image:: images/screenshots/pbs-gui-disks.png .. image:: images/screenshots/pbs-gui-disks.png
:target: _images/pbs-gui-disks.png
:align: right :align: right
:alt: Administration: Disks :alt: Administration: Disks
@ -121,6 +125,7 @@ Tape Backup
^^^^^^^^^^^ ^^^^^^^^^^^
.. image:: images/screenshots/pbs-gui-tape-changer-overview.png .. image:: images/screenshots/pbs-gui-tape-changer-overview.png
:target: _images/pbs-gui-tape-changer-overview.png
:align: right :align: right
:alt: Tape Backup: Tape changer overview :alt: Tape Backup: Tape changer overview
@ -143,6 +148,7 @@ Datastore
^^^^^^^^^ ^^^^^^^^^
.. image:: images/screenshots/pbs-gui-datastore-summary.png .. image:: images/screenshots/pbs-gui-datastore-summary.png
:target: _images/pbs-gui-datastore-summary.png
:align: right :align: right
:alt: Datastore Configuration :alt: Datastore Configuration

1
docs/maintenance.rst
View File

@ -215,6 +215,7 @@ By default, notifications are sent to the email address configured for the
`root@pam` user. You can instead set this user for each datastore. `root@pam` user. You can instead set this user for each datastore.
.. image:: images/screenshots/pbs-gui-datastore-options.png .. image:: images/screenshots/pbs-gui-datastore-options.png
:target: _images/pbs-gui-datastore-options.png
:align: right :align: right
:alt: Datastore Options :alt: Datastore Options

2
docs/managing-remotes.rst
View File

@ -14,6 +14,7 @@ configuration information for remotes is stored in the file
``/etc/proxmox-backup/remote.cfg``. ``/etc/proxmox-backup/remote.cfg``.
.. image:: images/screenshots/pbs-gui-remote-add.png .. image:: images/screenshots/pbs-gui-remote-add.png
:target: _images/pbs-gui-remote-add.png
:align: right :align: right
:alt: Add a remote :alt: Add a remote
@ -55,6 +56,7 @@ Sync Jobs
--------- ---------
.. image:: images/screenshots/pbs-gui-syncjob-add.png .. image:: images/screenshots/pbs-gui-syncjob-add.png
:target: _images/pbs-gui-syncjob-add.png
:align: right :align: right
:alt: Add a Sync Job :alt: Add a Sync Job

2
docs/network-management.rst
View File

@ -4,6 +4,7 @@ Network Management
================== ==================
.. image:: images/screenshots/pbs-gui-system-config.png .. image:: images/screenshots/pbs-gui-system-config.png
:target: _images/pbs-gui-system-config.png
:align: right :align: right
:alt: System and Network Configuration Overview :alt: System and Network Configuration Overview
@ -45,6 +46,7 @@ in the list above:
# proxmox-backup-manager network create bond0 --type bond --bond_mode active-backup --slaves ens18,ens19 --autostart true --cidr x.x.x.x/x --gateway x.x.x.x # proxmox-backup-manager network create bond0 --type bond --bond_mode active-backup --slaves ens18,ens19 --autostart true --cidr x.x.x.x/x --gateway x.x.x.x
.. image:: images/screenshots/pbs-gui-network-create-bond.png .. image:: images/screenshots/pbs-gui-network-create-bond.png
:target: _images/pbs-gui-network-create-bond.png
:align: right :align: right
:alt: Add a network interface :alt: Add a network interface

1
docs/package-repositories.rst
View File

@ -28,6 +28,7 @@ In addition, you need a package repository from Proxmox to get Proxmox Backup
updates. updates.
.. image:: images/screenshots/pbs-gui-administration-apt-repos.png .. image:: images/screenshots/pbs-gui-administration-apt-repos.png
:target: _images/pbs-gui-administration-apt-repos.png
:align: right :align: right
:alt: APT Repository Management in the Web Interface :alt: APT Repository Management in the Web Interface

5
docs/storage.rst
View File

@ -40,6 +40,7 @@ To initialize a disk with a new GPT, use the ``initialize`` subcommand:
# proxmox-backup-manager disk initialize sdX # proxmox-backup-manager disk initialize sdX
.. image:: images/screenshots/pbs-gui-disks-dir-create.png .. image:: images/screenshots/pbs-gui-disks-dir-create.png
:target: _images/pbs-gui-disks-dir-create.png
:align: right :align: right
:alt: Create a directory :alt: Create a directory
@ -93,6 +94,7 @@ display S.M.A.R.T. attributes from the web interface or by using the command:
----------------- -----------------
.. image:: images/screenshots/pbs-gui-datastore-summary.png .. image:: images/screenshots/pbs-gui-datastore-summary.png
:target: _images/pbs-gui-datastore-summary.png
:align: right :align: right
:alt: Datastore Usage Overview :alt: Datastore Usage Overview
@ -116,6 +118,7 @@ Datastore Configuration
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
.. image:: images/screenshots/pbs-gui-datastore-content.png .. image:: images/screenshots/pbs-gui-datastore-content.png
:target: _images/pbs-gui-datastore-content.png
:align: right :align: right
:alt: Datastore Content Overview :alt: Datastore Content Overview
@ -135,6 +138,7 @@ run periodically, based on a configured schedule (see
Creating a Datastore Creating a Datastore
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
.. image:: images/screenshots/pbs-gui-datastore-create.png .. image:: images/screenshots/pbs-gui-datastore-create.png
:target: _images/pbs-gui-datastore-create.png
:align: right :align: right
:alt: Create a datastore :alt: Create a datastore
@ -304,6 +308,7 @@ Options
~~~~~~~ ~~~~~~~
.. image:: images/screenshots/pbs-gui-datastore-options.png .. image:: images/screenshots/pbs-gui-datastore-options.png
:target: _images/pbs-gui-datastore-options.png
:align: right :align: right
:alt: Datastore Options :alt: Datastore Options

10
docs/tape-backup.rst
View File

@ -4,6 +4,7 @@ Tape Backup
=========== ===========
.. image:: images/screenshots/pbs-gui-tape-changer-overview.png .. image:: images/screenshots/pbs-gui-tape-changer-overview.png
:target: _images/pbs-gui-tape-changer-overview.png
:align: right :align: right
:alt: Tape Backup: Tape changer overview :alt: Tape Backup: Tape changer overview
@ -188,6 +189,7 @@ Tape changers
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
.. image:: images/screenshots/pbs-gui-tape-changers.png .. image:: images/screenshots/pbs-gui-tape-changers.png
:target: _images/pbs-gui-tape-changers.png
:align: right :align: right
:alt: Tape Backup: Tape Changers :alt: Tape Backup: Tape Changers
@ -223,6 +225,7 @@ Where ``sl3`` is an arbitrary name you can choose.
different device after reboot, and that is not what you want. different device after reboot, and that is not what you want.
.. image:: images/screenshots/pbs-gui-tape-changers-add.png .. image:: images/screenshots/pbs-gui-tape-changers-add.png
:target: _images/pbs-gui-tape-changers-add.png
:align: right :align: right
:alt: Tape Backup: Add a new tape changer :alt: Tape Backup: Add a new tape changer
@ -329,6 +332,7 @@ Tape drives
~~~~~~~~~~~ ~~~~~~~~~~~
.. image:: images/screenshots/pbs-gui-tape-drives.png .. image:: images/screenshots/pbs-gui-tape-drives.png
:target: _images/pbs-gui-tape-drives.png
:align: right :align: right
:alt: Tape Backup: Drive list :alt: Tape Backup: Drive list
@ -345,6 +349,7 @@ of available tape drives using:
└────────────────────────────────┴────────┴─────────────┴────────┘ └────────────────────────────────┴────────┴─────────────┴────────┘
.. image:: images/screenshots/pbs-gui-tape-drives-add.png .. image:: images/screenshots/pbs-gui-tape-drives-add.png
:target: _images/pbs-gui-tape-drives-add.png
:align: right :align: right
:alt: Tape Backup: Add a tape drive :alt: Tape Backup: Add a tape drive
@ -448,6 +453,7 @@ Media Pools
~~~~~~~~~~~ ~~~~~~~~~~~
.. image:: images/screenshots/pbs-gui-tape-pools.png .. image:: images/screenshots/pbs-gui-tape-pools.png
:target: _images/pbs-gui-tape-pools.png
:align: right :align: right
:alt: Tape Backup: Media Pools :alt: Tape Backup: Media Pools
@ -566,6 +572,7 @@ a single media pool, so a job only uses tapes from that pool.
you need to restore the key. you need to restore the key.
.. image:: images/screenshots/pbs-gui-tape-pools-add.png .. image:: images/screenshots/pbs-gui-tape-pools-add.png
:target: _images/pbs-gui-tape-pools-add.png
:align: right :align: right
:alt: Tape Backup: Add a media pool :alt: Tape Backup: Add a media pool
@ -603,6 +610,7 @@ Tape Backup Jobs
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
.. image:: images/screenshots/pbs-gui-tape-backup-jobs.png .. image:: images/screenshots/pbs-gui-tape-backup-jobs.png
:target: _images/pbs-gui-tape-backup-jobs.png
:align: right :align: right
:alt: Tape Backup: Tape Backup Jobs :alt: Tape Backup: Tape Backup Jobs
@ -692,6 +700,7 @@ backup. You can specify a single namespace with ``ns`` and a depth with
If no `max-depth` is given, it will include all recursive namespaces. If no `max-depth` is given, it will include all recursive namespaces.
.. image:: images/screenshots/pbs-gui-tape-backup-jobs-add.png .. image:: images/screenshots/pbs-gui-tape-backup-jobs-add.png
:target: _images/pbs-gui-tape-backup-jobs-add.png
:align: right :align: right
:alt: Tape Backup: Add a backup job :alt: Tape Backup: Add a backup job
@ -922,6 +931,7 @@ Encryption Key Management
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: images/screenshots/pbs-gui-tape-crypt-keys.png .. image:: images/screenshots/pbs-gui-tape-crypt-keys.png
:target: _images/pbs-gui-tape-crypt-keys.png
:align: right :align: right
:alt: Tape Backup: Encryption Keys :alt: Tape Backup: Encryption Keys

1
docs/traffic-control.rst
View File

@ -4,6 +4,7 @@ Traffic Control
--------------- ---------------
.. image:: images/screenshots/pbs-gui-traffic-control-add.png .. image:: images/screenshots/pbs-gui-traffic-control-add.png
:target: _images/pbs-gui-traffic-control-add.png
:align: right :align: right
:alt: Add a traffic control limit :alt: Add a traffic control limit

8
docs/user-management.rst
View File

@ -8,6 +8,7 @@ User Configuration
------------------ ------------------
.. image:: images/screenshots/pbs-gui-user-management.png .. image:: images/screenshots/pbs-gui-user-management.png
:target: _images/pbs-gui-user-management.png
:align: right :align: right
:alt: User management :alt: User management
@ -39,6 +40,7 @@ command line tool to list or manipulate users:
└─────────────┴────────┴────────┴───────────┴──────────┴────────────────┴────────────────────┘ └─────────────┴────────┴────────┴───────────┴──────────┴────────────────┴────────────────────┘
.. image:: images/screenshots/pbs-gui-user-management-add-user.png .. image:: images/screenshots/pbs-gui-user-management-add-user.png
:target: _images/pbs-gui-user-management-add-user.png
:align: right :align: right
:alt: Add a new user :alt: Add a new user
@ -94,6 +96,7 @@ API Tokens
---------- ----------
.. image:: images/screenshots/pbs-gui-apitoken-overview.png .. image:: images/screenshots/pbs-gui-apitoken-overview.png
:target: _images/pbs-gui-apitoken-overview.png
:align: right :align: right
:alt: API Token Overview :alt: API Token Overview
@ -112,6 +115,7 @@ need to be provided to the client in place of the user ID (``user@realm``) and
the user password, respectively. the user password, respectively.
.. image:: images/screenshots/pbs-gui-apitoken-secret-value.png .. image:: images/screenshots/pbs-gui-apitoken-secret-value.png
:target: _images/pbs-gui-apitoken-secret-value.png
:align: right :align: right
:alt: API secret value :alt: API secret value
@ -350,6 +354,7 @@ Configuration & Management
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: images/screenshots/pbs-gui-permissions-add.png .. image:: images/screenshots/pbs-gui-permissions-add.png
:target: _images/pbs-gui-permissions-add.png
:align: right :align: right
:alt: Add permissions for user :alt: Add permissions for user
@ -465,6 +470,7 @@ account, as even if they have the password, they will not have access to the
physical object (second factor). physical object (second factor).
.. image:: images/screenshots/pbs-gui-tfa-login.png .. image:: images/screenshots/pbs-gui-tfa-login.png
:target: _images/pbs-gui-tfa-login.png
:align: right :align: right
:alt: Add a new user :alt: Add a new user
@ -502,6 +508,7 @@ TOTP
^^^^ ^^^^
.. image:: images/screenshots/pbs-gui-tfa-add-totp.png .. image:: images/screenshots/pbs-gui-tfa-add-totp.png
:target: _images/pbs-gui-tfa-add-totp.png
:align: right :align: right
:alt: Add a new user :alt: Add a new user
@ -535,6 +542,7 @@ Recovery Keys
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
.. image:: images/screenshots/pbs-gui-tfa-add-recovery-keys.png .. image:: images/screenshots/pbs-gui-tfa-add-recovery-keys.png
:target: _images/pbs-gui-tfa-add-recovery-keys.png
:align: right :align: right
:alt: Add a new user :alt: Add a new user