Commit cf1f94e8 authored by remy's avatar remy
Browse files

updating README sections

parent 620e09a3
...@@ -13,6 +13,8 @@ Then, check the `pillar.example` file to manage your borg server(s). ...@@ -13,6 +13,8 @@ Then, check the `pillar.example` file to manage your borg server(s).
## Usage ## Usage
### Server
The `borbackup.server` formula will then add the borg user on the server. The `borbackup.server` formula will then add the borg user on the server.
```bash ```bash
...@@ -20,6 +22,8 @@ The `borbackup.server` formula will then add the borg user on the server. ...@@ -20,6 +22,8 @@ The `borbackup.server` formula will then add the borg user on the server.
salt '$minion_borg_server' -v state.sls borgbackup.server salt '$minion_borg_server' -v state.sls borgbackup.server
``` ```
### SSH keys
In order to add the client rsa key, you may need to create the key. In order to add the client rsa key, you may need to create the key.
In that case, you will just have to apply that formula: In that case, you will just have to apply that formula:
...@@ -34,11 +38,13 @@ salt '*' mine.update ...@@ -34,11 +38,13 @@ salt '*' mine.update
salt '$minion_borg_server' -v state.sls borgbackup.add_clients salt '$minion_borg_server' -v state.sls borgbackup.add_clients
``` ```
To configure backup directories, please take a look at `hosts212.pillar.example`. ### Client configuration and packages
To configure backup directories, please take a look at `hosts212.pillar.example`. For a more general client configuration, change the template `client/borgmatic.config.yaml`. You may need to overwrite it with a more complex pillar...
`borgbackup.client` will then look at `RsyncShareName` values and `BackupFilesExclude` (I kept the BackupPC naming format for formula compatibility). `borgbackup.client` will then look at `RsyncShareName` values and `BackupFilesExclude` (I kept the BackupPC naming format for formula compatibility).
The borgclient recipe installs `borgbackup` and [`borgmatic`](https://torsion.org/borgmatic/) using pip3. The borgclient recipe installs `borgbackup` and [`borgmatic`](https://torsion.org/borgmatic/) using `pip3`.
`borgmatic` allows us to use an easier way to manage the borg backups. `borgmatic` allows us to use an easier way to manage the borg backups.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment