From 0666fa11b8d365778d863c872ec66cc83a679df8 Mon Sep 17 00:00:00 2001 From: "Leo R. Lundgren" Date: Wed, 22 Mar 2023 17:37:58 +0100 Subject: [PATCH] doc: Correct broken links --- doc/020_installation.rst | 2 +- doc/030_preparing_a_new_repo.rst | 19 +++++++++---------- doc/110_talks.rst | 6 +++--- doc/manual_rest.rst | 2 +- 4 files changed, 14 insertions(+), 15 deletions(-) diff --git a/doc/020_installation.rst b/doc/020_installation.rst index 0c6795a26..4488e31f9 100644 --- a/doc/020_installation.rst +++ b/doc/020_installation.rst @@ -93,7 +93,7 @@ You may also install it using `MacPorts `__: Nix & NixOS =========== -If you are using `Nix `__ or `NixOS `__ +If you are using `Nix / NixOS `__ there is a package available named ``restic``. It can be installed using ``nix-env``: diff --git a/doc/030_preparing_a_new_repo.rst b/doc/030_preparing_a_new_repo.rst index 0eede3e38..44223c146 100644 --- a/doc/030_preparing_a_new_repo.rst +++ b/doc/030_preparing_a_new_repo.rst @@ -273,7 +273,7 @@ For an S3-compatible server that is not Amazon (like Minio, see below), or is only available via HTTP, you can specify the URL to the server like this: ``s3:http://server:port/bucket_name``. -.. note:: restic expects `path-style URLs `__ +.. note:: restic expects `path-style URLs `__ like for example ``s3.us-west-2.amazonaws.com/bucket_name``. Virtual-hosted–style URLs like ``bucket_name.s3.us-west-2.amazonaws.com``, where the bucket name is part of the hostname are not supported. These must @@ -290,12 +290,11 @@ like this: ``s3:http://server:port/bucket_name``. Minio Server ************ -`Minio `__ is an Open Source Object Storage, +`Minio `__ is an Open Source Object Storage, written in Go and compatible with Amazon S3 API. -- Download and Install `Minio - Server `__. -- You can also refer to https://docs.minio.io for step by step guidance +- Download and Install `Minio Download `__. +- You can also refer to `Minio Docs `__ for step by step guidance on installation and getting started on Minio Client and Minio Server. You must first setup the following environment variables with the @@ -358,7 +357,7 @@ of data in the cloud. Alibaba OSS is S3 compatible so it can be used as a storage provider for a restic repository with a couple of extra parameters. -- Determine the correct `Alibaba OSS region endpoint `__ - this will be something like ``oss-eu-west-1.aliyuncs.com`` +- Determine the correct `Alibaba OSS region endpoint `__ - this will be something like ``oss-eu-west-1.aliyuncs.com`` - You'll need the region name too - this will be something like ``oss-eu-west-1`` You must first setup the following environment variables with the @@ -441,7 +440,7 @@ the naming convention of those variables follows the official Python Swift clien Restic should be compatible with an `OpenStack RC file -`__ +`__ in most cases. Once environment variables are set up, a new repository can be created. The @@ -614,8 +613,8 @@ The number of concurrent connections to the GCS service can be set with the ``-o gs.connections=10`` switch. By default, at most five parallel connections are established. -.. _service account: https://cloud.google.com/iam/docs/service-accounts -.. _create a service account key: https://cloud.google.com/iam/docs/creating-managing-service-account-keys#iam-service-account-keys-create-console +.. _service account: https://cloud.google.com/iam/docs/service-account-overview +.. _create a service account key: https://cloud.google.com/iam/docs/keys-create-delete .. _default authentication material: https://cloud.google.com/docs/authentication#service-accounts .. _other-services: @@ -748,7 +747,7 @@ Password prompt on Windows At the moment, restic only supports the default Windows console interaction. If you use emulation environments like -`MSYS2 `__ or +`MSYS2 `__ or `Cygwin `__, which use terminals like ``Mintty`` or ``rxvt``, you may get a password error. diff --git a/doc/110_talks.rst b/doc/110_talks.rst index 51dcd3e35..e32cda62a 100644 --- a/doc/110_talks.rst +++ b/doc/110_talks.rst @@ -26,11 +26,11 @@ The following talks will be or have been given about restic: Public lecture in German at `CCC Cologne e.V. `__ in Cologne, Germany - 2015-08-23: `A Solution to the Backup - Inconvenience `__: - Lecture at `FROSCON 2015 `__ in Bonn, Germany + Inconvenience `__: + Lecture at `FROSCON 2015 `__ in Bonn, Germany - 2015-02-01: `Lightning Talk at FOSDEM 2015 `__: A short introduction (with slightly outdated command line) - 2015-01-27: `Talk about restic at CCC - Aachen `__ + Aachen `__ (in German) diff --git a/doc/manual_rest.rst b/doc/manual_rest.rst index 97480db80..3bf2c475f 100644 --- a/doc/manual_rest.rst +++ b/doc/manual_rest.rst @@ -224,7 +224,7 @@ locks with the following command: d369ccc7d126594950bf74f0a348d5d98d9e99f3215082eb69bf02dc9b3e464c The ``find`` command searches for a given -`pattern `__ in the +`pattern `__ in the repository. .. code-block:: console