89e4a52c56
docs: misc. updates
...
- remove outdated stuff
- fix infos for borg 2.0
2022-08-03 11:35:25 +02:00
c7ed985ffd
Merge branch 'master' into borg2
2022-07-02 23:28:39 +02:00
6888d5dcb2
remove -P (aka --prefix) option, fixes #6806
...
-a (aka --glob-archives) can be used for same purpose and is more powerful.
2022-07-02 20:52:41 +02:00
e577ccb094
Merge pull request #6755 from fantasya-pbem/docs/5960_FAQ-quota-size
...
[DOCS] #5960 - FAQ: Full quota / full disk
2022-06-29 14:42:11 +02:00
51cf85e627
build_usage / build_man / doc updates
2022-06-25 21:58:19 +02:00
036eb97f03
[DOCS] #5960 - FAQ: Full quota / full disk
2022-06-24 17:55:14 +02:00
4902398554
[DOCS] Remove unnecessary/dangerous line continuation
2022-06-10 21:21:52 +03:00
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
61299d23db
Revert "Remove scp syntax for locations ( #6697 )"
...
This reverts commit 1b4b84dfd8
2022-05-18 17:31:10 +02:00
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
298c5ee539
docs: security infos only applying to legacy encryption
2022-03-26 17:05:57 +01:00
b4f54399d8
minor rewrite to make it less confusing (get rid of "Avoid to create a mixup") ( #5490 )
...
docs: permissions note rewritten to make it less confusing
Original wording was confusing "Avoid to create a mixup of users and permissions in your repository (or cache)." is not clear, what should be avoided?
Also implement some feedback of @jdchristensen.
Co-authored-by: Thomas Waldmann <tw@waldmann-edv.de>
2022-01-22 20:21:36 +01:00
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
ed5d3dfe24
fix small typo in quickstart docs
2020-10-12 19:33:45 +02:00
bfbb1ca525
[DOCS] Move content of resources doc page to community project, #2088
2020-04-19 19:13:02 +02:00
25ab198d41
[DOCS] #4883 – Doc downplays severity of Nonce reuse issue ( #5082 )
...
docs: Borg documentation downplays severity of Nonce reuse issue, fixes #4883
2020-04-05 23:31:08 +02:00
f7f2493f75
docs: reflow some really long lines
...
I used `grep -Pnr '.{100}' *.rst` to find lines >100 characters long and
reflowed them where reasonable. Line length in the docs isn't too important (it
doesn't matter once they're compiled), but it's nice not to have super-long
lines in one's editor.
2020-03-11 16:27:57 -07:00
ae2ff8066c
add restore docs, fixes #4670 ( #4723 )
...
add restore docs, fixes #4670
2019-08-22 23:45:21 +02:00
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
faae9c9d56
how to supply a passphrase, use crypto devices, fixes #4549
2019-06-10 22:31:29 +02:00
3f55841591
Add note for software for automating backup docs
...
Closes https://github.com/borgbackup/borg/issues/4581 .
2019-05-21 12:48:03 +02:00
b311b62e0d
Docs: Improve logging in example automation script ( #4226 )
...
docs: improve logging in example automation script
* add an info entry for the compacting step
* add a final info entry for successful completion
2018-12-21 18:54:58 +01:00
806d937c2e
4081 - Add note about files changing during backup ( #4116 )
...
Add note about files changing during backup
2018-11-01 21:11:05 +01:00
e6fcf4ea42
update docs about separated compaction
2018-07-14 14:53:23 +02:00
485368d50d
docs: fix and deduplicate encryption quickstart docs ( #3776 )
...
docs: fix and deduplicate encryption quickstart docs
just refer to "borg init" docs rather than duplicating it in quickstart.
also: s/archive/repository/
2018-05-23 14:17:01 -07:00
b6b8e1bb16
Merge pull request #3683 from milkey-mouse/repo-archive-quickstart
...
Add quickstart introduction to repositories & archives (fixes #3620 )
2018-03-24 21:31:27 +01:00
d41c9296c0
fixup! Add quickstart introduction to repositories & archives ( fixes #3620 )
2018-03-24 12:05:47 -07:00
09beb64f34
Add quickstart introduction to repositories & archives ( fixes #3620 )
2018-03-10 17:19:46 -08:00
7bc2138dcb
quickstart: add note about permissions, borg@localhost, fixes #3452
2018-03-09 20:01:38 +01:00
3a0ae9c7f3
[Docs] Update quickstart.rst to fix typo
2018-02-26 10:58:31 +01:00
2588e50f0b
readme / docs: mention zstd
2017-12-18 22:55:00 +01:00
5b47cf6fa5
Add borg config command ( fixes #3304 )
...
This command works similarly to "git config" - it parses repo and
cache configs to get, set, and delete values. It only works on local
repos so a malicious client can't e.g. override their storage quota
or reset the append_only flag.
Add tests for borg config
Add documentation for borg config
Change manual config edits -> borg config
There were a couple places in the documentation where it was advised
to edit the repository or cache config file, a process that is stream-
lined by borg config.
2017-11-23 14:51:54 -08:00
8d830d069f
Removed all |project_name
...
| instances, replaced with Borg
2017-10-17 11:50:55 -05:00
8db0c770c3
The user frees space, not borg
2017-10-03 16:32:58 -04:00
821baf0528
Minor grammar correction and added consistency with subsistitution of 'Borg'
2017-10-03 13:21:28 -04:00
c5c361be0c
Fix bashism in shell scripts ( #2820 )
...
Fix bashism in shell scripts, also fixes #2816
This makes the scripts fully POSIX-compatible.
Used shellcheck to check.
2017-07-20 00:23:59 +02:00
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
aa7fbff55f
docs: quickstart: delete problematic BORG_PASSPRHASE use
2017-06-06 21:29:31 +02:00
578b76af3a
Added BORG_PASSCOMMAND environment variable ( #2573 )
2017-05-31 19:25:21 +02:00
1bbfb24d1a
quickstart: fix rst issue
2017-03-03 15:27:17 +01:00
c190a87eef
Improve automated backup script in doc fixes #2214
2017-03-02 05:48:30 +02:00
332f7898bc
update docs for create -C default change
2017-02-26 23:07:31 +01:00
e0f36e8613
quickstart.rst: Add link to paperkey template.
2017-02-13 20:45:49 +01:00
fa24e1f38f
man pages: add borg(1) master/intro page
2017-02-12 15:28:59 +01:00
85cebd0419
Merge branch 'partial-1.0-maint' into merge/1.0-maint
2016-12-20 23:05:44 +01:00
880578da06
quickstart: use prune with --list
...
so people are better aware of what's happening, avoiding pitfalls
with wrong or missing --prefix.
2016-12-20 23:03:32 +01:00
c83a124e65
Merge branch '1.0-maint' (into master)
2016-11-28 02:23:32 +01:00
a49fc6faf5
Clarify extract is relative to current directory
...
I'm still hoping that a destination switch can be added (requested long ago in https://github.com/jborg/attic/issues/195 ), but in the meantime this may help. I'm guessing this clobbers any existing files.
2016-11-27 11:35:36 -08:00
c8c0495724
faster quickstart
...
move the note about free space after the step by step example. it is
unlikely that users will hit out of space conditions on their first
run, and at the end of the example, they will see the not anyways.
this is to make the documentation less scary for new users and easier
to use.
2016-11-03 14:17:55 -04:00
8a15916284
Merge branch '1.0-maint' into merge-1.0-maint
...
# Conflicts:
# docs/changes.rst
# docs/usage/help.rst.inc
# src/borg/cache.py
# src/borg/remote.py
# src/borg/testsuite/__init__.py
# src/borg/testsuite/archiver.py
2016-10-31 18:24:13 +01:00
Thomas Waldmann