From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id C061660BFE for ; Thu, 3 Sep 2020 14:42:18 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id AD67C191D7 for ; Thu, 3 Sep 2020 14:41:48 +0200 (CEST) Received: from gaia.proxmox.com (212-186-127-178.static.upcbusiness.at [212.186.127.178]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 8D9EA191CD for ; Thu, 3 Sep 2020 14:41:47 +0200 (CEST) Received: from gaia.proxmox.com (localhost.localdomain [127.0.0.1]) by gaia.proxmox.com (8.15.2/8.15.2/Debian-14~deb10u1) with ESMTP id 083CflbV632106; Thu, 3 Sep 2020 14:41:47 +0200 Received: (from oguz@localhost) by gaia.proxmox.com (8.15.2/8.15.2/Submit) id 083Cfli8632056; Thu, 3 Sep 2020 14:41:47 +0200 From: Oguz Bektas To: pbs-devel@lists.proxmox.com Date: Thu, 3 Sep 2020 14:41:46 +0200 Message-Id: <20200903124146.631667-1-o.bektas@proxmox.com> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 1 AWL -1.297 Adjusted score from AWL reputation of From: address KAM_ASCII_DIVIDERS 0.8 Spam that uses ascii formatting tricks KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment KAM_LAZY_DOMAIN_SECURITY 1 Sending domain does not have any anti-forgery methods KHOP_HELO_FCRDNS 0.399 Relay HELO differs from its IP's reverse DNS NO_DNS_FOR_FROM 0.379 Envelope sender has no MX or A DNS records SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_NONE 0.001 SPF: sender does not publish an SPF Record Subject: [pbs-devel] [PATCH proxmox-backup] docs: add labels for onlinehelp anchors X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 03 Sep 2020 12:42:18 -0000 define references for some sections for easy adding into onlinehelpinfo --- docs/administration-guide.rst | 34 +++++++++++++++++++++++++++++++++- docs/installation.rst | 3 +++ docs/introduction.rst | 4 ++++ docs/package-repositories.rst | 2 ++ 4 files changed, 42 insertions(+), 1 deletion(-) diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst index e6357a3e..e514beb1 100644 --- a/docs/administration-guide.rst +++ b/docs/administration-guide.rst @@ -7,6 +7,8 @@ Backup Management Terminology ----------- +.. _chapter-backup-explanation: + Backup Content ~~~~~~~~~~~~~~ @@ -121,6 +123,9 @@ uniquely identifies a specific backup within a datastore. As you can see, the time format is RFC3399_ with Coordinated Universal Time (UTC_, identified by the trailing *Z*). + +.. _chapter-backup-manager: + Backup Server Management ------------------------ @@ -215,6 +220,9 @@ display S.M.A.R.T. attributes using the command: # proxmox-backup-manager disk smart-attributes sdX + +.. _chapter-datastore-config: + Datastore Configuration ~~~~~~~~~~~~~~~~~~~~~~~ @@ -324,6 +332,7 @@ directories will store the chunked data after a backup operation has been execut 276490 drwxr-x--- 1 backup backup 1.1M Jul 8 12:35 . +.. _chapter-user-management: User Management ~~~~~~~~~~~~~~~ @@ -400,6 +409,8 @@ Or completely remove the user with: # proxmox-backup-manager user remove john@pbs +.. _chapter-access-control: + Access Control ~~~~~~~~~~~~~~ @@ -472,6 +483,9 @@ A single user can be assigned multiple permission sets for different data stores remote (see `Remote` below) and ``{storename}`` is the name of the data store on the remote. + +.. _chapter-network-management: + Network Management ~~~~~~~~~~~~~~~~~~ Proxmox Backup Server provides an interface for network configuration, through the @@ -538,6 +552,8 @@ configuration file, the command is: You can also configure DNS settings using the ``dns`` subcommand of ``proxmox-backup-manager``. +.. _chapter-backup-remote: + :term:`Remote` ~~~~~~~~~~~~~~ @@ -575,6 +591,9 @@ Use the ``list``, ``show``, ``update``, ``remove`` subcommands of # proxmox-backup-manager remote remove pbs2 +.. _chapter-sync-jobs: + + Sync Jobs ~~~~~~~~~ @@ -595,6 +614,9 @@ provide it with a :term:`schedule` to run regularly. The └────────────┴───────┴────────┴──────────────┴───────────┴─────────┘ # proxmox-backup-manager sync-job remove pbs2-local + +.. _chapter-gc: + Garbage Collection ~~~~~~~~~~~~~~~~~~ You can monitor and run :ref:`garbage collection ` on the @@ -603,6 +625,7 @@ Proxmox Backup Server using the ``garbage-collection`` subcommand of collection on an entire data store and the ``status`` subcommand to see attributes relating to the :ref:`garbage collection `. +.. _chapter-backup-client: Backup Client usage ------------------- @@ -674,7 +697,7 @@ Please use the following environment variables to modify output behavior: format if you need to process the output. -.. _creating-backups: +.. _chapter-creating-backups: Creating Backups ~~~~~~~~~~~~~~~~ @@ -832,6 +855,8 @@ Restoring this backup will result in: restored/subfolder1: . .. file2 +.. _chapter-encryption: + Encryption ~~~~~~~~~~ @@ -876,6 +901,7 @@ You can also use ``proxmox-backup-client key`` to create an RSA public/private key pair, which can be used to store an encrypted version of the symmetric backup encryption key alongside each backup and recover it later. + To set up a master key: 1. Create an encryption key for the backup: @@ -952,6 +978,9 @@ To set up a master key: you should consider keeping a paper copy of this key locked away in a safe place. + +.. _chapter-restore: + Restoring Data ~~~~~~~~~~~~~~ @@ -1093,6 +1122,9 @@ To unmount the filesystem use the ``umount`` command on the mountpoint: # umount /mnt/mountpoint + +.. _chapter-login-logout: + Login and Logout ~~~~~~~~~~~~~~~~ diff --git a/docs/installation.rst b/docs/installation.rst index 7d4055b6..29f45fe3 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,3 +1,6 @@ + +.. _chapter-installation: + Installation ============ diff --git a/docs/introduction.rst b/docs/introduction.rst index 0b0e3ae3..28b634a3 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -76,6 +76,8 @@ Main Features phase is over. +.. _data-backup-reasons: + Reasons for Data Backup? ------------------------ @@ -127,6 +129,8 @@ language. .. todo:: further explain the software stack +.. _get-help: + Getting Help ------------ diff --git a/docs/package-repositories.rst b/docs/package-repositories.rst index c3883b8b..6364f603 100644 --- a/docs/package-repositories.rst +++ b/docs/package-repositories.rst @@ -128,6 +128,8 @@ Here, the output should be: deb http://security.debian.org/debian-security buster/updates main contrib +.. _chapter-beta-repo: + `Proxmox Backup`_ Beta Repository ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- 2.20.1