From ed14fdbac9844e8fc55a732a7bcebbfd7826fa59 Mon Sep 17 00:00:00 2001 From: Luke Murphy Date: Sun, 12 May 2019 01:14:30 +0200 Subject: [PATCH] Recommend root user package install This can do bad things to a system Python install. So, we try to mitigate this by recommending a root user user site installation. --- docs/how-to/set-up-backups.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/how-to/set-up-backups.md b/docs/how-to/set-up-backups.md index c1cbd21..e8b266d 100644 --- a/docs/how-to/set-up-backups.md +++ b/docs/how-to/set-up-backups.md @@ -7,16 +7,24 @@ To get up and running, first [install Borg](https://borgbackup.readthedocs.io/en/latest/installation.html), at least version 1.1. -Then, run the following command to download and install borgmatic: +Borgmatic consumes configurations in `/etc/borgmatic/` and `/etc/borgmatic.d/` +by default. Therefore, we show how to install borgmatic for the root user which +will have access permissions for these locations by default. + +Run the following commands to download and install borgmatic: ```bash -sudo pip3 install --upgrade borgmatic +sudo pip3 install --user --upgrade borgmatic ``` +This is a [recommended user site +installation](https://packaging.python.org/tutorials/installing-packages/#installing-to-the-user-site). +You will need to ensure that `/root/.local/bin` is available on your `$PATH` so +that the borgmatic executable is available. + Note that your pip binary may have a different name than "pip3". Make sure you're using Python 3, as borgmatic does not support Python 2. - ### Other ways to install Along with the above process, you have several other options for installing