Commit Graph

103 Commits (efa4d13111bc2fd091599be905e90730309d7275)

Author SHA1 Message Date
oldherl a488096869 doc: README.md: fix typo 2023-07-14 19:40:18 +02:00
Axel Burri 5c561d8c14 documentation: tidy --dry-run, --print-schedule examples 2022-11-16 01:37:12 +01:00
Christoph Anton Mitterer af2d7b2c99 documentation: use "example.org" in examples
`mydomain.com` is actually a real domain and shouln’t be used in examples.

RFC 2606 (respectively RFC 6761) reserves `example.org` (and others) for that
purpose.

Signed-off-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
2022-11-12 15:19:24 +01:00
Christoph Anton Mitterer 1287547df0 documentation: use "restrict" in authorized_keys for further hardening
Since `btrbk` executes only commands, it shouldn’t need any of what’s currently
disabled with the `restrict` flag in the `authorized_keys` file, that is:
Port-, agent- and X11-forwarding as well as PTY allocation and execution of
`~/.ssh/rc`.

Signed-off-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
2022-11-12 15:17:28 +01:00
Merlin Büge a8a5051f79 documentation: README.md: replace "resume" with "robust recovery"
There was some confusion about it, see the discussion in
https://github.com/digint/btrbk/issues/196
2022-05-29 17:45:10 +02:00
Merlin Büge 1d4a502ee3 documentation: fix small typos and rephrase some parts 2022-05-29 17:21:29 +02:00
Axel Burri 9e32df5f90 documentaion: README.md: rephrase donate section 2022-05-29 16:02:00 +02:00
znerol c5273a8745 documentation: fix openssh website URL 2021-11-06 17:24:52 +01:00
Axel Burri 89ea680ce2 documentation: README.md: consequently depict commands with hash 2021-08-09 19:06:20 +02:00
Axel Burri 1eee2c0d2e documentation: README.md: add non-volume examples 2021-08-09 19:06:20 +02:00
Ingmar Lippert fa3204cd7e documentation: README.md: fix spelling
spelling correction
2021-08-08 20:36:23 +02:00
Axel Burri 907a5065ab documentation: add "resume" example; rephrase "ondemand" example 2021-08-06 16:55:53 +02:00
Axel Burri 2616028326 documentation: README.md: rephrase note on ubuntu @subvol notation 2021-07-17 15:36:59 +02:00
Axel Burri e110cc3e91 documentation: README.md: mention mandatory mounting of subvolid=5 2021-07-15 14:51:30 +02:00
Axel Burri 88d4cc76f3 documentation: move to irc.libera.chat 2021-05-27 23:26:38 +02:00
Axel Burri fb792f67a3 documentation: README.md: mention common subvol naming 2021-04-20 21:02:51 +02:00
Axel Burri e6cec73c8f documentation: README.md: mention btr_pool mount point 2021-04-20 21:02:51 +02:00
Axel Burri 3ba8c41e2f documentation: README.md: rephrase ssh setup
- move ssh_filter_btrbk down
 - move "further considerations" to "restrict access"
