From dbb5860dc91e1f44b5333e3c7d5352875fa6b4a8 Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Sun, 3 Jul 2022 11:19:24 +0200 Subject: [PATCH] Document connections and compression option --- doc/047_tuning_backup_parameters.rst | 40 ++++++++++++++++++++++++++++ doc/index.rst | 1 + 2 files changed, 41 insertions(+) create mode 100644 doc/047_tuning_backup_parameters.rst diff --git a/doc/047_tuning_backup_parameters.rst b/doc/047_tuning_backup_parameters.rst new file mode 100644 index 000000000..e63dc5f87 --- /dev/null +++ b/doc/047_tuning_backup_parameters.rst @@ -0,0 +1,40 @@ +.. + Normally, there are no heading levels assigned to certain characters as the structure is + determined from the succession of headings. However, this convention is used in Python’s + Style Guide for documenting which you may follow: + # with overline, for parts + * for chapters + = for sections + - for subsections + ^ for subsubsections + " for paragraphs +######################## +Tuning Backup Parameters +######################## + +Restic offers a few parameters that allow tuning the backup. The default values should +work well in general although specific use cases can benefit from different non-default +values. As the restic commands evolve over time, the optimal value for each parameter +can also change across restic versions. + + +Backend Connections +=================== + +Restic uses a global limit for the number of concurrent connections to a backend. +This limit can be configured using ``-o .connections=5``, for example for +the REST backend the parameter would be ``-o rest.connections=5``. By default restic uses +``5`` connections for each backend, except for the local backend which uses a limit of ``2``. +The defaults should work well in most cases. For high-latency backends it can be beneficial +to increase the number of connections. Please be aware that this increases the resource +consumption of restic and that a too high connection count *will degrade performace*. + + +Compression +=========== + +For a repository using a least repository format version 2, you can configure how data +is compressed with the option ``--compression``. It can be set to ```auto``` (the default, +which will compress very fast), ``max`` (which will trade backup speed and CPU usage for +slightly better compression), or ``off`` (which disables compression). Each setting is +only applied for the single run of restic. diff --git a/doc/index.rst b/doc/index.rst index 69bbb8483..034dbda23 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -9,6 +9,7 @@ Restic Documentation 030_preparing_a_new_repo 040_backup 045_working_with_repos + 047_tuning_backup_parameters 050_restore 060_forget 070_encryption