serve.rst.inc 1.4 KB

12345678910111213141516171819202122232425262728
  1. .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
  2. .. _borg_serve:
  3. borg serve
  4. ----------
  5. .. code-block:: none
  6. borg [common options] serve [options]
  7. optional arguments
  8. --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 sub-directories is granted implicitly; PATH doesn't need to directly point to a repository.
  9. --restrict-to-repository PATH restrict repository access. Only the repository located at PATH (no sub-directories are considered) is accessible. Can be specified multiple times to allow the client access to several repositories. Unlike --restrict-to-path sub-directories are not accessible; PATH needs to directly point at 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.
  10. --append-only only allow appending to repository segment files
  11. --storage-quota Override storage quota of the repository (e.g. 5G, 1.5T). When a new repository is initialized, sets the storage quota on the new repository as well. Default: no quota.
  12. .. class:: borg-common-opt-ref
  13. :ref:`common_options`
  14. Description
  15. ~~~~~~~~~~~
  16. This command starts a repository server process. This command is usually not used manually.