From fc2c92b054e65f600c22da6a63ff044ba8db870d Mon Sep 17 00:00:00 2001 From: Stefan Majewsky Date: Fri, 9 Aug 2019 22:46:57 +0200 Subject: [PATCH] add a push-style example to borg-create(1) (#4613) add a push-style example to borg-create docs When I browsed the readthedocs and manpages while setting up Borg for myself for the first time, I saw multiple hints that pushing backups via SSH is supported (e.g. the existence of the `borg serve` command and the `--rsh` option), but I never found a clear example. I only found after being pointed to it by @ThomasWaldmann. Therefore, an explicit example in the `borg create` documentation seems appropriate. I put it next to the pull-style example using sshfs which serves a similar usecase. --- docs/usage/create.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/usage/create.rst b/docs/usage/create.rst index a5fa21d74..d8e00df21 100644 --- a/docs/usage/create.rst +++ b/docs/usage/create.rst @@ -25,6 +25,10 @@ Examples # use zlib compression (good, but slow) - default is lz4 (fast, low compression ratio) $ borg create -C zlib,6 --one-file-system /path/to/repo::root-{now:%Y-%m-%d} / + # Backup onto a remote host ("push" style) via ssh to port 2222, + # logging in as user "borg" and storing into /path/to/repo + $ borg create ssh://borg@backup.example.org:2222/path/to/repo::{fqdn}-root-{now} / + # Backup a remote host locally ("pull" style) using sshfs $ mkdir sshfs-mount $ sshfs root@example.com:/ sshfs-mount