1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-01-01 12:45:34 +00:00
borg/docs/usage/general/repository-urls.rst.inc
2024-10-14 23:30:12 +02:00

42 lines
1.3 KiB
PHP

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//abs/path/to/repo`` - absolute path
``ssh://user@host:port/rel/path/to/repo`` - path relative to current directory
**Remote repositories** accessed via sftp:
``sftp://user@host:port//abs/path/to/repo`` - absolute path
``sftp://user@host:port/rel/path/to/repo`` - path relative to current directory
For ssh and sftp URLs, the ``user@`` and ``:port`` parts are optional.
**Remote repositories** accessed via rclone:
``rclone:remote:path`` - see the rclone docs for more details about remote:path.
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/rel/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.