1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-31 20:26:40 +00:00
Commit graph

53 commits

Author SHA1 Message Date
Thomas Waldmann
1bc5902718
docs: update about archive series
in borg 1.x, we used to put a timestamp into the archive name to make
it unique, because borg1 required that.

borg2 does not require unique archive names, but it encourages you
to even use an identical archive name within the same SERIES of archives.
that makes matching (e.g. for prune, but also at other places) much
simpler and borg KNOWS which archives belong to the same series.
2024-09-18 14:05:12 +02:00
Eddie Carswell
9fe3cb686f
Update repository URLs in docs to use new syntax
Fixes #8361

Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
2024-09-11 22:03:59 -05:00
Thomas Waldmann
ace97fadec
docs: updates / removing outdated stuff 2024-09-08 12:00:50 +02:00
Thomas Waldmann
5e3f2c04d5
remove archive checkpointing
borg1 needed this due to its transactional / rollback behaviour:
if there was uncommitted stuff in the repo, next repo opening automatically
rolled back to last commit. thus we needed checkpoint archives to reference
chunks and commit the repo.

borg2 does not do that anymore, unused chunks are only removed when the
user invokes borg compact.

thus, if a borg create gets interrupted, the user can just run borg create
again and it will find some chunks are already in the repo, making progress
even if borg create gets frequently interrupted.
2024-09-07 22:00:54 +02:00
Ruben Rodriguez
6978584de6
docs: align /etc/backups path in all references 2024-08-01 15:31:38 +02:00
Thomas Waldmann
6121d3d2e6
docs: remove tabs 2024-02-25 12:14:52 +01:00
Stephan Herbers
274cd8f121 add restore considerations paragraph 2024-02-24 21:17:22 +01:00
Stephan Herbers
96ae9f73eb Apply suggestions from code review
Co-authored-by: NetSysFire <59517351+NetSysFire@users.noreply.github.com>
2024-02-24 21:17:09 +01:00
Stephan Herbers
a06c42cf1f add non-root deployment strategy 2024-02-24 21:17:01 +01:00
zDEFz
c4decb4fff
make SERIAL backup method compatible to borg2 2023-11-13 20:23:52 +01:00
zDEFz
6bbd327dc2
Added backup by serial method documentation (#7932)
docs: create disk/partition sector backup by disk serial number
2023-11-13 13:45:19 +01:00
TW
56dfc6dc04
Merge pull request #7567 from azrdev/patch-1
automated-local.rst: use GPT UUID for consistent udev rule
2023-07-11 00:06:25 +02:00
azrdev
27bcc0f05a
automated-local.rst: Partition table UUID match works for MBR too
not only GPT
2023-06-16 23:28:36 +02:00
Thomas Waldmann
fbf463496b
docs: fix some markup / linking issues 2023-06-11 23:03:21 +02:00
azrdev
843496dac9
automated-local.rst: use GPT UUID for consistent udev rule 2023-05-14 14:52:39 +02:00
Dominik Stadler
753419d506 Suggest to use forced command when using remote-fowarding via ssh 2023-04-02 22:58:37 +02:00
Dominik Stadler
d2ff0a3aab Adjust description some more, use back-quotes properly, add some links 2023-04-02 11:15:21 +02:00
Dominik Stadler
6ab281875e Adjust repository path 2023-04-02 11:05:31 +02:00
Dominik Stadler
8fab4e4152 Fix command and add more notes 2023-04-02 11:03:32 +02:00
Dominik Stadler
4216dfd12d Describe performing pull-backups via ssh remote forwarding 2023-04-02 10:52:36 +02:00
Paul D
253d8e8d4e Docs grammar fixes
joined split infinitives, and relocated adverbs appropriately.
2022-12-29 22:26:54 +00:00
Paul D
a85b643866 Docs grammar fixes.
One cannot "to not x", but one can "not to x".
Avoiding split infinitives gives the added bonus that machine
translation yields better results.

setup (n/adj) vs set(v) up. We don't "I setup it" but "I set it up".

Likewise for login(n/adj) and log(v) in, backup(n/adj) and back(v) up.
2022-12-29 00:01:48 +00:00
Thomas Waldmann
ad7c7159b2 Merge branch 'master' into borg2 2022-07-27 13:49:50 +02:00
a1346054
160dd877ab
fix typos 2022-07-22 15:51:46 +00:00
Thomas Waldmann
dbe62b8074 docs: replaced tabs by spaces 2022-07-05 00:32:57 +02:00
Thalian
b4d3859b9e #6407 - Document Borg 1.2 pattern behavior change
Make clear that absolute paths always go into the matcher as if they are relative (without leading slash). Adapt all examples accordingly.

fixes #6407
2022-05-27 14:13:12 +02:00
Thomas Waldmann
61299d23db Revert "Remove scp syntax for locations (#6697)"
This reverts commit 1b4b84dfd8.
2022-05-18 17:31:10 +02:00
Emil M George
1b4b84dfd8
Remove scp syntax for locations (#6697)
remove scp syntax support from cli and from Location parser, add note about converting scp-style URLs to ssh-style, fixes #6691
2022-05-15 21:55:19 +02:00
Michael Bauer
638774761c
use --numeric-ids in pull doc
replace flag --numeric-owner with --numeric-ids
2022-03-09 21:43:22 +01:00
Andrey Bienkowski
dbfef31783
borg serve: improve ssh forced commands docs (#6083)
borg serve: improve ssh forced commands docs

Co-authored-by: Andrey Bienkowski <hexagon-recursion@posteo.net>
2021-12-10 18:11:25 +01:00
TW
1e7c1414b0 Merge pull request #5902 from ThomasWaldmann/pull-chroot-problematic-1.1
docs: pull mode: add some warnings, fixes #5827
2021-07-11 18:07:14 +02:00
Matthew R. Trower
1e01aca301 docs: remove /var/cache exclusion in example commands
This is generally a poor idea and shouldn't be promoted through examples.

Fixes #5625
2021-02-12 14:32:33 -06:00
Robin Schneider
fb38ba579f
Use HTTPS everywhere (mechanical edit using util from https-everywhere)
Ref: https://github.com/EFForg/https-everywhere/tree/master/utils/rewriter

```Shell
~/src/EFForg/https-everywhere/utils/rewriter/rewriter.js .
```

A few changes were reset/fixed manually before the commit.
2020-12-22 16:36:40 +01:00
Nehalenniæ Oudin
810d82395d
Complete documentation on append-only remote repos (#5519)
improve docs/FAQ about append-only remote repos, fixes #5497
2020-12-06 15:53:39 +01:00
Guinness
3278d253c5
Update the documentation on hacked backup client.
Fixes #5480.
2020-11-13 10:31:05 +01:00
Samuel BF
7e60a5e052 Rephrasing doc on deployement with ansible 2020-11-06 14:28:27 +01:00
Samuel-BF
e18649d2d2 Doc / Deployment with ansible: pacman -> package
Using "package" ansible module make the ansible playbook able to run
against most unix OSes. Pacman module only works with Arch and derivatives.

Also : changing state from "latest" to "present". Ansible should not be
a way to keep your system up-to-date : it's a configuration management
system and, as such, should not change anything if neither the playbook
nor the machine changed its state (idempotency).

Reference : https://github.com/ansible/ansible-lint/blob/master/lib/ansiblelint/rules/PackageIsNotLatestRule.py#L24
2020-11-06 14:28:01 +01:00
Aleksey Korol
aef5e89126
Add ssh-agent pull backup method to doc (#5288)
deployment docs: add ssh-agent pull backup method

Co-authored-by: Король Алексей <a.korol@npp-crts.ru> (main work)
Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de>
2020-09-25 14:20:29 +02:00
nod0n
c8efc4a944
fix typo 2020-09-03 17:12:54 +02:00
Benedikt Seidl
6a1f31bf29
[DOCS] Add socat pull mode (#5150)
docs: describe socat pull mode, fixes #900

also: fix sphinx deprecation warning

borg/docs/conf.py:114: RemovedInSphinx40Warning: The app.add_stylesheet() is deprecated. Please use app.add_css_file() instead.
2020-06-23 02:09:35 +02:00
Thalian
d0054f4482 [DOC] linked recommended restrictions to ssh public keys on borg servers in faq, #4946
fixes #4946
2020-04-08 03:02:50 +02:00
Thalian
08a7661e67 [FEATURE] #4489 – Deprecate --nobsdflags option
Replaced by --noflags. In internal data structure the key 'bsdflags' is kept for backwards compatibility.
2020-03-25 06:35:15 +01:00
Thalian
a89539439e #1552 Deployment Pull Backup (#4804)
docs: add a pull backup / push restore how-to, fixes #1552
2019-11-02 13:48:32 +01:00
ntova
627ca1376b Fix various code blocks in the docs (#4708)
Fix various code blocks in the docs

- rst markup: put codeblock markup on separate line to make it better visible / separate it from normal text colons.

- borg help texts in archiver.py: put codeblock markup instead of colon - that way it looks like a single colon when using the cli help and also works as code block markup.
2019-08-09 23:13:11 +02:00
Thomas Waldmann
061321b668 update requirements and install docs about bundled lz4 and zstd 2017-12-18 22:55:00 +01:00
Milkey Mouse
c0edc60ca6
Move image backup-related FAQ entries to a new page 2017-11-23 12:14:35 -08:00
enkore
36d22ae240 Merge pull request #2732 from rugk/docs-sshrestrict
Simplify ssh authorized_keys file
2017-06-23 16:16:34 +02:00
rugk
41248bbab1
Add legacy note & normalize order 2017-06-23 14:50:00 +02:00
rugk
b27b9894d1
Simplify ssh authorized_keys file
Just using "restrict"; closes https://github.com/borgbackup/borg/issues/2121
2017-06-23 13:28:49 +02:00
Marian Beermann
5aa865c8d8 docs: double backticks for --options 2017-06-17 12:27:53 +02:00