1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-27 10:18:12 +00:00
Commit graph

539 commits

Author SHA1 Message Date
Thomas Waldmann
4b73ebc613 update readthedocs urls, fixes #991 2016-04-29 03:19:27 +02:00
Thomas Waldmann
8662202486 update CHANGES 2016-04-16 02:39:22 +02:00
Thomas Waldmann
956e9957b2 update CHANGES 2016-04-16 00:59:59 +02:00
Thomas Waldmann
43b4fda393 docs: fix confusing usage of "repo" as archive name 2016-04-15 03:38:43 +02:00
Thomas Waldmann
bc854e3e64 docs: use /path/to/repo, fixes #901
/mnt/backup was confusing as people like to mount their backup disk on /mnt/backup,
but borg init /mnt/backup does not work if that directory already exists because it is
the mountpoint. it would work, if /mnt was the mountpoint, but that is not obvious
and also unusual.
2016-04-15 03:35:37 +02:00
Thomas Waldmann
68e870795d update CHANGES 2016-04-15 03:09:18 +02:00
Thomas Waldmann
6a3f2d7864 update CHANGES 2016-04-08 23:41:15 +02:00
Thomas Waldmann
d5d037b97d ran build_api build_usage 2016-04-08 23:38:46 +02:00
Thomas Waldmann
e9b3b3fa1a updated CHANGES 2016-04-08 19:52:47 +02:00
TW
a519333376 add --warning, --error, --critical for completeness, fixes #826
it's not recommended to suppress warnings or errors,
but the user may decide this on his own.

