mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-02-22 22:22:27 +00:00
Code Issues Releases Wiki Activity
6591 commits 9 branches 139 tags 63 MiB
Commit graph

1438 commits

Author SHA1 Message Date
DifficultDerek
85928fe6ae Update usage_general.rst.inc 
- Added "Will move with BORG_CONFIG_DIR variable unless specified." to BORG_SECURITY_DIR info.
- put BORG_SECURITY_DIR immediately below BORG_CONFIG_DIR (and moved BORG_CACHE_DIR up before them).
 2020-02-09 18:34:09 +01:00
finefoot
61b8234704 Add paragraph regarding cache security assumptions (#4900) 
docs: tell about borg cache security precautions
 2020-01-13 12:25:03 +01:00
Thalian
053b0db009 Add FAQ describing difference between a local repo vs. repo on a server. 
Taken from a Q/A on the mailing list.
 2019-12-23 13:13:08 +01:00
TW
66d86b6280
Merge pull request #4789 from ThomasWaldmann/regen-docs-man 
ran python setup.py build_man
 2019-11-02 13:53:58 +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
Thomas Waldmann
451c4dd5de build_man 2019-11-01 18:22:58 +01:00
TW
454dbfcaea
Merge pull request #4813 from Gu1nness/fix-borg-man-page 
Fix the borg(1) man page creation
 2019-11-01 18:09:15 +01:00
Rémi Oudin
5bdf998a21
Fix the borg(1) man page creation 
Now the date is updated every time the page is regenerated.
 2019-10-22 22:17:58 +02:00
Thalian
87abe5d927 Doc/4532 faq retain original paths (#4794) 
More general FAQ for backup and retain original paths, fixes #4532
 2019-10-20 16:51:06 +02:00
Thalian
f07bcb1387 [DOC] #3866 - Add FAQ for preventing SSH timeout in extract. (#4782) 
Add FAQ for preventing SSH timeout in extract, fixes #3866
 2019-10-19 21:19:17 +02:00
Thalian
21dc2b9ca0 [DOC] #4591 - Improve password FAQ (decrease pw length, add -w 0 option to base64 to prevent line wrap). 2019-10-18 21:11:25 +02:00
Christian Paul
8be4007e1b Fix typo: degress -> degrees 2019-09-30 23:57:18 +02:00
Ioannis Cherouvim
76a3dca3db Typo fix (neccessary -> necessary). 2019-09-21 08:59:50 +03:00
Ioannis Cherouvim
b586a6a20e
docs: List items consistency 
Capitalized list items and finished them with a full stop. This was inconsistent.
 2019-09-20 21:19:38 +03:00
Thomas Waldmann
33862f5a50 build_man 2019-09-07 00:36:10 +02:00
Thomas Waldmann
102068bfeb build_usage 2019-09-07 00:27:17 +02:00
Thomas Waldmann
75dcf93563 update CHANGES 2019-09-07 00:25:11 +02:00
Thomas Waldmann
3f63234974 create: make --noatime the default, deprecate --noatime, fixes #4673 
also: add --atime option to enable storing files' atime.
 2019-09-06 21:48:54 +02:00
Thomas Waldmann
de88c87fd0 update CHANGES (master) 2019-08-30 20:55:31 +02:00
Dmitry Astapov
dc1c8c062c Reiterate that 'file cache names are absolute' in FAQ (#4738) 
Reiterate that 'file cache names are absolute'

Drive home the point that relative source names does not save you from re-chunking if absolute pathnames change.

Also: mention bind mount solution.
 2019-08-30 15:29:17 +02:00
Thomas Waldmann
b43d3bb7fa new BORG_WORKAROUNDS mechanism, basesyncfile, fixes #4710 
remove WSL autodetection. if WSL still has this problem, you need to
set BORG_WORKAROUNDS=basesyncfile in the borg process environment to
work around it.

(cherry picked from commit beb948fc71)
 2019-08-27 19:37:40 +05:30
TW
ae2ff8066c
add restore docs, fixes #4670 (#4723) 
add restore docs, fixes #4670
 2019-08-22 23:45:21 +02:00
Endareth
3445d4cca0 Updated doc to cover use of temp directory on remote (#4545) 
docs about remote temp directory usage

Updated doc to cover use of temp directory on remote, in particular how to handle changing the directory used for systems such as QNAP with tiny default /tmp directories.

fixup by tw: do not mention specific brands, specific amounts

this is not QNAP specific, but may happen as well on other limited
systems. the amount of tmp files can also vary widely.
 2019-08-10 00:08:10 +02: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
Stefan Majewsky
fc2c92b054 add a push-style example to borg-create(1) (#4613) 
add a push-style example to borg-create docs

When I browsed the readthedocs and manpages while setting up Borg for
myself for the first time, I saw multiple hints that pushing backups via
SSH is supported (e.g. the existence of the `borg serve` command and the
`--rsh` option), but I never found a clear example. I only found
<https://borgbackup.readthedocs.io/en/stable/usage/general.html#repository-urls>
after being pointed to it by @ThomasWaldmann.

Therefore, an explicit example in the `borg create` documentation seems
appropriate. I put it next to the pull-style example using sshfs which
serves a similar usecase.
 2019-08-09 22:46:57 +02:00
Thomas Waldmann
8622014188 timestamps in the files cache are now usually ctime, fixes #4583 2019-08-09 21:27:30 +02:00
ntova
c2ae9673b4 docs: benchmark crud: clarify that space is used until compact 2019-07-28 15:29:44 +02:00
Tiago Donato
8db4106150
Update documentation of borg create 
Corrects a mention of borg 1.1 as a future version.
 2019-07-15 21:53:30 -05:00
Joachim Breitner
b86aaa606d
RST syntax fix in docs 2019-07-09 10:23:33 +02:00
Russell Davis
3fb5998bae Fix osxfuse github link in installation docs 
It was broken because there's already a different reference named
github in `docs/global.rst.inc`. Fixed by using an anonymous hyperlink
reference, per https://stackoverflow.com/a/14067756/278488
 2019-06-23 19:24:37 -07:00
Elmar Hoffmann
d2595065b4 fix spelling 2019-06-15 13:19:43 +02:00
TW
47fa7a83a7
Merge pull request #4620 from ThomasWaldmann/quickstart-passphrase-providing-master 
how to supply a passphrase, use crypto devices, fixes #4549
 2019-06-10 23:21:59 +02:00
Thomas Waldmann
faae9c9d56 how to supply a passphrase, use crypto devices, fixes #4549 2019-06-10 22:31:29 +02:00
Thomas Waldmann
897e81dbe9 extract: document limitation "needs empty destination", fixes #4598 2019-06-10 21:39:35 +02:00
Thomas Waldmann
dc8077acba remove superfluous whitespace in docs 2019-06-09 14:45:18 +02:00
Sebastiaan Lokhorst
8aafc622e7
docs: update macOS Brew link 2019-05-28 13:44:16 +02:00
Luke Murphy
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
Ori Livneh
92049f5405 Fix reference in FAQ 2019-05-12 13:35:31 -04:00
Thomas Waldmann
3082b1f1eb compact: move --cleanup-commits description from examples to docs 2019-05-06 23:10:07 +02:00
Thomas Waldmann
78cb2b1de5 build_man 2019-04-22 18:00:56 +02:00
Thomas Waldmann
1f527464ab build_usage 2019-04-22 18:00:28 +02:00
Thomas Waldmann
0b65a79a79 update CHANGES (master) 2019-04-22 17:54:43 +02:00
Thomas Waldmann
e74f4adea1 update CHANGES (master) 2019-04-20 18:33:42 +02:00
Mike
ef90cda43a Add "SSH Configuration" section (#4493) 
Add "SSH Configuration" section

Add "SSH Configuration" section to "borg serve" documentation, to outline ssh/sshd configuration to prevent borg serve keeping a lock on a repo in the event the ssh connection is abnormally disconnected.

In response to issues #3988, #636 and #4485 (and probably others).
 2019-04-08 21:10:26 +02:00
Thomas Waldmann
572a778554 build_man 2019-03-21 21:11:46 +01:00
Thomas Waldmann
9c380405a2 build_usage 2019-03-21 21:11:18 +01:00
Thomas Waldmann
f1d23e0963 add release date 2019-03-21 21:08:08 +01:00
Thomas Waldmann
3157809719 update CHANGES (master) 2019-03-21 20:35:13 +01:00
Thomas Waldmann
060fb02112 docs: update requirements, fixes #4374 
also some other minor install docs updates, to be continued...
 2019-03-20 00:01:30 +01:00
Thomas Waldmann
f922cdd803 docs: remove libzmq3* for debian/ubuntu 2019-03-19 23:19:38 +01:00
Thomas Waldmann
f8371898ae docs: mention pkg-config / pkgconfig requirement, fixes #4452 
both are required before invoking setup.py.

also mention libb2 requirement for pkgconfig being able to discover it.
 2019-03-19 23:17:15 +01:00
Thomas Waldmann
e69b8996cc docs: remove zeromq requirement 
borg currently does not use zeromq.
 2019-03-19 23:06:24 +01:00
Thomas Waldmann
22e021a5ce docs: install libcrypt-devel on cygwin 
this is included into Python.h, thus needed when compiling stuff.
 2019-03-19 22:38:09 +01:00
Thomas Waldmann
ad5fbd9485 update CHANGES (master) 
also: markup fixes
 2019-03-17 21:49:30 +01:00
Sitaram Chamarty
884798c3cb add a sample logging.conf in docs/misc (#4380) 
add a sample logging.conf in docs/misc

(and point to it in the man page)
 2019-03-17 15:05:04 +01:00
Alexandr Kozlinskiy
b780c36811 docs: fix spelling errors 2019-03-11 22:40:03 +01:00
Thomas Waldmann
39300d1fd0 docs: fix markup 2019-03-11 00:16:12 +01:00
Thomas Waldmann
1386c67513 build_man 2019-03-11 00:11:50 +01:00
Thomas Waldmann
9507856049 build_usage 2019-03-11 00:11:16 +01:00
Thomas Waldmann
621476b027 release date 2019-03-11 00:08:25 +01:00
TW
65bc71a192
update CHANGES (master) (#4429) 2019-03-11 00:06:43 +01:00
TW
d7c6399396
Merge pull request #4384 from milkey-mouse/append-only-docs-3504 
Elaborate on append-only mode docs
 2019-03-10 15:04:23 +01:00
Thomas Waldmann
7ad5290501 redo stale lock handling, fixes #3986 
drop BORG_HOSTNAME_IS_UNIQUE (please use BORG_HOST_ID if needed)

borg now always assumes it has a unique hostid - either automatically
from fqdn plus uuid.getnode() or overridden via BORG_HOST_ID.
 2019-03-04 21:07:05 +01:00
Thomas Waldmann
abdf5d0706 update CHANGES (master) 2019-03-03 14:16:52 +01:00
jminer74
a2c84215af docs/installation: added Alpine Linux to distribution list (#4414) 
docs/installation: added Alpine Linux to distribution list
 2019-03-01 22:11:48 +01:00
Thomas Waldmann
8b55bb1096 update CHANGES 2019-02-26 22:50:40 +01:00
Thomas Waldmann
032a4effd3 build_man 2019-02-24 20:40:07 +01:00
Thomas Waldmann
bece7e8090 build_usage 2019-02-24 20:39:42 +01:00
Thomas Waldmann
34fa89b26c add release date 2019-02-24 20:34:44 +01:00
Thomas Waldmann
2e5e3a87e1 update CHANGES (master) 2019-02-24 19:23:47 +01:00
Thomas Waldmann
9637c3fbb3 update 1.1.6..1.1.9 sections of CHANGES (from 1.1-maint) 2019-02-24 15:53:02 +01:00
Thomas Waldmann
1344779113 update severe issues section of CHANGES (from 1.1-maint) 2019-02-24 15:50:37 +01:00
Milkey Mouse
cb2b86274e
Elaborate on append-only mode docs 2019-02-22 19:05:29 -08:00
Thomas Waldmann
2713500983 remove -*- coding: ... lines, utf-8 is default for py3 2019-02-22 17:12:05 +01:00
Milkey Mouse
7ea2bd1389
Only modify window.location when redirecting (fixes #4133) 
window.location.pathname = window.location.pathname can trigger a redirect,
which created a refresh loop in usage.html.
 2019-02-20 11:12:45 -08:00
Milkey Mouse
453e4a4b92
Update copyright year 2019-02-19 20:20:13 -08:00
Thomas Waldmann
7f46eb99aa update docs about fixed chunker and chunker algo spec needed 2019-02-13 06:30:13 +01:00
Thomas Waldmann
305efb5b01 signing binaries with Qubes OS support, docs 2019-02-11 02:44:44 +01:00
anarcat
10a4e011c0 add warnings on repository copies to avoid future problem like #4272 (#4285) 
docs: add warnings about repo copies to avoid problems like #4272
 2019-02-10 20:23:59 +01:00
Thomas Waldmann
f7525156c1 update release workflow using twine (docs, scripts), see #4213 2019-02-01 22:07:49 +01:00
Manuel Riel
9ab0a095ab Add --rsh command line option to complement BORG_RSH env var. Fixes #… (#4290) 
Add --rsh command line option to complement BORG_RSH env var. Fixes #1701
 2019-01-31 13:54:17 +01:00
Manuel Riel
7e7d74c1c1 Add new FAQ regarding change of compression settings. Fixes #4222 (#4282) 
FAQ regarding change of compression settings. Fixes #4222
 2019-01-31 05:58:33 +01:00
Manuel Riel
4ecc7ede8d Add note about BSD flags to changelog. Fixes #4246 (#4279) 
Add note about BSD flags to changelog. Fixes #4246
 2019-01-31 05:56:37 +01:00
Manu
b37aceb469 Add FAQ regarding free disk space check. Fixes #3905 2019-01-31 12:45:41 +08:00
Manu
d13ddb224a Update BORG_PASSCOMMAND example and clarify variable expansion. Fixes #4249 2019-01-30 10:12:47 +08:00
step21
a577a63313
Added vorta gui 2019-01-05 21:07:28 +01:00
Greg Grossmeier
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
Thomas Waldmann
2864fb781c update changelog about removed deprecated stuff 2018-12-11 23:55:29 +01:00
Thomas Waldmann
fc6e81c8bb docs: --format is required for some expensive-to-compute values 
borg list by default does not compute expensive values except when
they are needed. whether they are needed is determined by the format,
in standard mode as well as in --json mode.
 2018-12-07 01:18:32 +01:00
Thomas Waldmann
02f3c80d83 docs: tell that our binaries are amd/intel, bauerj has ARM 
(cherry picked from commit 13986a1a6a)
 2018-12-07 00:51:51 +01:00
James Vasile
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
Łukasz Stelmach
548355125e read a passphrase from a file descriptor 
Read a passpharase from a file descriptor specified in the
BORG_PASSPHRASE_FD environment variable.
 2018-09-21 09:11:39 +02:00
newtonne
11a2f1f684 Remove row/column-spanning from docs source, fixes #4000 
Sphinx doesn't support row or column-spanning, which caused the content
of the additional features table to be incorrect. To fix this, we now
define the content of each cell explicitly.

This change also fixes #3990.
 2018-08-09 20:38:46 +01:00
Thomas Waldmann
8a09f26712 remove zeromq or python 3.5 references 2018-08-06 17:52:08 +02:00
Thomas Waldmann
90348c1de9 add BORG_HOST_ID, fixes #3985 2018-08-04 15:01:48 +02:00
James Rowell
34227430d4 Installation from source - setting python interpreter version (#3995) 
explicit instructions for setting python interpreter when installing from source via git
 2018-07-29 09:50:09 +01:00
Marvin Gaube
2a4ed3f0e8 Note regarding borg version (#3987) 
add a note regarding in-file checkpointing and borg versions
 2018-07-20 16:25:16 +02:00
Thomas Waldmann
318cfffde1 update CHANGES about compaction changes 2018-07-14 19:15:09 +02:00
Thomas Waldmann
a8d52351bb update man pages / usage docs 2018-07-14 14:56:29 +02:00
Thomas Waldmann
e6fcf4ea42 update docs about separated compaction 2018-07-14 14:53:23 +02:00
Thomas Waldmann
3fd6bd8ca7 update CHANGES: added 1.1 history (master) 2018-07-08 00:18:09 +02:00
Thomas Waldmann
a89aadc9f2 update CHANGES (master) 2018-07-08 00:13:13 +02:00
Russell Davis
041f1baf4c
Update installation instructions for macOS 
- Updated `OS X` to the new `macOS` name
- Fuse 3.x is no longer just a prerelease
- Added instructions to install fuse via homebrew
 2018-07-06 18:46:18 -07:00
lumbric
bbd1533c99 docs: add link to tempfile module 
Linking tempfile docs helps to figure out, which default value might be
used, if TMPDIR is not set.
 2018-06-25 20:32:44 +02:00
Saurav Sachidanand
b3c1104760 Update docs on deleting multiple archives 2018-05-27 09:38:23 +05:30
TW
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
Thomas Waldmann
d94bd22740 BORG_SHOW_SYSINFO=no to hide system information from exceptions 
Can be used:
- in case of troubles with the sysinfo code
- by borg backup providers who do not want to show system information

(cherry picked from commit 64aaec6628)
 2018-05-18 18:49:56 +02:00
infectormp
8f6be74993 Add note from borg with-lock about copy repo (#3749) 
docs: Improve FAQ about copying a repo
 2018-04-19 15:34:11 +02:00
infectormp
60f9849336 docs: Improve borg with-lock (#3780) 
docs: improve borg with-lock, link to FAQ
 2018-04-19 15:29:47 +02:00
André-Patrick Bubel
1ba0e85621
docs: describe what BORG_LIBZSTD_PREFIX does 2018-04-16 19:12:01 +02:00
TW
b2c141899b
Merge pull request #3710 from ThomasWaldmann/docs-security-fingerprinting 
security: describe chunk size / proximity issue, see #331
 2018-03-24 21:50:17 +01:00
TW
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
Milkey Mouse
d41c9296c0
fixup! Add quickstart introduction to repositories & archives (fixes #3620) 2018-03-24 12:05:47 -07:00
Thomas Waldmann
8ac272f35f security: describe chunk size / proximity issue, see #3687 2018-03-23 17:54:02 +01:00
TW
201c62430a
Merge pull request #3675 from ThomasWaldmann/crypto-compression-docs 
security docs: add about combining compression and encryption
 2018-03-17 19:46:42 +01:00
TW
c206f8b403
Merge pull request #3677 from ThomasWaldmann/docs-avoid-permission-mixup 
quickstart: add note about permissions, borg@localhost, fixes #3452
 2018-03-12 15:18:16 +01:00
TW
6b3191a285
Merge pull request #3678 from ThomasWaldmann/docs-log 
docs: improve logging docs, fixes #3549
 2018-03-12 15:16:47 +01:00
TW
e6978fa2ea
Merge pull request #3680 from ThomasWaldmann/transaction-rollback-docs 
docs: extend append-only repo rollback docs, fixes #3579
 2018-03-12 15:13:53 +01:00
Milkey Mouse
09beb64f34
Add quickstart introduction to repositories & archives (fixes #3620) 2018-03-10 17:19:46 -08:00
Thomas Waldmann
451b22ee51 docs: extend append-only repo rollback docs, fixes #3579 2018-03-09 23:27:31 +01:00
Thomas Waldmann
99be106bc8 docs: improve logging docs, fixes #3549 2018-03-09 20:44:20 +01:00
Thomas Waldmann
7bc2138dcb quickstart: add note about permissions, borg@localhost, fixes #3452 2018-03-09 20:01:38 +01:00
TW
1473ea708c
Merge pull request #3526 from borgbackup/enkore-patch-1 
sec docs: explicitly note what happens OUTSIDE the attack model
 2018-03-09 18:49:32 +01:00
Thomas Waldmann
be8913a93c security docs: add about combining compression and encryption 2018-03-09 18:02:57 +01:00
Thomas Schwinge
2458035057 Mark up Unicode string 
Running Sphinx v1.4.8
    WARNING: the config value 'copyright' is set to a string with non-ASCII characters; this can lead to Unicode errors occurring. Please use Unicode strings, e.g. u'Content'.
    [...]
    Encoding error:
    'ascii' codec can't decode byte 0xc3 in position 23: ordinal not in range(128)
 2018-03-08 11:37:45 +01:00
Josh Holland
9f2f4132ec
Improve formatting of GPG output in documentation 2018-03-05 13:21:20 +00:00
Michael Gajda
74a3058abc Add docs on how to verify a signed release 
Short howto on using gpg to verify a signed binary release.
Fixes #3634
 2018-03-02 21:40:42 +01:00
Jesus Fernandez Manzano
3a0ae9c7f3
[Docs] Update quickstart.rst to fix typo 2018-02-26 10:58:31 +01:00
TW
24b0bcb461
Merge pull request #3589 from Gu1nness/docs 
A few documentation fixes for Documentation issue 19
 2018-02-10 11:31:19 +01:00
Rémi Oudin
88972d7d81 Better formatting of CPU usage documentation 
This is now displayed as a list, with bold fonts for each bullet.
Refers https://github.com/borgbackup/borg/issues/3554
 2018-02-03 17:34:45 +01:00
Alexander 'Leo' Bergolth
74c10e4643 add chunker_params to archive info (at least to json output) 2018-01-25 21:02:39 +01:00
enkore
674ce72fda sec docs: explicitly note what happens OUTSIDE the attack model 2018-01-10 15:30:12 +01:00
TW
4b98393542
Merge pull request #3520 from pngwjpgh/doc/chunk-seed 
Chunk seed is generated per /repository/
 2018-01-10 07:26:26 +01:00
Gregor Kleen
1820e22c02 Chunk seed is generated per /repository/ 2018-01-09 18:17:46 +01:00
Gianfranco Costamagna
0980d6ac43 fixup allows one to, with suggestions from Dan Christensen 2018-01-03 15:54:52 +01:00
Gianfranco Costamagna
111a19f7fa fix typo: allows to -> allows one to 2018-01-03 11:42:38 +01:00
Gianfranco Costamagna
1a74326b5a borg: fix typo: explicitely -> explicitly 2018-01-03 11:42:30 +01:00
Abogical
937736ceb9 Happy new year! 2018-01-02 11:10:07 +02:00
Thomas Waldmann
c5a339384e added BORG_BASE_DIR, s/get_home_dir/get_base_dir/g, docs, fixes #3338 
also: sorted env var docs by level
 2017-12-23 01:42:18 +01:00
Josh Holland
95a05dbbf1
docs: Fix missing apostrophe 2017-12-22 21:44:12 +00:00
Thomas Waldmann
2588e50f0b readme / docs: mention zstd 2017-12-18 22:55:00 +01:00
Thomas Waldmann
061321b668 update requirements and install docs about bundled lz4 and zstd 2017-12-18 22:55:00 +01:00
Thomas Waldmann
fe48caf853 fix lz4 deprecation warning, require lz4 >= 1.7.0 (r129) 
as we bundle lz4 1.8.0 now, platform not having a recent liblz4 can
now just use the bundled code.
 2017-12-18 00:53:26 +01:00
Thomas Waldmann
9b6924d27f rename BORG_LZ4_PREFIX env var to BORG_LIBLZ4_PREFIX 
consistency:
we also have BORG_LIBB2_PREFIX and BORG_LIBZSTD_PREFIX.
 2017-12-18 00:53:26 +01:00
Thomas Waldmann
c8b2820225 bundle lz4 1.8.0 src code, license 2017-12-15 06:33:04 +01:00
Thomas Waldmann
dc883f62ae bundle zstd 1.3.2 source code 
only .c and .h files + license
 2017-12-15 00:29:26 +01:00
Thomas Waldmann
d81ea0321d git add docs/man/borg-config.1 2017-12-13 04:40:20 +01:00
Gregor Kleen
85fb38e2f3 Add placeholder for fqdn in reverse notation 2017-12-11 23:00:38 +01:00
Thomas Waldmann
ce92960c63 add auto-generated docs for borg config 
also: move a bit upwards in the use docs
(cherry picked from commit 278ed640e9)
 2017-12-09 13:43:36 +01:00
Thomas Waldmann
209bf2dc24 move 3rd party docs/license file from package dir to docs/3rd_party 
setup.py excludes all .c .h .pyx files from installation, but such
docs / license files would still be copied to the target directory
if they are inside the python "borg" package dir.

(cherry picked from commit 831a06a07d)
 2017-12-02 18:13:11 +01:00
Thomas Waldmann
63bdae8314 docs: fix broken links 
(cherry picked from commit c7994b598b)
 2017-11-27 00:00:46 +01:00
Thomas Waldmann
c2521a7759 link to the homepage for support/service 
otherwise people ONLY reading the docs (and not coming from the
homepage) will miss these options.

(cherry picked from commit 7438cb2ef4)
 2017-11-26 23:37:04 +01:00
Michael Rupert
6dd54f93ce fixed support links (#3379) 
fixed support links
 2017-11-26 05:10:22 +01:00
Thomas Waldmann
0eaec60384 docs: give examples for borg mount exclusion options 2017-11-25 20:18:59 +01:00
Thomas Waldmann
91ff2f81a6 docs: move bsdflags tuning comments to notes docs section 
the atime comments are already there.
 2017-11-25 20:08:33 +01:00
Thomas Waldmann
a107233f75 docs: document birthtime support on platforms supporting it 
stat.st_birthtime, MacOS and (some?) BSDs.
 2017-11-25 19:51:33 +01:00
Thomas Waldmann
e3cb7c3c32 docs: document good and problematic option placements, see #3356 2017-11-25 19:46:48 +01:00
Thomas Waldmann
f2a1539f25 docs: fix examples with problematic option placements, fixes #3356 
have options to the left OR to the right of all positional arguments,
but not on BOTH sides and not in between them.
 2017-11-25 19:29:34 +01:00
Thomas Waldmann
ef8217afc9 build_man (master) 
also: git add borgfs.1
 2017-11-25 14:38:04 +01:00
Thomas Waldmann
73fac09dda build_usage (master) 
also: add new borgfs.rst.inc
 2017-11-25 14:35:52 +01:00
Michael Rupert
71fbac94fb Moved Support to .org (#3360) 
docs: moved support options to www.borgbackup.org
 2017-11-25 03:15:18 +01:00
TW
c5dc75ae23
Merge pull request #3312 from milkey-mouse/borg-config-cmd 
Add borg config command
 2017-11-24 16:56:15 +01:00
Milkey Mouse
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
TW
483d3e8a8b
Merge pull request #3292 from milkey-mouse/document-ntfsclone 
Add instructions for using ntfsclone
 2017-11-23 22:07:15 +01:00
Milkey Mouse
c0edc60ca6
Move image backup-related FAQ entries to a new page 2017-11-23 12:14:35 -08:00
Milkey Mouse
759c8f77cf Mention break-lock in checkpointing FAQ entry (#3340) 
Mention break-lock in checkpointing FAQ entry, fixes #3328
 2017-11-20 23:18:37 +01:00
TW
22ae15f5b4
Merge pull request #3327 from anarcat/faq-remove 
add FAQ about removing old files and policies
 2017-11-18 21:01:31 +01:00
Milkey Mouse
7cb36a20b4 Document sshfs rename workaround (fixes #3315) (#3325) 
Document sshfs rename workaround, fixes #3315
 2017-11-18 20:57:39 +01:00
Antoine Beaupré
1a2906ae7e add FAQ about removing old files and policies 
This has been asked twice already this year:

https://mail.python.org/pipermail/borgbackup/2017q3/000796.html
https://mail.python.org/pipermail/borgbackup/2017q4/000891.html

... and I was asked again privately today, so this qualifies as FAQ to
me.
 2017-11-18 09:08:37 -05:00
TW
b8dece0ae7
Merge pull request #3290 from milkey-mouse/borgfs-man 
Generate usage & man page for borgfs
 2017-11-12 16:41:54 +01:00
Tom Denley
c6591a7c06 Correct usage of "fewer" in place of "less" 2017-11-11 11:21:45 +00:00
Milkey Mouse
b0d68036c2
Add instructions for zerofree 2017-11-10 11:54:45 -08:00
Milkey Mouse
2b254abb39
Add instructions for ntfsclone (fixes #81) 2017-11-10 11:54:45 -08:00
Milkey Mouse
17d5c794d3
Generate man page for borgfs (fixes #3216) 2017-11-10 11:25:19 -08:00
Milkey Mouse
7b485c23f7 Clarify create --stats duration vs. wall time (fixes #3301) (#3303) 
clarify create --stats duration vs. wall time, fixes #3301
 2017-11-10 17:44:34 +01:00
Thomas Waldmann
818b61935b update release checklist about security fixes 2017-11-06 10:38:04 +01:00
TW
febb7ffca8
Merge pull request #3288 from ThomasWaldmann/doc-updates2 
Doc updates 2
 2017-11-05 22:18:41 +01:00
Thomas Waldmann
e7fd1ff2ee docs: more than 23 is not supported for CHUNK_MAX_EXP, fixes #3115 2017-11-05 21:35:58 +01:00
Thomas Waldmann
61d6c58241 update / rephrase cygwin / WSL status, fixes #3174 2017-11-05 19:24:49 +01:00
TW
ddecd4b618
Merge pull request #3182 from TBurchfield/master 
Removal of |project_name|.
 2017-11-01 02:41:02 +01:00
TW
c640e3815b
Merge pull request #3236 from narendravardi/borg_config_dir_documentation 
Added documentation for BORG_CONFIG_DIR
 2017-10-30 06:49:43 +01:00
narendravardi
764a62f42c Added documentation for BORG_CONFIG_DIR 2017-10-29 21:52:33 +05:30
Milkey Mouse
87a9952f3b
Clarify using a blank passphrase in keyfile mode 2017-10-25 19:42:02 -07:00
Svein Ove Aas
98443f15d5 Add Nix/NixOS install command 2017-10-20 17:08:10 +01:00
8bit
8d830d069f Removed all |project_name 
| instances, replaced with Borg
 2017-10-17 11:50:55 -05:00
Thomas Waldmann
e674822888 remove hardlinked symlinks warning, update docs, fixes #3175 
the warning was annoying for people with a lot of such items and
they can not do anything about it anyway.

thus, just document this as a limitation.
 2017-10-17 18:34:32 +02:00
Thomas Waldmann
ed1a8b5cf1 add example showing --show-version --show-rc 2017-10-12 06:03:12 +02:00
Fabio Pedretti
bc42f58c04 use --format rather than --list-format in examples, the latter is 
deprecated
 2017-10-09 14:09:43 +02:00
Thomas Waldmann
62e0f7a64e manpage: fix typos, update homepage 2017-10-07 03:34:03 +02:00
Thomas Waldmann
fe08437337 faq: we do not implement futile attempts of ETA / progress displays 2017-10-05 22:19:39 +02:00
Timothy Burchfield
21601d5f53 Quickstart guide minor corrections (#3084) 
quickstart: minor grammar correction and added consistency with substitution of 'Borg'
 2017-10-03 23:18:33 +02:00
Thomas Waldmann
5e2de8ba67 implement files cache mode control, fixes #911 
You can now control the files cache mode using this option:

--files-cache={ctime,mtime,size,inode,rechunk,disabled}*

(only some combinations are supported)

Previously, only these modes were supported:
- mtime,size,inode (default of borg < 1.1.0rc4)
- mtime,size (by using --ignore-inode)
- disabled (by using --no-files-cache)

Now, you additionally get:
- ctime alternatively to mtime (more safe), e.g.:
  ctime,size,inode (this is the new default of borg >= 1.1.0rc4)
- rechunk (consider all files as changed, rechunk them)

Deprecated:
- --ignore-inodes (use modes without "inode")
- --no-files-cache (use "disabled" mode)

The tests needed some changes:
- previously, we use os.utime() to set a files mtime (atime) to specific
  values, but that does not work for ctime.
- now use time.sleep() to create the "latest file" that usually does
  not end up in the files cache (see FAQ)
 2017-10-01 00:52:32 +02:00
Alexander Meshcheryakov
f7ec13eabb Simplified rate limiting wrapper in FAQ 
Exporting $RATE as environment variable is not need in this case.

And example does not use any bash specific features.
It should use default system shell instead.
 2017-09-25 15:43:07 +03:00
Thomas Waldmann
112bf43956 docs: twitter account @borgbackup, fixes #2948 2017-09-22 23:36:48 +02:00
Thomas Waldmann
d8766df998 docs: add note about metadata dedup and --no[ac]time, fixes #2518 2017-09-22 23:08:33 +02:00
Thomas Waldmann
3f16d91fd3 docs: add auto compression example to borg create examples 2017-09-21 14:00:50 +02:00
Thomas Waldmann
0ec6c920b9 docs: add compressor names to be more clear 2017-09-21 04:28:35 +02:00
Thomas Waldmann
c88528512f fix docs: --compression lz4 is the default now, fixes #3034 2017-09-21 04:26:52 +02:00
TW
133e847f8e document utf-8 locale requirement for json mode, #2273 (#3009) 2017-09-08 08:31:51 +02:00
Markus Engelbrecht
e157328228 Use correct casing for macOS 2017-09-03 20:04:28 +02:00
Markus Engelbrecht
aadb9cd2ee Fix macOS keychain integration command 2017-09-03 20:03:11 +02:00
Marian Beermann
10a7b6b727 docs/internals: note segment size limitation 2017-08-22 17:48:48 +02:00
Marian Beermann
ab4981eff6 always use microseconds for ISO 8601 output 2017-08-22 17:32:25 +02:00
Marian Beermann
2ff29891f1 list: fix weird mixup of mtime/isomtime 2017-08-22 17:32:21 +02:00
Marian Beermann
a836f451ab one datetime formatter to rule them all 
# Conflicts:
#	src/borg/helpers.py
 2017-08-22 17:32:21 +02:00
Lukas Fleischer
03dea8c78b development.rst: Miscellaneous improvements (#2944) 
development.rst: misc. improvements

* Improved wording / grammar.
* Use proper Git terminology for operations on patches.
* Unify capitalization of "GitHub".
* Add proper formatting to branch names.
 2017-08-19 21:12:51 +02:00
enkore
132b618cbe Merge pull request #2930 from enkore/mtpleasant 
adjust logo colour to a more pleasant green
 2017-08-16 17:51:18 +02:00
Marian Beermann
fd21893591 revert logo colour to #00dd00 (per @TW) 2017-08-16 17:50:59 +02:00
enkore
11653d8bc2 Merge pull request #2920 from lfos/detect-attic-repos 
Detect non-upgraded Attic repositories
 2017-08-16 17:47:02 +02:00
Lukas Fleischer
0943b322e3 Detect non-upgraded Attic repositories 
When opening a repository, always try to read the magic number of the
latest segment and compare it to the Attic segment magic (unless the
repository is opened for upgrading). If an Attic segment is detected,
raise a dedicated exception, telling the user to upgrade the repository
first.

Fixes #1933.
 2017-08-15 19:58:30 +02:00
rugk
df8205a4ba Renew asciinema/screencasts 
Created with borg v1.1.0, so more up-to-date and split into different
parts (install, basic, advanced)…
Fixes https://github.com/borgbackup/borg/issues/669
 2017-08-14 21:07:52 +02:00
Marian Beermann
671418a794 docs: adjust CSS to updated logo colour 2017-08-13 16:52:28 +02:00
Marian Beermann
9b0c03ba48 docs: delete unused CSS directives 2017-08-13 16:52:20 +02:00
Marian Beermann
0b37e59217 logo: add makefile to create PNG and PDF versions from master SVG 2017-08-13 16:49:44 +02:00
Marian Beermann
cfb4a5fbd0 adjust logo colour to a more pleasant green 2017-08-13 16:49:44 +02:00
Thomas Waldmann
a5c6a50ebe increase Python minimum requirement to 3.5.0 
also:
- drop testing on 3.4
- add some TODO for the docs and vagrant machines
 2017-07-29 20:55:04 +02:00
Marian Beermann
55e0c43c53 add zeromq dependency 2017-07-29 11:58:01 +02:00
Marian Beermann
405e5ac9e1 docs: common options: don't wrap options 2017-07-26 13:57:48 +02:00
Marian Beermann
8727b79325 docs: don't narrow right margin in sidebar toc 
avoids overly narrow text in the FAQ toc
 2017-07-26 13:54:55 +02:00
Marian Beermann
2ff4550d4b docs: tar: tarpipe example 2017-07-26 10:40:35 +02:00
enkore
77797a2fbf Merge pull request #2837 from milkey-mouse/fix392 
Detail how to use macOS/GNOME/KDE keyrings for repo passwords (fixes #392)
 2017-07-24 11:03:00 +02:00
Thomas Waldmann
43ecde1bde python setup.py build_usage 2017-07-23 17:12:01 +02:00
Thomas Waldmann
6b08ec78bb add release date to CHANGES 2017-07-23 17:07:43 +02:00
Thomas Waldmann
6c39c1c515 update CHANGES (master) 2017-07-23 17:00:56 +02:00
enkore
eb3e7604d8 Merge pull request #2836 from enkore/docs/installation 
Cleanup installation
 2017-07-23 16:04:47 +02:00
Marian Beermann
b3e0dd3761 docs: file system requirements, update segs per dir 2017-07-23 16:03:45 +02:00
TW
d806d5213d fix checkpoints/parts reference in FAQ, fixes #2859 (#2861) 
fix checkpoints/parts reference in FAQ, fixes #2859
 2017-07-23 01:47:13 +02:00
TW
c2f7e738ba Merge pull request #2846 from wzyboy/segment-filename 
Document consequences of changing the segments_per_dir value
 2017-07-21 22:23:13 +02:00
Zhuoyun Wei
f0de6a4c90
Doc: add warning about changing segments_per_dir values 2017-07-21 12:26:24 -04:00
Zhuoyun Wei
7d07a9629e
Doc: update default values in sample config file 2017-07-21 12:26:17 -04:00
Marian Beermann
cc93cbb202 docs: usage; remove strange blurb about tested platforms 2017-07-21 12:32:30 +02:00
Marian Beermann
735339c209 docs: streamline installation: platforms table 2017-07-21 12:32:30 +02:00
Marian Beermann
ab773956c1 docs: streamline installation (2) 
I can't give a good reason why anyone would care about this here.
This is right before distribution packages, which are per definition
compatible (sometimes tested, even).

Instead, mention it where it applies.
 2017-07-21 12:32:30 +02:00
Marian Beermann
3d5a8016e6 docs: streamline installation: file systems 2017-07-21 12:32:30 +02:00
enkore
a61462693a docs: recreate: fix wrong "remove unwanted files" example 2017-07-21 11:51:46 +02:00
rugk
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
Milkey Mouse
756dea7e20
Detail how to use macOS/GNOME keyrings for repo passwords (fixes #392) 2017-07-19 14:20:28 -07:00
TW
26bc80f210 Merge pull request #2818 from takluyver/i2815 
Use code markup for command line option headings
 2017-07-15 17:01:05 +02:00
TW
fafa18b0a9 Merge pull request #2824 from takluyver/i2811 
Name backup directories with 'before-upgrade'
 2017-07-15 16:56:58 +02:00
Thomas Kluyver
ae2a1b8135 Name backup directories with 'before-upgrade' 
Closes gh-2811
 2017-07-15 16:23:08 +02:00
Thomas Kluyver
0edad19ee0 Update source-install about doc dependencies 
Closes gh-2795
 2017-07-15 15:49:55 +02:00
Thomas Kluyver
0fcdb97f5d Fix cross reference 2017-07-15 15:03:46 +02:00
Thomas Kluyver
84940e32b2 Use code markup for command line options 
Closes gh-2815
 2017-07-15 15:02:41 +02:00
Antonio Larrosa
6c7b9a338c Fix openSUSE command and add openSUSE section 
Fix the name of the borgbackup package in openSUSE and
add an openSUSE section on how to install development dependencies
to build borgbackup from sources.
 2017-07-04 12:27:58 +02:00
Marian Beermann
946f1a4eec docs: mount: show usage of archive filters 
this is pretty vital, since the versions view is basically
useless without them.
 2017-07-02 22:15:14 +02:00
Thomas Waldmann
51458b6b58 FUSE versions view: keep original file extension at end, fixes #2769 
some tools depend on seeing the correct file extension to operate
correctly, so put our version to the left of the file extension.
 2017-07-02 19:11:24 +02:00
Marian Beermann
f6c3d1d2cc docs: no third level toc on command usage pages ("Description", "Examples") 2017-06-30 17:41:58 +02:00
Marian Beermann
52f76d2cd6 docs: mount: add repository example 2017-06-30 10:54:18 +02:00
Marian Beermann
4009a764ed docs: info: update and add examples 
The form of the output has changed and
new output has been added.
 2017-06-29 11:49:27 +02:00
Thomas Waldmann
7ebad4f803 FUSE vs. fuse 2017-06-24 01:24:14 +02:00