2021-03-21 13:28:18 +01:00
Axel Burri fb11acf991 documentation: README.md: capital words in titles 2021-03-20 15:49:05 +01:00
Axel Burri 7f721afff5 documentation: README.md: improve ssh setup section 2021-03-20 15:46:13 +01:00
Axel Burri c1fa4aa73e documentation: README.md: rephrase time-machine example 2021-03-20 13:56:37 +01:00
Olivier Croquette 3bba963784 documentation: README.md: put simple example first
Until now the main README.md started with a pretty complex example, making
the learning curve unnecessary steep for new users. Start instead with the
simplier example with the local snapshots of 'home'. It was even simplified
a bit more to serve as good introduction, and step-by-step instructions were
added.
2021-03-20 13:56:37 +01:00
Axel Burri ef7ad3205e documentation: README.md: rephrase dryrun recommentation 2021-03-20 13:55:58 +01:00
Axel Burri d0cf56fb67 documentation: rephrase key features; mention offline storage 2021-01-10 16:23:00 +01:00
Axel Burri 359c240108 documentation: mention action "extents" in key features 2021-01-10 16:22:54 +01:00
Axel Burri 15d4a01b37 documentation: README.md: rephrase backup from non-btrfs source 2020-12-02 20:39:33 +01:00
Axel Burri 7b652b6227 documentation: strictly use capital letter at beginning of sentence 2020-12-02 20:09:00 +01:00
Axel Burri 838e132942 Makefile: change BINDIR from "/usr/sbin" to "/usr/bin"
With "backend btrfs-progs-btrbk" and "backend btrfs-progs-sudo", btrbk
does not necessarily need to be run as root.
2020-09-23 14:37:42 +02:00
Axel Burri dff05bc6d7 documentation: README.md: add common rsync options 2020-08-29 12:34:49 +02:00
Axel Burri 73b339fe01 documentation: fix spelling 2020-02-09 16:14:50 +01:00
Axel Burri d9e9f01e51 documentation: README.md: rewrite "restoring backups" chapter 2020-01-07 23:16:44 +01:00
Axel Burri 0c77219a62 documentation: README.md: fix backup restore example
Especially dont recommend deleting the transferred subvolume, this
would break incremental chain for subsequent backups.
2020-01-05 00:04:55 +01:00
Axel Burri 1b533f2340 documentation: README.md: add instructions for downloading latest master 2020-01-02 17:59:20 +01:00
asymmetric 3694a38670 documentation: README.md: replace pv with mbuffer
Since 0.29, mbuffer is used instead of pv.
2019-10-30 18:24:35 +01:00
Axel Burri 725a284f16 documentation: README.md: adapt indentation in examples 2019-04-24 19:22:30 +02:00
Axel Burri f5c7c74108 documentation: simplify examples, remove optional "send-receive" on "target" declarations 2019-04-24 19:22:29 +02:00
Axel Burri e7793d9e06 documentation: README.md: add example command line for quick additional snapshot 2019-04-20 14:51:31 +02:00
Axel Burri 88b737d4b7 documentation: README.md: add multiple groups in virtual machine setup 2019-04-20 14:49:05 +02:00
Ian Kelling ce15c19e44 Clarify license is gpl version 3 or later
https://www.gnu.org/licenses/identify-licenses-clearly.en.html
2019-04-16 11:04:16 -04:00
Axel Burri 2e51de1047 documentation: README.md: add example: virtual machine setup 2019-04-01 20:12:38 +02:00
Axel Burri 8abaed26c5 documentation: README.md: bump dependency >= btrfs-progs-4.12 (as of btrbk-0.27.0)
dependency introduced in:

0acbf74c btrbk: add btrfs_subvolume_list_complete: fetch all subvolumes with all flags
2019-01-04 15:49:10 +01:00
Axel Burri 49adbe6e28 documentation: README.md: explain send/receive using parent when restoring backups 2018-10-13 14:24:26 +02:00
Axel Burri d324f0d338 documentation: README.md: remove "upgrading from v0.22.2" section
This is more than two years old, everybody should have newer btrbk
release by now.

Note: "doc/upgrade_to_v0.23.0.md" is still available.
2018-10-13 13:29:14 +02:00
Axel Burri c2a344fed1 documentation: move installation instructions from README.md to doc/install.md 2018-10-13 13:29:08 +02:00
Axel Burri 0a4fb02eeb documentation: change links to https 2018-10-10 23:11:44 +02:00
Axel Burri f7ef5139de documentation: rephrase ssh setup; cleanup 2018-10-10 00:58:38 +02:00
Axel Burri 57bc86b7a9 README.md: mention github source code repository 2017-10-13 14:02:50 +02:00
Axel Burri fa5309ee81 README.md: change git clone URL from git:// to https://
For security reasons, using the git:// protocol is discouraged.
2017-10-13 13:51:10 +02:00
Axel Burri d941ecfce9 documentation: change digint links to https:// 2017-10-11 20:54:41 +02:00
Axel Burri 15dde32126 documentation: fix broken links 2017-10-11 20:54:41 +02:00