note: --warning is not given to borg serve so a <= 1.0.0 borg
will still work as server. it is not needed as it is the default.
2016-04-03 20:20:48 +02:00
TW
86361fd75f update CHANGES
the password roundtrip was already in 1.0.0, removed it from 1.0.1 changes.
rephrase / prettify some stuff.
2016-04-03 17:49:37 +02:00
Thomas Waldmann
2f74d2e288 update CHANGES 2016-03-31 21:44:43 +02:00
wormingdead
1cc053bee4 Document logo font. Recreate logo png. Remove GIMP logo file. 2016-03-31 21:37:30 +02:00
Thomas Waldmann
c35dbac44b update CHANGES 2016-03-31 21:28:35 +02:00
Marian Beermann
8f6ce9051b append-only mode: docs reformulated 2016-03-31 18:52:40 +02:00
Marian Beermann
effa992d22 append-only mode: use single file for log, disallow check --repair, docs 2016-03-31 18:23:08 +02:00
Thomas Waldmann
40dbb7411c fix cygwin requirements (gcc-g++) 2016-03-21 16:11:43 +01:00
Thomas Waldmann
b6966a56dc document how to debug / file filesystem issues, fixes #664
if the filesystem issue can't be reproduced with a known-good,
local fs like ext4 on linux, the issue is likely not borg's fault.
2016-03-12 00:48:26 +01:00
alexskc
2931891352 CSS !important overwrite. Fix borgbackup/borg#727 2016-03-09 19:01:49 -06:00
Thomas Waldmann
95c4cf221d implement password roundtrip, fixes #695 2016-03-05 16:21:44 +01:00
Thomas Waldmann
96702ec1e3 prepare CHANGES for 1.0.0 2016-03-05 14:46:28 +01:00
Thomas Waldmann
fa797655a6 updated CHANGES 2016-03-05 02:23:01 +01:00
TW
fbc4172c73 Merge pull request #705 from manwegit/feature/docs-bwlimit
Faq: how to limit bandwidth
2016-03-02 15:49:55 +01:00
Thomas Waldmann
1324ef51a9 changes: fix old chunker params, fixes #698 2016-03-02 14:22:52 +01:00
Teemu Toivanen
9883b1af51 Faq: how to limit bandwidth
Example to faq documentation how bandwidth limiting can be done with pipeviewer.
2016-03-02 08:40:16 +02:00
Thomas Waldmann
66c5735b58 update CHANGES 2016-02-28 00:35:02 +01:00
Thomas Waldmann
3ae8a95935 ran build_api and build_usage 2016-02-27 20:55:14 +01:00
Thomas Waldmann
1ce41da704 update CHANGES, 1.0.0rc2 2016-02-27 20:53:05 +01:00
Thomas Waldmann
af2eaaabd4 update and improve docs
use the travis status image as png as svg does not show an image in firefox.
2016-02-27 17:22:56 +01:00
Thomas Waldmann
6561ad46e2 CHANGES: move compat notes to top 2016-02-26 00:57:50 +01:00
Thomas Waldmann
d6fb77f2c6 update CHANGES 2016-02-26 00:56:10 +01:00
Teemu Toivanen
a94471dc0e Usage examples for create format tags 2016-02-25 00:41:24 +02:00
Thomas Waldmann
08a7ce5cc3 Merge branch 'feature/list-formatting' of https://github.com/manwegit/borg into feature/list-formatting 2016-02-21 19:15:31 +01:00
TW
4c31e7a4bd Merge pull request #687 from ThomasWaldmann/fix-attic-changelog
fix ReST syntax for old attic changelog
2016-02-21 17:25:26 +01:00
Thomas Waldmann
5bfb1df873 fix ReST syntax for old attic changelog 2016-02-21 17:24:34 +01:00
jungle-boogie
1d4f591691 updated freeBSD docs
With the now improved steps, I was able to build Borg on a vagrant image:
% borg -V
borg 1.0.0rc2.dev40+ngfb83f61
2016-02-20 14:12:57 -08:00
jungle-boogie
fdf1dd75dd freebsd fuse for mount for #649 2016-02-20 10:24:43 -08:00
TW
a44c1f5092 Merge pull request #676 from ThomasWaldmann/block-dev-restore-docs
docs: add example how to restore a raw device, fixes #671
2016-02-18 22:54:52 +01:00
Thomas Waldmann
347778b749 docs: add example how to restore a raw device
also: do not use /dev/sda in case someone stupidly tries out the examples.
/dev/sdx should be safe for people who do not understand what they do.
2016-02-18 21:38:31 +01:00
Thomas Waldmann
5e5911dd49 docs: add a hint about the dev headers needed when installing from source 2016-02-18 21:30:44 +01:00
TW
89b2421ed4 Merge pull request #667 from ThomasWaldmann/add-delete-docs
docs: add examples for delete (and handle delete after list, …
2016-02-17 01:00:51 +01:00
Thomas Waldmann
91f10e1a29 docs: update example for borg create -v --stats (use iso datetime format), fixes #663
the code already was updated after 1.0.0rc1, but not the quickstart docs.
2016-02-17 00:43:05 +01:00
Thomas Waldmann
0b44944b47 docs: add examples for delete (and handle delete after list, before prune), fixes #656 2016-02-17 00:30:33 +01:00
jhemmje
bf31fe3173 docs: Updated examples in usage.rst, fixes #644 2016-02-15 21:38:11 +01:00
jhemmje
7e7c33c3cf docs: Updated examples in quickstart.rst, fixes #644 2016-02-15 21:38:02 +01:00
jhemmje
aeec29545e docs: Updated examples in deployment.rst, fixes #644 2016-02-15 21:37:50 +01:00
Mark Lopez
2b8083bb20 Fixed typo. 2016-02-08 19:54:20 -06:00
Mark Lopez
99a3bab68d Added example to BORG_RSH documentation. 2016-02-07 22:07:30 -06:00
Thomas Waldmann
b1dacd8861 CHANGES minor fixes 2016-02-08 01:11:03 +01:00
Thomas Waldmann
5ffb0fd7cd borg upgrade: add to docs that only LOCAL repos are supported 2016-02-07 21:08:20 +01:00
Thomas Waldmann
6db6c22cd4 docs: add faq entry and point to issue 636 2016-02-07 21:01:49 +01:00
Thomas Waldmann
50a82e97dd update CHANGES 2016-02-07 19:45:32 +01:00
Thomas Waldmann
6c278e2e85 docs: formatting fixed 2016-02-07 19:33:26 +01:00
Thomas Waldmann
316f5a345f docs: borg upgrade also handles borg 0.xx -> 1.0 2016-02-07 19:23:06 +01:00
Thomas Waldmann
2f95c8ea79 docs: use pip extras or requirements file to install llfuse 2016-02-07 19:15:30 +01:00
Thomas Waldmann
c2edfab237 all FUSE related version requirements in 1 place 2016-02-07 19:08:03 +01:00
Thomas Waldmann
69300e473d document and automate llfuse requirement 2016-02-07 19:03:32 +01:00
Thomas Waldmann
c42f3d07f4 run build_usage 2016-02-07 14:50:39 +01:00
Thomas Waldmann
2170d6e502 fix order in release process docs
it is important to first do all the changes that modify the release contents,
then tag/sign it, then build the binaries via vagrant.

Only then the binaries will have the correct version number.
2016-02-07 14:44:49 +01:00
Thomas Waldmann
8a8f0263c8 update CHANGES for 1.0.0rc1 2016-02-07 03:01:26 +01:00
Thomas Waldmann
94451cd2e8 update CHANGES 2016-02-06 20:24:20 +01:00
Teemu Toivanen
14f0fa6f6a archive file listing output formatting
Coding style fixup
Add --list-format exmaple to usage examples
2016-02-05 21:07:04 +02:00
Thomas Waldmann
4355150efa docs: OS X binary does not work for older OS X releases, fixes #629 2016-02-04 20:48:43 +01:00
Thomas Waldmann
435d30d61b docs: updates and fixes 2016-02-01 03:22:02 +01:00
Thomas Waldmann
0a0f483daa docs about borg serve's special support for forced/original ssh commands, fixes #544 2016-02-01 01:18:37 +01:00
Robin Schneider
a7ed461394
Use --one-file-system instead of --do-not-cross-mountpoints in docs.
Related to #296 in which support for `--do-not-cross-mountpoints` has
been deprecated.
2016-01-31 11:54:01 +01:00
Robin Schneider
57b0ab7475
Fixed spelling in deployment docs. 2016-01-31 11:50:06 +01:00
Thomas Waldmann
a65b7ec339 updates CHANGES 2016-01-30 23:05:40 +01:00
TW
5d93b6cda9 Merge pull request #613 from ThomasWaldmann/xdg-base-dir-keys
use xdg base dir for keys
2016-01-30 20:02:38 +01:00
Thomas Waldmann
7773e632db fix some minor cosmetic code/docs issues 2016-01-30 00:01:13 +01:00
Thomas Waldmann
e06b7162c2 update docs / docstring about new key location 2016-01-28 23:15:49 +01:00
Thomas Waldmann
824e548b9f add missing example for --list option of borg create 2016-01-28 20:32:30 +01:00
Adam Kouse
dcffa5c6a2 Single quote exclude line that includes an asterisk to prevent shell expansion 2016-01-26 11:51:38 -05:00
Gianfranco Costamagna
37eb22ad55 Delete Ubuntu Vivid, EOL
Ubuntu Vivid is not supported anymore.
2016-01-25 09:07:30 +01:00
Thomas Waldmann
d2bfa24814 update CHANGES 2016-01-24 17:54:36 +01:00
Thomas Waldmann
1fc99ec9cd update docs, remove references to passphrase mode 2016-01-24 16:04:00 +01:00
Thomas Waldmann
b2dedee3c8 refactor yes(), cleanup env var semantics, fixes #355
refactorings:

- introduced concept of default answer:

if the answer string is in the defaultish sequence, the return value of yes() will be the default.
e.g. if just pressing <enter> when asked on the console or if an empty string or "default" is
in the environment variable for overriding.

if an environment var has an invalid value and no retries are enabled: return default
if retries are enabled, next retry won't use the env var again, but either ask via input().

- simplify:

only one default - this should be a SAFE default as it is used in some special conditions
like EOF or invalid input with retries disallowed.

no isatty() magic, the "yes" shell command exists, so we could receive input even if it is not from a tty.

- clean:

separate retry flag from retry_msg
2016-01-24 16:04:00 +01:00
Thomas Waldmann
6d615ec30a change encryption to be on by default (repokey mode)
it's 2015, let's be safe-by-default and unsafe-as-option.

also: show default mode in builtin help
2016-01-24 15:44:09 +01:00
Thomas Waldmann
169634f2ca change the builtin default for --chunker-params, create 2MiB chunks, fixes #343
one of the biggest issues with borg < 1.0 was that it had a default target chunk
size of 64kiB, thus it created a lot of chunks, a huge chunk management overhead
(high RAM and disk usage).
2016-01-24 15:44:09 +01:00
Thomas Waldmann
a2843bc939 docs: require python 3.4+
remove references to older pythons.
2016-01-24 14:57:48 +01:00
Thomas Waldmann
9ea79d738e add chunks.archive.d trick to FAQ 2016-01-23 22:57:26 +01:00
Thomas Waldmann
f4561e813f update CHANGES 2016-01-23 21:43:24 +01:00
Thomas Waldmann
dee1d462cc ran setup.py build_usage 2016-01-23 20:54:20 +01:00
Thomas Waldmann
162d94b2e4 ran setup.py build_api 2016-01-23 20:52:04 +01:00
Thomas Waldmann
541bbd4a5b add --list requirement hint 2016-01-23 15:21:38 +01:00
Michael Hanselmann
14934dab08 Update changes for shell-style pattern support 2016-01-23 11:05:17 +01:00
Antoine Beaupré
da7bc4af94 add netbsd install instructions 2016-01-22 14:35:53 -05:00
TW
068c68b24c Merge pull request #584 from hansmi/shell-pattern
Add shell-style pattern syntax
2016-01-22 20:14:37 +01:00
Thomas Waldmann
92969ea5f1 add gcc gcc-c++ to redhat/fedora/corora install docs 2016-01-22 14:03:48 +01:00
Michael Hanselmann
c7fb598ab9 Add shell-style pattern syntax
The fnmatch module in Python's standard library implements a pattern
format for paths which is similar to shell patterns. However, “*”
matches any character including path separators. This newly introduced
pattern syntax with the selector “sh” no longer matches the path
separator with “*”. Instead “**/” can be used to match zero or more
directory levels.
2016-01-21 16:07:24 +01:00
Thomas Waldmann
854215b7dd mention pp: in CHANGES 2016-01-20 01:00:35 +01:00
Thomas Waldmann
2dde49f0d4 update CHANGES 2016-01-19 01:02:14 +01:00
Piotr Pawlow
987aaa34df Added SSH key options to the usage example. 2016-01-18 18:49:07 +01:00
Piotr Pawlow
a3fa965ded Added no-agent-forwarding,no-user-rc to SSH key options. 2016-01-18 18:39:11 +01:00
Piotr Pawlow
7851df089a Disable unneeded SSH features in authorized_keys example for security. 2016-01-18 14:35:11 +01:00
Robin Schneider
32900c8679
Mi does stand for a IEC binary prefix e.g. 2^20. 2016-01-18 10:38:55 +01:00
Robin Schneider
665c3db2e9
Improved understandability of sentence in deployment.rst.
Thanks to @xor-gate.

Related to https://github.com/borgbackup/borg/pull/529/files#r49952612
2016-01-18 09:32:51 +01:00
Robin Schneider
1f49d16a71
Fixed my changes. Thanks to @ThomasWaldmann for the review! 2016-01-18 09:00:07 +01:00
Robin Schneider
8b9ae0ae92
More – → -- (CLI) fixes. Fixed spelling. AES-256 is used.
* According to the comment in `borg/key.py`.
2016-01-17 23:49:54 +01:00
Robin Schneider
576348a9d4
Use HTTPS everywhere. Especially when the website already redirects to HTTPS. 2016-01-17 22:31:08 +01:00
Robin Schneider
89ce86a33b
Fixed more in usage.rst. - → –; – → -- (CLI); Bullet list. 2016-01-17 22:23:54 +01:00
Robin Schneider
83c5321f53
Fixed RST warning markup. 2016-01-17 20:13:45 +01:00
Robin Schneider
19eb8e2d3b
Use `--option` in RST to not render "--" as "–". 2016-01-17 20:12:23 +01:00
Thomas Waldmann
2f05e4add9 use the usual commandline arguments order for borg prune examples, fixes #560
borg prune <options> <repo>
2016-01-16 20:57:22 +01:00
TW
f35ba0b577 Merge pull request #559 from ThomasWaldmann/metastream-chunker
finer chunker granularity for items metadata stream, fixes #547, fixes #487
2016-01-15 22:42:20 +01:00
Thomas Waldmann
888e078382 use finer chunker granularity for items metadata stream, fixes #547, fixes #487
the items metadata stream is usually not that big (compared to the file content data) -
it is just file and dir names and other metadata.

if we use too rough granularity there (and big minimum chunk size), we usually will get no deduplication.
2016-01-15 20:56:21 +01:00
Jerry Jacobs
a1e1ce552c Update README.md with doc|stable shield, minor markup fixes on docs/deployment.rst 2016-01-15 20:02:42 +01:00
Gianfranco Costamagna
e644dae793 Move to my ppa and add Trusty/Vivid packages 2016-01-15 13:55:04 +01:00
Thomas Waldmann
d08c51bdfc add gource video to resources docs, fixes #507 2016-01-15 10:34:05 +01:00
Danny Edel
6cedfbede9 Correct small typos in changes and usage 2016-01-15 09:24:00 +01:00
TW
b6c47bad23 Merge pull request #554 from ThomasWaldmann/update-docs
update docs / make them more clear about -v
2016-01-14 22:02:12 +01:00
TW
1f795551f9 Merge pull request #546 from ThomasWaldmann/simple-man-page
sphinx configuration: fix to create a simple man page from usage docs
2016-01-14 19:37:04 +01:00
Thomas Waldmann
8ce84cab30 update docs / make them more clear about -v 2016-01-14 19:34:07 +01:00
TW
95fd2248f6 Merge pull request #497 from hansmi/master
Implement exclusions using regular expressions
2016-01-14 14:32:34 +01:00
TW
3a18248d08 Merge pull request #529 from xor-gate/doc-deployment
Docs: deployment example
2016-01-13 22:39:30 +01:00
Antoine Beaupré
77238d175c fix table syntax and links 2016-01-13 15:23:34 -05:00
Antoine Beaupré
cd14b766ca add NixOS 2016-01-13 15:18:19 -05:00
Antoine Beaupré
178b9dc151 sort OS list alphabetically 2016-01-13 15:18:03 -05:00
Antoine Beaupré
3e434ce6fb mention debian testing, ubuntu backport 2016-01-13 15:17:54 -05:00
Jerry Jacobs
a7c1419b6e docs/deployment: Add borg storage server setup example 2016-01-13 21:06:03 +01:00
Michael Hanselmann
2bafece093 Implement exclusions using regular expressions
The existing option to exclude files and directories, “--exclude”, is
implemented using fnmatch[1]. fnmatch matches the slash (“/”) with “*”
and thus makes it impossible to write patterns where a directory with
a given name should be excluded at a specific depth in the directory
hierarchy, but not anywhere else. Consider this structure:

  home/
  home/aaa
  home/aaa/.thumbnails
  home/user
  home/user/img
  home/user/img/.thumbnails

fnmatch incorrectly excludes “home/user/img/.thumbnails” with a pattern
of “home/*/.thumbnails” when the intention is to exclude “.thumbnails”
in all home directories while retaining directories with the same name
in all other locations.

With this change regular expressions are introduced as an additional
pattern syntax. The syntax is selected using a prefix on “--exclude”'s
value. “re:” is for regular expression and “fm:”, the default, selects
fnmatch. Selecting the syntax is necessary when regular expressions are
desired or when the desired fnmatch pattern starts with two alphanumeric
characters followed by a colon (i.e. “aa:something/*”). The exclusion
described above can be implemented as follows:

  --exclude 're:^home/[^/]+/\.thumbnails$'

The “--exclude-from” option permits loading exclusions from a text file
where the same prefixes can now be used, e.g. “re:\.tmp$”.

The documentation has been extended and now not only describes the two
pattern styles, but also the file format supported by “--exclude-from”.

This change has been discussed in issue #43 and in change request #497.

[1] https://docs.python.org/3/library/fnmatch.html

Signed-off-by: Michael Hanselmann <public@hansmi.ch>
2016-01-13 17:39:19 +01:00
Thomas Waldmann
7420ea0033 sphinx configuration: fix to create a simple man page from usage docs 2016-01-13 01:20:32 +01:00
Thomas Waldmann
4216a94e19 it's 2016 2016-01-13 00:42:23 +01:00
Thomas Waldmann
9a2d1eb1d8 docs: replace "|project_name|" with just "Borg", less ugly 2016-01-13 00:25:43 +01:00
Thomas Waldmann
0f4d3b21c3 minor development docs fixes 2016-01-12 23:49:19 +01:00
TW
89fbaa9767 Merge pull request #518 from htgoebel/patch-1
Update FAQ
2016-01-11 00:03:49 +01:00
Hartmut Goebel
0c2e517e04 Update FAQ
Clarify that user and group of owner are stored as name, except if --numeric-owner is given.
2016-01-09 23:50:41 +01:00
Leo Famulari
077ebe8c49 docs: Give project name in usage example.
* docs/usage.rst: Replace "|project_name|" with "borg" because the
abstraction doesn't work in usage examples.
2016-01-08 21:02:03 -05:00
Michael Gajda
fb64173bb4 Documentation: Standalone binary / pyinstaller extracts dependencies into /tmp. Currently /tmp requires about ~28MB of free space. It also needs exec permissions.
Closes #499
2016-01-06 13:35:28 +01:00
Fabian Weisshaar
eb642f06cc Allow simple copy-paste for package installation with apt 2015-12-30 15:06:31 +01:00
Thomas Waldmann
57b913bc88 fix badly named environment variable, fixes #503
added: BORG_DELETE_I_KNOW_WHAT_I_AM_DOING for the check in "borg delete"
2015-12-20 02:03:33 +01:00
Antoine Beaupré
f861f1f080 rephrase the mailing list section 2015-12-13 15:59:33 -05:00
Thomas Waldmann
c200b79470 development docs: run build_api and build_usage before tagging release 2015-12-13 21:34:37 +01:00
Thomas Waldmann
393e36b6da updated internals docs: hash table max. load factor is 0.75 now 2015-12-13 19:58:32 +01:00
Thomas Waldmann
2ecfa54aee ran build_api and build_usage 2015-12-13 15:47:03 +01:00
Thomas Waldmann
f3d60fdb37 update CHANGES 2015-12-13 15:41:18 +01:00
Thomas Waldmann
c4610c1edf remove old mailing list archive references
the old archives were merged into the new archives.
2015-12-12 22:02:10 +01:00
TW
3f1e354b0a Merge pull request #428 from ThomasWaldmann/purge-using-least-space
compact_segments: save_space -> free unused segments quickly
2015-12-08 23:37:15 +01:00
TW
b4a89414fb Merge pull request #478 from rumpelsepp/docs
Fix wrong installation instructions for archlinux
2015-12-08 19:32:18 +01:00
Stefan Tatschner
f1b9b95e0d Fix wrong installation instructions for archlinux
On arch I don't want to perform a full system upgrade when
installing a new package; so let's drop the "yu" part.
2015-12-08 19:15:03 +01:00
Thomas Waldmann
bec2f72c8e mention --save-space at the place we talk about keeping disk space free 2015-12-08 18:36:41 +01:00
Thomas Waldmann
5f1fcb3e63 add hint "not released yet" to latest changelog entry 2015-12-08 17:47:00 +01:00
Thomas Waldmann
f97b9eb90d updated CHANGES 2015-12-08 12:16:58 +01:00
Thomas Waldmann
41eab542a8 add borg upgrade to the docs, fixes #464 2015-12-08 10:33:27 +01:00
Thomas Waldmann
f7abff87f9 ran build_usage 2015-12-08 10:21:20 +01:00
Thomas Waldmann
b41f6dfbbf Merge branch 'silent' of https://github.com/ThomasWaldmann/borg into ThomasWaldmann-silent 2015-12-08 01:56:44 +01:00
Thomas Waldmann
74ee8154f2 add developer docs about output and logging 2015-12-08 01:45:22 +01:00
Thomas Waldmann
cb821b119b remove --log-level, add --debug and --info option, update docs
removed --log-level due to overlap with how --verbose works now.

for consistency, added --info as alias to --verbose (as the effect is
setting INFO log level).

also added --debug which sets DEBUG log level.
note: there are no messages emitted at DEBUG level yet.

WARNING is the default (because we want mostly silent behaviour,
except if something serious happens), so we don't need --warning
as an option.
2015-12-08 01:37:34 +01:00
Thomas Waldmann
f1f2e78ced docs: move related projects to resources section 2015-12-03 17:13:39 +01:00
Thomas Waldmann
b0975a75b5 docs: add resources section, with videos, talks, presentations 2015-12-03 16:58:48 +01:00