mirror of
https://github.com/borgbackup/borg.git
synced 2026-07-10 02:31:22 -04:00
87 lines
No EOL
12 KiB
PHP
87 lines
No EOL
12 KiB
PHP
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
|
|
|
|
.. _borg_serve:
|
|
|
|
borg serve
|
|
----------
|
|
.. code-block:: none
|
|
|
|
borg [common options] serve [options]
|
|
|
|
.. only:: html
|
|
|
|
.. class:: borg-options-table
|
|
|
|
+-------------------------------------------------------+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| **options** |
|
|
+-------------------------------------------------------+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| | ``--rest`` | serve a current (non-legacy) repository as a rest:// server (HTTP over stdio). Requires --backend. Without this option, a legacy (borg 1.x) repository is served. |
|
|
+-------------------------------------------------------+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| | ``--backend BACKEND_URL`` | (with --rest) backend URL of the repository to serve, e.g. FILE:/path/to/repo. |
|
|
+-------------------------------------------------------+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| | ``--restrict-to-path PATH`` | Restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all subdirectories is granted implicitly; PATH does not need to point directly to a repository. |
|
|
+-------------------------------------------------------+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| | ``--restrict-to-repository PATH`` | Restrict repository access. Only the repository located at PATH (no subdirectories are considered) is accessible. Can be specified multiple times to allow the client access to several repositories. Unlike ``--restrict-to-path``, subdirectories are not accessible; PATH must point directly to a repository location. PATH may be an empty directory or the last element of PATH may not exist, in which case the client may initialize a repository there. |
|
|
+-------------------------------------------------------+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| | ``--permissions`` | Set repository permission mode. Overrides BORG_REPO_PERMISSIONS environment variable. |
|
|
+-------------------------------------------------------+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| .. class:: borg-common-opt-ref |
|
|
| |
|
|
| :ref:`common_options` |
|
|
+-------------------------------------------------------+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
.. raw:: html
|
|
|
|
<script type='text/javascript'>
|
|
$(document).ready(function () {
|
|
$('.borg-options-table colgroup').remove();
|
|
})
|
|
</script>
|
|
|
|
.. only:: latex
|
|
|
|
|
|
|
|
options
|
|
--rest serve a current (non-legacy) repository as a rest:// server (HTTP over stdio). Requires --backend. Without this option, a legacy (borg 1.x) repository is served.
|
|
--backend BACKEND_URL (with --rest) backend URL of the repository to serve, e.g. FILE:/path/to/repo.
|
|
--restrict-to-path PATH Restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all subdirectories is granted implicitly; PATH does not need to point directly to a repository.
|
|
--restrict-to-repository PATH Restrict repository access. Only the repository located at PATH (no subdirectories are considered) is accessible. Can be specified multiple times to allow the client access to several repositories. Unlike ``--restrict-to-path``, subdirectories are not accessible; PATH must point directly to a repository location. PATH may be an empty directory or the last element of PATH may not exist, in which case the client may initialize a repository there.
|
|
--permissions Set repository permission mode. Overrides BORG_REPO_PERMISSIONS environment variable.
|
|
|
|
|
|
:ref:`common_options`
|
|
|
|
|
|
|
Description
|
|
~~~~~~~~~~~
|
|
|
|
This command starts a repository server process. It is usually started automatically via
|
|
SSH by a borg client and runs until that SSH connection is terminated.
|
|
|
|
It operates in one of two modes:
|
|
|
|
- default (no option): serve a **legacy** (borg 1.x / v1) repository using the legacy
|
|
RPC protocol. This is used e.g. for ``borg transfer --from-borg1`` and is command-line
|
|
compatible with borg 1.x ``borg serve``.
|
|
|
|
- ``--rest``: serve a **current** (non-legacy) repository as the server-side component of
|
|
a ``rest://`` repository, talking HTTP over stdio. The repository to serve is given via
|
|
``--backend FILE:<path>``. A borg client using a ``rest://`` repository starts this
|
|
automatically (over SSH if a host is given).
|
|
|
|
Please note that, in legacy mode, `borg serve` does not support providing a specific
|
|
repository via the `--repo` option or the `BORG_REPO` environment variable - it is the
|
|
borg client that specifies the repository to use.
|
|
|
|
The --permissions option enforces repository permissions:
|
|
|
|
- `all`: All permissions are granted. (Default; the permissions system is not used.)
|
|
- `no-delete`: Allow reading and writing; disallow deleting and overwriting data.
|
|
New archives can be created; existing archives cannot be deleted. New chunks can
|
|
be added; existing chunks cannot be deleted or overwritten.
|
|
- `write-only`: Allow writing; disallow reading data.
|
|
New archives can be created; existing archives cannot be read.
|
|
New chunks can be added; existing chunks cannot be read, deleted, or overwritten.
|
|
- `read-only`: Allow reading; disallow writing or deleting data.
|
|
Existing archives can be read, but no archives can be created or deleted. |