TrueCloudLab/restic
16
0
Fork 2
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

backend/rclone: Improve documentation and README

Browse source
This commit is contained in:
Alexander Neumann 2018-03-17 13:47:44 +01:00
parent 362d5afec4
commit 011217e4bf
2 changed files with 13 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
README.rst
View file

@ -57,6 +57,7 @@ Therefore, restic supports the following backends for storing backups natively:
- `BackBlaze B2 <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#backblaze-b2>`__ - `BackBlaze B2 <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#backblaze-b2>`__
- `Microsoft Azure Blob Storage <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#microsoft-azure-blob-storage>`__ - `Microsoft Azure Blob Storage <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#microsoft-azure-blob-storage>`__
- `Google Cloud Storage <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#google-cloud-storage>`__ - `Google Cloud Storage <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#google-cloud-storage>`__
- And many other services via the `rclone <https://rclone.org>`__ `Backend <https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html#other-services-via-rclone>`__
Design Principles Design Principles
----------------- -----------------

14
doc/030_preparing_a_new_repo.rst
View file

@ -391,7 +391,9 @@ Other Services via rclone
************************* *************************
The program `rclone`_ can be used to access many other different services and The program `rclone`_ can be used to access many other different services and
store data there. First, you need to install and `configure`_ rclone. When you store data there. First, you need to install and `configure`_ rclone. The
general backend specification format is ``rclone:<remote>:<path>``, the
``<remote>:<path>`` component will be directly passed to rclone. When you
configure a remote named ``foo``, you can then call restic as follows to configure a remote named ``foo``, you can then call restic as follows to
initiate a new repository in the path ``bar`` in the repo: initiate a new repository in the path ``bar`` in the repo:
@ -426,13 +428,20 @@ restic:
Listing the files of an empty repository directly with rclone should return a Listing the files of an empty repository directly with rclone should return a
listing similar to the following: listing similar to the following:
.. code-block:: console .. code-block:: console
$ rclone ls b2prod:yggdrasil/foo/bar/baz $ rclone ls b2prod:yggdrasil/foo/bar/baz
155 bar/baz/config 155 bar/baz/config
448 bar/baz/keys/4bf9c78049de689d73a56ed0546f83b8416795295cda12ec7fb9465af3900b44 448 bar/baz/keys/4bf9c78049de689d73a56ed0546f83b8416795295cda12ec7fb9465af3900b44
Rclone can be `configured with environment variables`_, so for instance
configuring a bandwidth limit for rclone cat be achieve by setting the
``RCLONE_BWLIMIT`` environment variable:
.. code-block:: console
$ export RCLONE_BWLIMIT=1M
The rclone backend has two additional options: The rclone backend has two additional options:
* ``-o rclone.program`` specifies the path to rclone, the default value is just ``rclone`` * ``-o rclone.program`` specifies the path to rclone, the default value is just ``rclone``
@ -475,6 +484,7 @@ repository specification):
.. _rclone: https://rclone.org/ .. _rclone: https://rclone.org/
.. _configure: https://rclone.org/docs/ .. _configure: https://rclone.org/docs/
.. _configured with environment variables: https://rclone.org/docs/#environment-variables
Password prompt on Windows Password prompt on Windows
************************** **************************