From a1e1ce552c466ce822b10dbf837be897a271f41d Mon Sep 17 00:00:00 2001 From: Jerry Jacobs Date: Fri, 15 Jan 2016 19:06:20 +0100 Subject: [PATCH] Update README.md with doc|stable shield, minor markup fixes on docs/deployment.rst --- README.rst | 16 ++++++++++------ docs/deployment.rst | 36 ++++++++++++++++++++---------------- 2 files changed, 30 insertions(+), 22 deletions(-) diff --git a/README.rst b/README.rst index 2a6814792..780a914ea 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,8 @@ |screencast| -.. |screencast| image:: https://asciinema.org/a/28691.png - :alt: BorgBackup Installation and Basic Usage - :target: https://asciinema.org/a/28691?autoplay=1&speed=2 - - What is BorgBackup? =================== + BorgBackup (short: Borg) is a deduplicating backup program. Optionally, it supports compression and authenticated encryption. @@ -165,7 +161,11 @@ THIS IS SOFTWARE IN DEVELOPMENT, DECIDE YOURSELF WHETHER IT FITS YOUR NEEDS. Borg is distributed under a 3-clause BSD license, see `License`_ for the complete license. -|build| |coverage| +|doc| |build| |coverage| + +.. |doc| image:: https://readthedocs.org/projects/borgbackup/badge/?version=stable + :alt: Documentation + :target: http://borgbackup.readthedocs.org/en/stable/ .. |build| image:: https://travis-ci.org/borgbackup/borg.svg :alt: Build Status @@ -174,3 +174,7 @@ for the complete license. .. |coverage| image:: https://codecov.io/github/borgbackup/borg/coverage.svg?branch=master :alt: Test Coverage :target: https://codecov.io/github/borgbackup/borg?branch=master + +.. |screencast| image:: https://asciinema.org/a/28691.png + :alt: BorgBackup Installation and Basic Usage + :target: https://asciinema.org/a/28691?autoplay=1&speed=2 diff --git a/docs/deployment.rst b/docs/deployment.rst index 0cd10d973..f60467df0 100644 --- a/docs/deployment.rst +++ b/docs/deployment.rst @@ -15,9 +15,10 @@ respective fully qualified domain name (fqdn). * The backup server: `backup01.srv.local` * The clients: - * John Doe's desktop: `johndoe.clnt.local` - * Webserver 01: `web01.srv.local` - * Application server 01: `app01.srv.local` + + - John Doe's desktop: `johndoe.clnt.local` + - Webserver 01: `web01.srv.local` + - Application server 01: `app01.srv.local` User and group -------------- @@ -40,10 +41,11 @@ The following folder tree layout is suggested on the repository server: * User home directory, /home/backup * Repositories path (storage pool): /home/backup/repos -* Clients restricted paths: `/home/backup/repos/` - * johndoe.clnt.local: `/home/backup/repos/johndoe.clnt.local` - * web01.srv.local: `/home/backup/repos/web01.srv.local` - * app01.srv.local: `/home/backup/repos/app01.srv.local` +* Clients restricted paths (`/home/backup/repos/`): + + - johndoe.clnt.local: `/home/backup/repos/johndoe.clnt.local` + - web01.srv.local: `/home/backup/repos/web01.srv.local` + - app01.srv.local: `/home/backup/repos/app01.srv.local` Restrictions ------------ @@ -62,7 +64,7 @@ forced command and restrictions applied as shown below: borg serve --restrict-path /home/backup/repos/", no-port-forwarding,no-X11-forwarding,no-pty -**NOTE** The text shown above needs to be written on a single line! +.. note:: The text shown above needs to be written on a single line! The options which are added to the key will perform the following: @@ -74,23 +76,25 @@ The options which are added to the key will perform the following: Due to the cd command we use, the server automatically changes the current working directory so the client will not need to append the hostname to the remote URI. -**NOTE** The setup above ignores all client given commandline parameters which are -normally appended to the `borg serve` command. +.. note:: The setup above ignores all client given commandline parameters + which are normally appended to the `borg serve` command. Client ------ The client needs to initialize the `pictures` repository like this: -`borg init backup@backup01.srv.local:pictures` + borg init backup@backup01.srv.local:pictures Or with the full path (should actually never be used, as only for demonstrational purposes). The server should automatically change the current working directory to the `` folder. -`borg init backup@backup01.srv.local:/home/backup/repos/johndoe.clnt.local/pictures` + borg init backup@backup01.srv.local:/home/backup/repos/johndoe.clnt.local/pictures When `johndoe.clnt.local` tries to access a not restricted path the following error is raised. -John Doe tries to backup into the Web 01 path: `borg init backup@backup01.srv.local:/home/backup/repos/web01.srv.local/pictures` +John Doe tries to backup into the Web 01 path: + + borg init backup@backup01.srv.local:/home/backup/repos/web01.srv.local/pictures :: @@ -108,7 +112,7 @@ satisfied and reproducable. Automate setting up an repository server with the user, group, folders and permissions a Ansible playbook could be used. Keep in mind the playbook -uses the Arch Linux `pacman`_ +uses the Arch Linux `pacman `_ package manager to install and keep borg up-to-date. :: @@ -156,5 +160,5 @@ and no other interpreter or apllication has to be deployed. See also -------- -* `SSH Daemon manpage`_ -* `Ansible`_ +* `SSH Daemon manpage `_ +* `Ansible `_