borg/docs/usage/general/repository-urls.rst.inc

Repository URLs
~~~~~~~~~~~~~~~

**Local filesystem** (or locally mounted network filesystem):

``/path/to/repo`` - filesystem path to repo directory, absolute path

``path/to/repo`` - filesystem path to repo directory, relative path

Also, stuff like ``~/path/to/repo`` or ``~other/path/to/repo`` works (this is
expanded by your shell).

Note: you may also prepend a ``file://`` to a filesystem path to get URL style.

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

``ssh://user@host:port/path/to/repo`` - absolute path`

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

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

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


If you frequently need the same repo URL, it is a good idea to set the
``BORG_REPO`` environment variable to set a default for the repo URL:

::

    export BORG_REPO='ssh://user@host:port/path/to/repo'

Then just leave away the ``--repo`` option if you want
to use the default - it will be read from BORG_REPO then.
[DOCS] #4587 – Make Sphinx warnings break docs build general.rst and man_intro.rst both included usage_general.rst.inc, which resulted in three Sphinx warning "WARNING: duplicate label". To prevent this we move all sections of usage_general into own include files and add a second usage_general file without the three labels. 2020-03-16 18:17:16 +00:00			`Repository URLs`
			`~~~~~~~~~~~~~~~`

			`Local filesystem (or locally mounted network filesystem):`

			``/path/to/repo`` - filesystem path to repo directory, absolute path

			``path/to/repo`` - filesystem path to repo directory, relative path

			Also, stuff like ``~/path/to/repo`` or ``~other/path/to/repo`` works (this is
			`expanded by your shell).`

			Note: you may also prepend a ``file://`` to a filesystem path to get URL style.

			`Remote repositories accessed via ssh user@host:`

build_usage / build_man / doc updates 2022-06-23 23:19:19 +00:00			``ssh://user@host:port/path/to/repo`` - absolute path`
Revert "Remove scp syntax for locations (#6697)" This reverts commit 1b4b84dfd8f1ec2a3aa156fb9cc2714ef6263143. 2022-05-18 15:31:10 +00:00
[DOCS] #4587 – Make Sphinx warnings break docs build general.rst and man_intro.rst both included usage_general.rst.inc, which resulted in three Sphinx warning "WARNING: duplicate label". To prevent this we move all sections of usage_general into own include files and add a second usage_general file without the three labels. 2020-03-16 18:17:16 +00:00			``ssh://user@host:port/./path/to/repo`` - path relative to current directory

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

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

Revert "Remove scp syntax for locations (#6697)" This reverts commit 1b4b84dfd8f1ec2a3aa156fb9cc2714ef6263143. 2022-05-18 15:31:10 +00:00
[DOCS] #4587 – Make Sphinx warnings break docs build general.rst and man_intro.rst both included usage_general.rst.inc, which resulted in three Sphinx warning "WARNING: duplicate label". To prevent this we move all sections of usage_general into own include files and add a second usage_general file without the three labels. 2020-03-16 18:17:16 +00:00			`If you frequently need the same repo URL, it is a good idea to set the`
			``BORG_REPO`` environment variable to set a default for the repo URL:

			`::`

			`export BORG_REPO='ssh://user@host:port/path/to/repo'`

build_usage / build_man / doc updates 2022-06-23 23:19:19 +00:00			Then just leave away the ``--repo`` option if you want
[DOCS] #4587 – Make Sphinx warnings break docs build general.rst and man_intro.rst both included usage_general.rst.inc, which resulted in three Sphinx warning "WARNING: duplicate label". To prevent this we move all sections of usage_general into own include files and add a second usage_general file without the three labels. 2020-03-16 18:17:16 +00:00			`to use the default - it will be read from BORG_REPO then.`