Skip to content

Commit

Permalink
Merge pull request borgbackup#8371 from AfroThundr3007730/AfroThundr3…
Browse files Browse the repository at this point in the history
…007730/issue8361

Update repository URLs in docs to use new syntax
  • Loading branch information
ThomasWaldmann authored Sep 11, 2024
2 parents 81cb1cd + 4f110f8 commit 30cd3b8
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 17 deletions.
8 changes: 4 additions & 4 deletions docs/deployment/central-backup-server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The options which are added to the key will perform the following:
Due to the ``cd`` command we use, the server automatically changes the current
working directory. Then client doesn't need to have knowledge of the absolute
or relative remote repository path and can directly access the repositories at
``<user>@<host>:<repo>``.
``ssh://<user>@<host>/./<repo>``.

.. note:: The setup above ignores all client given commandline parameters
which are normally appended to the `borg serve` command.
Expand All @@ -93,21 +93,21 @@ The client needs to initialize the `pictures` repository like this:

::

borg init [email protected]:pictures
borg init ssh://[email protected]/./pictures

Or with the full path (should actually never be used, as only for demonstrational purposes).
The server should automatically change the current working directory to the `<client fqdn>` folder.

::

borg init [email protected]:/home/backup/repos/johndoe.clnt.local/pictures
borg init ssh://[email protected]/home/backup/repos/johndoe.clnt.local/pictures

When `johndoe.clnt.local` tries to access a not restricted path the following error is raised.
John Doe tries to backup into the Web 01 path:

::

borg init [email protected]:/home/backup/repos/web01.srv.local/pictures
borg init ssh://[email protected]/home/backup/repos/web01.srv.local/pictures

::

Expand Down
2 changes: 1 addition & 1 deletion docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ This is not a problem anymore.
For more details, see :ref:`checkpoints_parts`.

How can I switch append-only mode on and off?
-----------------------------------------------------------------------------------------------------------------------------------
---------------------------------------------

You could do that (via borg config REPO append_only 0/1), but using different
ssh keys and different entries in ``authorized_keys`` is much easier and also
Expand Down
24 changes: 12 additions & 12 deletions docs/usage/general/repository-urls.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,30 @@ Note: you may also prepend a ``file://`` to a filesystem path to get URL style.

**Remote repositories** accessed via ssh user@host:

``user@host:/path/to/repo`` - remote repo, absolute path
``ssh://user@host:port/path/to/repo`` - remote repo, absolute path, port can be given

``ssh://user@host:port/path/to/repo`` - same, alternative syntax, port can be given
``user@host:/path/to/repo`` - remote repo, absolute path, deprecated syntax


**Remote repositories with relative paths** can be given using this syntax:
**Remote repositories with relative paths, URL style syntax with port**:

``user@host:path/to/repo`` - path relative to current directory
``ssh://user@host:port/./path/to/repo`` - path relative to current directory

``user@host:~/path/to/repo`` - path relative to user's home directory
``ssh://user@host:port/~/path/to/repo`` - path relative to user's home directory

``user@host:~other/path/to/repo`` - path relative to other's home directory
``ssh://user@host:port/~other/path/to/repo`` - path relative to other's home directory (deprecated)

Note: giving ``user@host:/./path/to/repo`` or ``user@host:/~/path/to/repo`` or
``user@host:/~other/path/to/repo`` is also supported, but not required here.

**Remote repositories with relative paths, deprecated SCP style syntax**:

**Remote repositories with relative paths, alternative syntax with port**:
``user@host:path/to/repo`` - path relative to current directory

``ssh://user@host:port/./path/to/repo`` - path relative to current directory
``user@host:~/path/to/repo`` - path relative to user's home directory
``ssh://user@host:port/~/path/to/repo`` - path relative to user's home directory
``user@host:~other/path/to/repo`` - path relative to other's home directory

``ssh://user@host:port/~other/path/to/repo`` - path relative to other's home directory
Note: giving ``user@host:/./path/to/repo`` or ``user@host:/~/path/to/repo`` or
``user@host:/~other/path/to/repo`` is also supported, but not required here.


If you frequently need the same repo URL, it is a good idea to set the
Expand Down

0 comments on commit 30cd3b8

Please sign in to comment.