Commit graph

1979 commits

Author SHA1 Message Date
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
Marian Beermann
310a9b3486 docs: prune: fix include path 2017-06-23 19:17:18 +02:00
rugk
e967edad98 Include prune example in doc 2017-06-23 19:17:18 +02:00
enkore
64be888e60 Merge pull request #2736 from rugk/docs-sshrestrict
Fix typo
2017-06-23 19:12:01 +02:00
rugk
6051969df8
Fix typo 2017-06-23 16:54:02 +02: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
5b0b4f4b00
Remove unneccessary space 2017-06-23 14:52:11 +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
771168a3af docs: extract: move cwd note to --help 2017-06-21 00:16:25 +02:00
Marian Beermann
a9059a64bd docs: use DOM ready event, not document loaded event 2017-06-20 15:48:30 +02:00
Marian Beermann
23ee9432d9 docs: retain rST option list formatting (for Common Options) 2017-06-20 15:32:39 +02:00
Marian Beermann
9d33ff1720 docs: skip empty option groups 2017-06-20 15:30:20 +02:00
Marian Beermann
e869e7dc2f ran build_usage 2017-06-20 15:23:52 +02:00
Marian Beermann
e76fae0545 docs: uniform tables for listing options (HTML only) 2017-06-20 15:23:52 +02:00
enkore
8cc3e527a2 Merge pull request #2711 from enkore/docs/compact-opt
docs: change options formatting
2017-06-20 12:01:08 +02:00
Marian Beermann
a1a92bf00f docs: less space waste following "Common options" 2017-06-20 11:53:36 +02:00
Marian Beermann
e5012b11ca ran build_usage 2017-06-20 11:49:26 +02:00
Marian Beermann
6290b73863 docs: more compact options formatting 2017-06-20 11:48:46 +02:00
enkore
496922f4e0 changes: provisional 1.1.0rc1 header 2017-06-20 01:06:40 +02:00
Marian Beermann
d495b0fe75 docs: move introduction sentence 2017-06-19 10:01:55 +02:00
enkore
52da719d30 Merge pull request #2707 from narendravardi/master
Don't perform full Travis build on docs-only changes #2531
2017-06-19 09:58:41 +02:00
Marian Beermann
6e17ca7c3a docs: fix typo 2017-06-19 09:50:22 +02:00
Thomas Waldmann
f741ac2310 CHANGES: add release date 2017-06-18 14:45:04 +02:00
Marian Beermann
1e2835eb1d docs: man pages, usage. 2017-06-18 12:13:28 +02:00
Marian Beermann
c7dda0aca9 docs: assorted formatting fixes 2017-06-18 12:12:50 +02:00
Thomas Waldmann
9031490cfd update CHANGES (master) 2017-06-18 05:03:47 +02:00
TW
7df6597fa1 Merge pull request #2654 from enkore/f/no-cache-sync
create: --no-cache-sync
2017-06-18 03:22:06 +02:00
Marian Beermann
bde828d747 docs: faq: fix typo and strange link text 2017-06-18 02:34:25 +02:00
Marian Beermann
5e9f069dde docs: neater table borders 2017-06-18 02:28:49 +02:00
Marian Beermann
89f884588d docs: index: disable syntax highlight (bash) 2017-06-18 02:12:47 +02:00
Marian Beermann
125b02c5c8 docs: list: fix unintended block quote 2017-06-18 02:10:10 +02:00
Marian Beermann
48e815883f docs: usage: fix unintended block quota in common options 2017-06-18 02:07:37 +02:00
Marian Beermann
8aa745ddbd create: --no-cache-sync 2017-06-18 02:01:26 +02:00
Marian Beermann
334fa9f322 docs: add some cell-padding to tables 2017-06-18 01:56:36 +02:00
Marian Beermann
658fd2521f docs: fix overeager CSS selector ballooning badges 2017-06-18 01:53:14 +02:00
Marian Beermann
e880c7cac6 docs: sidebar pixel-tweak 2017-06-18 01:37:32 +02:00
Marian Beermann
887df51eef docs: development: update docs remarks 2017-06-18 01:31:32 +02:00
Marian Beermann
7df1140ab9 docs: installation: fix accidental block quotes 2017-06-18 01:27:29 +02:00
Marian Beermann
3fea2ac05e docs: switch to a fresher theme
incidentally, fixes font size mismatches on firefox and chrome,
at the same time. marvellous.
2017-06-18 01:27:29 +02:00
Marian Beermann
b1205a7932 docs: fix too small text in tables 2017-06-17 14:32:37 +02:00
Marian Beermann
0288fff6b7 docs: explain formatting 2017-06-17 14:29:56 +02:00
Marian Beermann
02ada03486 docs: remove more boxes around monospace 2017-06-17 14:29:55 +02:00
Marian Beermann
8687495793 docs: css: avoid scroll bars on tables 2017-06-17 12:40:17 +02:00
Marian Beermann
dd8a815327 docs: html: format option values like in man pages 2017-06-17 12:36:24 +02:00
Marian Beermann
5d9beb5dd2 docs: html: less annoying `` in running text 2017-06-17 12:33:01 +02:00
Marian Beermann
b08064bb4e docs: turn smartypants back on, since --options are now in `` 2017-06-17 12:29:13 +02:00
Marian Beermann
772be8fa97 python setup.py build_usage 2017-06-17 12:28:42 +02:00
Marian Beermann
26970cd4e9 delete docs/misc/compression.conf 2017-06-17 12:28:16 +02:00
Marian Beermann
5aa865c8d8 docs: double backticks for --options 2017-06-17 12:27:53 +02:00
philippje
88e937d0f9 changed the date of day without backup
Changed from 20. December to 19. December for easier comprehension (viewing the calendar.)
The missing 'd' at 20. December is hardly noticeable compared to e.g. the 19. December.
2017-06-12 22:17:29 +02:00
enkore
eb6deb9b05 Merge pull request #2642 from enkore/docs/deployment-local
docs: deployment: Automated backups to a local hard drive
2017-06-11 20:47:57 +02:00
Marian Beermann
501859ca33 docs: less bothersome experimental stripes 2017-06-11 20:46:53 +02:00
Marian Beermann
25bee21253 docs: deployment: Automated backups to a local hard drive 2017-06-11 20:46:53 +02:00
Marian Beermann
221dc1c4c7 normalize authenticated key modes
rename authenticated to authenticated-blake2, consistent with the other
blake2 key modes

add authenticated mode that fills the blank and is consistent with the
other "unqualified" key modes
2017-06-11 18:07:09 +02:00
enkore
de00d9d822 Merge pull request #2602 from enkore/pr/2134.docs
internals: rewrite manifest & feature flags
2017-06-11 12:29:12 +02:00
Marian Beermann
bffcc60f90 docs: internals: feature flags typos, clarifications 2017-06-11 12:28:37 +02:00
enkore
33a7331bda Merge pull request #2643 from enkore/f/experimental-patterns
mark --pattern, --patterns-from as experimental
2017-06-10 17:15:22 +02:00
Marian Beermann
4cd1cc6a28 docs: correct create exclude comment 2017-06-10 12:06:18 +02:00
rugk
4987c04e5b
Remove re docs
Fixes https://github.com/borgbackup/borg/issues/2458
2017-06-10 11:57:06 +02:00
Marian Beermann
5cab72035a mark --pattern, --patterns-from as experimental 2017-06-10 10:29:02 +02:00
Marian Beermann
827c478500 nanorst for "borg help TOPIC" 2017-06-10 10:29:02 +02:00
Andrea Gelmini
e4247cc0d2 Fix typos 2017-06-09 16:49:30 +02:00
Marian Beermann
13fe802713 docs: deployment: hosting repositories 2017-06-09 16:08:47 +02:00
Marian Beermann
c5d2c7c799 docs: split deployment 2017-06-09 16:00:46 +02:00
Marian Beermann
3664adb95d docs: highlight experimental features in online docs 2017-06-09 14:19:55 +02:00
enkore
524e0b5322 docs: development: vagrant, windows10 requirements 2017-06-08 12:27:16 +02:00
Marian Beermann
0d6064e7f3 docs: fix build_man for relocated examples 2017-06-07 16:29:37 +02:00
Marian Beermann
cd67628646 docs: changes: fix rst warning 2017-06-07 11:28:45 +02:00
Marian Beermann
07deaf14cb docs: faq: Can I use Borg on SMR hard drives? 2017-06-07 11:28:43 +02:00
Marian Beermann
13adc80cde docs: usage: avoid bash highlight, [options] instead of <options> 2017-06-07 00:44:53 +02:00
Marian Beermann
22311abe02 docs: usage: add benchmark page
Previously, benchmark crud was not contained in the usage pages
at all.
2017-06-07 00:42:43 +02:00
Marian Beermann
8fb7db71bc docs: split usage 2017-06-07 00:38:48 +02:00
enkore
bc23890259 Merge pull request #2626 from enkore/docs/broken-changelog
docs: fix broken changes listing of 1.1.0b6
2017-06-07 00:17:21 +02:00
Marian Beermann
52afd5f4ff docs: fix broken changes listing of 1.1.0b6 2017-06-07 00:17:05 +02:00
Marian Beermann
3faafb1dee docs: faq: specify "using inline shell scripts" 2017-06-06 21:30:58 +02:00
Marian Beermann
aa7fbff55f docs: quickstart: delete problematic BORG_PASSPRHASE use 2017-06-06 21:29:31 +02:00
Marian Beermann
f5e7d964cf docs: internals: feature flags set theory 2017-06-05 22:29:29 +02:00
Marian Beermann
fc599befc9 docs: internals: columnize rather long ToC [webkit fixup] 2017-06-05 16:04:03 +02:00
Marian Beermann
fec0958b7f docs: internals: columnize rather long ToC 2017-06-05 15:41:42 +02:00
Marian Beermann
e80c0f7c5e docs: fix way too small figures in pdf 2017-06-05 01:01:27 +02:00
Marian Beermann
da04aba5c5 docs: internals: feature flags introduction/rationale 2017-06-05 00:41:30 +02:00
Marian Beermann
c427d238f4 docs: internals: amend feature flags 2017-06-05 00:21:04 +02:00
Marian Beermann
f2fd6fc699 docs: internals: cache feature flags 2017-06-05 00:16:48 +02:00
Marian Beermann
36bdc9d15e internals: rewrite manifest & feature flags 2017-06-05 00:16:48 +02:00
Marian Beermann
19b425a5c8 docs: internals: more HashIndex details 2017-06-04 23:00:42 +02:00
Marian Beermann
cf77aa53d7 docs: internals: fix ASCII art equations 2017-06-04 22:50:17 +02:00
Marian Beermann
d33929a24d docs: internals: edited HashIndex 2017-06-04 22:44:29 +02:00
Marian Beermann
daae1cc515 docs/internals: layers image; Blimey! it's one pixel off! 2017-06-04 22:23:54 +02:00
Marian Beermann
a3815034e1 docs: internals: terms/glossary TODO 2017-06-04 22:17:59 +02:00
Marian Beermann
9174f84682 docs: internals: delete non-sequitor from repo/segments 2017-06-04 22:17:56 +02:00
Marian Beermann
89d8f54afb docs: internals: edited obj graph related sections a bit 2017-06-04 22:17:53 +02:00
Marian Beermann
2b0e7bc924 docs: data structures: demingle cache and repo index 2017-06-04 22:17:48 +02:00
Marian Beermann
f1709df8a9 docs/internals: layers image + description 2017-06-04 22:13:55 +02:00
TW
93e9ca0d23 update CHANGES (master) (#2594)
update CHANGES (master)
2017-06-04 00:18:09 +02:00
enkore
d95551736d Merge pull request #2591 from enkore/issue/1101.design
docs: file integrity
2017-06-03 18:17:14 +02:00
enkore
372eb40089 Merge pull request #2590 from enkore/issue/2589
serve: add --restrict-to-repository
2017-06-03 18:17:02 +02:00
TW
28e4eb4ea3 add a .coafile for coala (#2592)
add support for using coala, fixes #1366

ignores / disable are set up so that there are not many faults.
we can improve that iteratively.
2017-06-03 15:13:21 +02:00
Marian Beermann
da99ec2fbd docs: quotas: refer to --restrict-to-repository 2017-06-03 15:07:08 +02:00
Marian Beermann
b8e40fdce6 editing 2017-06-03 13:05:33 +02:00
Marian Beermann
45ee62e5ea docs: file integrity 2017-06-03 00:51:34 +02:00
enkore
a1fa1b7aec Merge pull request #2587 from enkore/docs/is-openssl
docs/security: OpenSSL usage
2017-06-02 16:29:05 +02:00
enkore
de72c3507e Merge pull request #2585 from ThomasWaldmann/vagrant
vagrant: control VM cpus and pytest workers via env
2017-06-02 16:28:47 +02:00
Marian Beermann
d51f2bbbae docs: quotas: local repo disclaimer
...
2017-06-02 14:50:51 +02:00
Marian Beermann
089224975b docs: quotas: clarify compatbility; only relevant to serve side
also cf. "Enforcing the quota":

  The quota is enforcible only if *all* :ref:`borg_serve` versions
  accessible to clients support quotas
2017-06-02 13:12:43 +02:00
Marian Beermann
b996afbc06 docs/security: used implementations; note python libraries 2017-06-02 13:07:31 +02:00
Marian Beermann
107e320a20 binaries: don't bundle libssl
ArchiverTestCaseBinary passes.
2017-06-02 13:00:28 +02:00
Marian Beermann
3c951df4cd docs/security: security track record of OpenSSL and msgpack 2017-06-02 12:21:59 +02:00
Thomas Waldmann
16a296c11a vagrant: control VM cpus and pytest workers via env 2017-06-02 02:34:12 +02:00
enkore
23d591c1c3 Merge pull request #2565 from enkore/issue/2517
Implement storage quotas
2017-06-01 14:39:17 +02:00
TuXicc
578b76af3a Added BORG_PASSCOMMAND environment variable (#2573) 2017-05-31 19:25:21 +02:00
Marian Beermann
4edf77788d Implement storage quotas 2017-05-31 18:36:03 +02:00
edgimar
b57fb1a5e5 Update changes.rst
fix denglish
2017-05-28 00:52:56 -04:00
enkore
2dcbe02e5a Merge pull request #2528 from ThomasWaldmann/follow-symlinks
document follow_symlinks requirements, check libc, fixes #2507
2017-05-25 09:26:09 +02:00
Marian Beermann
83fdc39251 docs book: use A4 format, new builder option format. 2017-05-23 10:07:25 +02:00
Marian Beermann
acf3842e02 docs: create appendices in the book 2017-05-22 20:55:16 +02:00
Marian Beermann
65d1deae1a faq: separate section for attic-stuff 2017-05-22 20:55:16 +02:00
enkore
226d1f6094 Revert "docs: borg_domain for custom priority index entries" 2017-05-22 20:45:29 +02:00
enkore
17384dd6dc Merge pull request #2552 from enkore/docs/search1
docs: borg_domain for custom priority index entries
2017-05-22 20:36:38 +02:00
enkore
decee5389b Merge pull request #2529 from enkore/faq/errors
faq: I get an IntegrityError or similar - what now?
2017-05-22 20:34:59 +02:00
Marian Beermann
7284413e3f docs: borg_domain for custom priority index entries 2017-05-22 20:08:11 +02:00
Thomas Waldmann
b484c79bc2 document follow_symlinks requirements, check libc, fixes #2507 2017-05-22 17:54:42 +02:00
Marian Beermann
f8c63f9a66 docs/data structures: add simple example compaction run 2017-05-22 13:19:18 +02:00
Marian Beermann
691c6adc04 docs/data structures: detail explanation of compaction 2017-05-22 12:34:52 +02:00
Marian Beermann
0bcb8c2a39 faq: rewrote IntegrityError answer 2017-05-22 11:46:10 +02:00
enkore
334a7007da Merge pull request #2544 from enkore/docs/ids-chunklayout
docs/data structures: add chunk layout diagram
2017-05-21 17:46:01 +02:00
Marian Beermann
384d7635a4 docs: add systemd warning regarding placeholders 2017-05-21 17:22:29 +02:00
Marian Beermann
73123578ed docs/data structures: add chunk layout diagram 2017-05-21 16:40:10 +02:00
Marian Beermann
c5159582d4 add docs/misc/borg-data-flow data flow chart 2017-05-20 15:59:20 +02:00
Marian Beermann
be40e2fcfa faq: I get an IntegrityError or similar - what now? 2017-05-18 20:01:06 +02:00
Marian Beermann
b7a6ac94c3 docs: ran build_man, build_usage 2017-05-17 11:52:48 +02:00
enkore
52fab07b3b Merge pull request #2510 from enkore/issue/2473
Add --debug-profile option
2017-05-17 00:10:14 +02:00
enkore
5788219ff4 borg export-tar (#2519) 2017-05-17 00:09:41 +02:00
Marian Beermann
054897c872 docs: debugging facilities 2017-05-16 23:30:44 +02:00
Marian Beermann
0b14ed84eb docs: fix wrong heading level of "Common options" 2017-05-15 17:16:44 +02:00
Marian Beermann
d5edb011f0 support common options 2017-05-14 18:45:20 +02:00
Marian Beermann
7ddc8003df docs: use vector logo for PDF version 2017-05-13 13:19:23 +02:00
Marian Beermann
8c637da381 PDF version of the logo 2017-05-13 13:07:44 +02:00
Marian Beermann
3d14fc72ec SVG version of the logo 2017-05-13 13:06:03 +02:00
Marian Beermann
848df38d08 Rename Key.passphrase_protected -> logically_encrypted & document 2017-05-12 20:36:23 +02:00
Marian Beermann
cad49b844e key: authenticated mode = not passphrase protected 2017-05-12 20:35:18 +02:00
enkore
9e6b8f67b9 serve: ignore --append-only when creating a repository (#2501) 2017-05-12 20:34:45 +02:00
enkore
c805adc267 Merge pull request #2489 from enkore/issue/2169
consider repokey w/o passphrase == unencrypted
2017-05-08 08:57:15 +02:00
Marian Beermann
d964101eb5 consider repokey w/o passphrase == unencrypted 2017-05-07 22:13:49 +02:00
Marian Beermann
1418aeadad docs/frontends: use headlines - you can link to them 2017-05-05 15:52:34 +02:00
Marian Beermann
2a22f93e44 list: JSON lines output for archive contents 2017-05-05 15:49:56 +02:00
Marian Beermann
fcce0ca2bc docs: disable smartypants 2017-05-01 22:31:18 +02:00
Thomas Waldmann
b00700ae9d ran build_man 2017-04-30 01:32:26 +02:00
Thomas Waldmann
3c279dbf78 ran build_usage 2017-04-30 01:31:20 +02:00
Thomas Waldmann
78c455c31f update CHANGES (release date) 2017-04-30 01:29:17 +02:00
Thomas Waldmann
a5ccaf62f8 update CHANGES 2017-04-30 01:03:39 +02:00
enkore
0021368163 Merge pull request #2447 from ThomasWaldmann/update-docs4
Update docs
2017-04-28 10:49:35 +02:00
Marian Beermann
e036ebc340 docs: installation: pre-install considerations, fix crossrefs
posix_fadvise -> only used when available; not part of the filesystem.
sync -> fsync
2017-04-28 10:40:21 +02:00
Marian Beermann
e8b74fcac3 docs: faq: fix title underlines 2017-04-28 10:39:32 +02:00
Steve Groesz
ff4120184c Fix formatting in pre-installation section
Some documentation was improperly formatted with #2392. This corrects those errors.
2017-04-26 22:25:15 -05:00
Thomas Waldmann
ba20d8d131 document borg init behaviour via append-only borg serve, fixes #2440 2017-04-26 03:16:12 +02:00
Thomas Waldmann
bf69b049e9 be clear about what buzhash is used for, fixes #2390
and want it is not used for (deduplication).

also say already in the readme that we use a cryptohash
for dedupe, so people don't worry.
2017-04-25 23:38:55 +02:00
Steve Groesz
3eb3e31a8c FAQ to explain warning when running --repair (#2393)
FAQ to explain warning when running --repair, fixes #2341
2017-04-23 12:52:44 +02:00
Steve Groesz
605f281b37 Document repository file system requirements
#2080
2017-04-23 12:48:28 +02:00
TW
bc3bc1a79c Merge pull request #2408 from ThomasWaldmann/update-changes-master
update CHANGES (master)
2017-04-20 14:20:19 +02:00
rugk
5ddf7e7922 Add --one-file-system note for root backup 2017-04-15 12:38:58 +02:00
Thomas Waldmann
ca95516540 update CHANGES (master) 2017-04-09 21:20:58 +02:00
enkore
736a815972 Merge pull request #2342 from ThomasWaldmann/generic-hardlinks
Generic hardlinks
2017-04-05 14:34:29 +02:00
enkore
9a1c1e90c1 Merge pull request #2375 from enkore/buhdf
BORG_HOSTNAME_IS_UNIQUE=yes by default.
2017-04-05 14:09:58 +02:00
Marian Beermann
49f6128d1c docs: serve: env vars in original commands are ignored 2017-04-05 13:34:50 +02:00
Thomas Waldmann
32c6e3ad95 docs: tell what kind of hardlinks we support 2017-04-05 13:03:58 +02:00
Marian Beermann
b2953357ed recreate: add --recompress flag, avoid weirdo use of args.compression 2017-04-04 15:11:15 +02:00
Marian Beermann
bb6b4fde93 BORG_HOSTNAME_IS_UNIQUE=yes by default. 2017-04-01 21:28:41 +02:00
Thomas Waldmann
85bfcd439c ran setup.py build_man 2017-03-27 01:58:19 +02:00
Thomas Waldmann
251983a741 ran setup.py build_usage 2017-03-27 01:45:45 +02:00
Thomas Waldmann
72abd12e3c update CHANGES with release date 2017-03-27 01:35:32 +02:00
Thomas Waldmann
60ae95801d update CHANGES (master / 1.1.0b4) 2017-03-27 01:25:20 +02:00
Marian Beermann
dfdf590445 docs: typos 2017-03-25 15:42:00 +01:00
Marian Beermann
475d53d9ef docs: kill api page 2017-03-25 15:41:11 +01:00
Fredrik Mikker
d01a8f54b6 Added FAQ section about backing up root partition
Using borgbackup to backup the root partition works fine, just
remember to exclude non-essential directories.

Signed-off-by: Fredrik Mikker <fredrik@mikker.se>
2017-03-24 16:49:07 +01:00
Marian Beermann
988e452bc0 faq: mention --remote-ratelimit in bandwidth limit question 2017-03-16 15:13:03 +01:00
Thomas Waldmann
b287fba22e fix caskroom link, fixes #2299 2017-03-15 01:22:21 +01:00
Marian Beermann
d1738ec315 docs/security: reiterate that RPC in Borg does no networking 2017-03-13 16:29:32 +01:00
Marian Beermann
86867e5171 docs/security: counter tracking
Copied from #2266
2017-03-13 14:50:56 +01:00
Marian Beermann
00f98d8ad1 docs/development: update merge remarks 2017-03-10 23:26:10 +01:00
Milkey Mouse
55759f76e6 Address SSH batch mode in docs (fixes #2202) (#2270) 2017-03-09 21:43:23 +01:00
Marian Beermann
cdb4df0885 --log-json: time property on most progress/log objects, remove is_prompt 2017-03-09 21:36:37 +01:00
Marian Beermann
e07a289e34 frontends.rst: it's "null" in json 2017-03-09 21:36:37 +01:00
Marian Beermann
e98b5b20df yes(): handle JSON output 2017-03-09 21:36:37 +01:00
Milkey Mouse
85a2d2fc08 Add warning about running build_usage on Python >3.4 (fixes #2123)
Python 3.6 added some new guaranteed hashing algorithms that will
show up as available in the docs even though the baseline for support
is Python 3.4; running build_usage with Python 3.4 will fix this.

# Conflicts:
#	docs/development.rst
2017-03-09 21:35:33 +01:00
Florent Hemmi
1551be54be Docs: one link per distro in the installation page 2017-03-08 17:11:10 +01:00
Marian Beermann
1bbfb24d1a quickstart: fix rst issue 2017-03-03 15:27:17 +01:00
enkore
6468b8a0c2 Merge pull request #2229 from enkore/f/jsonp
JSON progress indicators
2017-03-03 14:39:28 +01:00
TW
ce57f34052 Merge pull request #2235 from kmq/master_2214
Improve automated backup script in doc fixes #2214
2017-03-02 05:47:05 +01:00
kmq
c190a87eef
Improve automated backup script in doc fixes #2214 2017-03-02 05:48:30 +02:00
Marian Beermann
abb0a20d4f list: files->items, clarifications 2017-03-01 16:58:06 +01:00
Thomas Waldmann
d5707929fd [docs] improve remote-path description
(ported bebehei's 1.0-maint change to master)
2017-03-01 01:53:23 +01:00
Thomas Waldmann
7e9845fc68 added borg benchmark crud output to docs/misc/ 2017-02-28 21:44:06 +01:00
Marian Beermann
7cce650a38 json docs: rather complete error list 2017-02-28 12:46:26 +01:00
Marian Beermann
8e1edaf258 ArchiveFormatter: add "start" key for compatibility with "info" 2017-02-28 01:33:36 +01:00
Marian Beermann
51350953b0 json: examples 2017-02-28 01:33:36 +01:00
Marian Beermann
d327109604 json progress: emit info (current $something) 2017-02-28 01:33:36 +01:00
Marian Beermann
fcad0ddab4 pass msgid for common errors 2017-02-28 01:19:20 +01:00
Marian Beermann
d5515b6952 add msgid to progress output 2017-02-28 01:19:20 +01:00
Marian Beermann
6288c9f751 enhance JSON progress information
separate output types, extra information
2017-02-27 20:30:20 +01:00
enkore
0e3560b6cd Merge pull request #2219 from enkore/f/frontend-docs
document JSON
2017-02-27 17:03:37 +01:00
TW
1a67b82726 Merge pull request #2220 from ThomasWaldmann/compression-default-lz4
use lz4 compression by default, fixes #2179
2017-02-27 00:31:43 +01:00
Marian Beermann
332f7898bc update docs for create -C default change 2017-02-26 23:07:31 +01:00
kmq
757921dbdc
Document relative path usage #1868 2017-02-26 20:33:15 +02:00
Marian Beermann
9ed8e4b7a9 document JSON 2017-02-26 17:01:06 +01:00
kmq
f7d28e76a0
document snapshot usage #2178 2017-02-26 13:47:26 +02:00
Marian Beermann
19d50cff76 docs: internals: move toctree to after the introduction text
this only changes the location on the page, nothing about how the TOC
is arranged.
2017-02-22 15:56:27 +01:00
Marian Beermann
1652525858 docs: clarify metadata kind, manifest ops 2017-02-22 15:29:33 +01:00
Marian Beermann
ecdf6ba25f docs: key enc: correct / clarify some stuff, link to internals/security 2017-02-22 00:21:14 +01:00
Marian Beermann
c03a7ad844 docs: datas: enc: 1.1.x mas different MACs 2017-02-22 00:21:14 +01:00
Marian Beermann
6b21d63086 docs: datas: enc: correct factual error -- no nonce involved there. 2017-02-22 00:21:14 +01:00
Marian Beermann
e5bbba573a docs: make internals.rst an index page
Subsections:

- Security
- Data structures and file formats
2017-02-22 00:21:14 +01:00
Marian Beermann
63f17087c8 docs: edited internals section a bit 2017-02-22 00:13:46 +01:00
enkore
cd1df96ef5 Merge pull request #2171 from ThomasWaldmann/limit-unpacker
borg rpc: use limited msgpack.Unpacker
2017-02-21 21:53:09 +01:00
Thomas Waldmann
4e08bbcf0b document BORG_HOSTNAME_IS_UNIQUE, fixes #2087 2017-02-19 05:12:00 +01:00
Thomas Waldmann
6a25b6bdfa update docs about limited msgpack Unpacker for RPC code 2017-02-18 07:15:53 +01:00
enkore
d9fe4a1e2c Merge pull request #2160 from enkore/f/cryptodocs
add "Cryptography in Borg" and "Remote RPC protocol security" sections
2017-02-16 20:27:34 +01:00
Marian Beermann
8e8d9d3f48 docs: add edited "Cryptography in Borg" and "Remote RPC protocol security" sections
The former section is a bit older (Nov 2016) and has been the piece
responsible for finding CVE-2016-10099, since while writing it I
wondered how the manifest was authenticated to actually
*be* the manifest. Well. There it is ;)

It has been edited to final form only recently and should now be ready
for review.

The latter section is new.
2017-02-16 20:27:16 +01:00
Marian Beermann
3d79d441a5 faq: update Which file types, attributes, etc. are *not* preserved?
ext4 immutable has been supported for a while.
2017-02-16 16:49:26 +01:00
Marian Beermann
9e0ea92a9d docs: FAQ by categories as proposed by @anarcat in #1802
Usage & Limitations
Security
Common issues
Miscellaneous (only three items, two fork-related)

Note: This does not change any links to FAQ items.
2017-02-16 16:06:15 +01:00
Marian Beermann
4446577dd5 docs: less spacing between options 2017-02-14 23:11:21 +01:00
enkore
22464295cf Merge pull request #2156 from enkore/f/devmodel
new branching model
2017-02-14 13:02:33 +01:00
Marian Beermann
5e0c2d4b11 new branching model 2017-02-14 13:01:46 +01:00
Marian Beermann
44798e0edd setup.py: build_api: sort file list for determinism
# Conflicts:
#	docs/api.rst
#	setup.py

Original-Commit: e208d115
2017-02-13 21:24:33 +01:00
Marian Beermann
79dd920661 update CHANGES (1.0.10)
# Conflicts:
#	docs/changes.rst

Original-Commit: e635f219
2017-02-13 21:24:33 +01:00
Martin Hostettler
179f1bc147 Add qr html export mode to key export command 2017-02-13 21:24:33 +01:00
Martin Hostettler
e0f36e8613 quickstart.rst: Add link to paperkey template. 2017-02-13 20:45:49 +01:00
Martin Hostettler
b44882d10c paperkey.html: Add interactive html template for printing key backups. 2017-02-13 20:45:46 +01:00
Marian Beermann
0971fdce8d docs: changes: fix two rST warnings 2017-02-12 18:51:41 +01:00
Marian Beermann
847797b477 update development.rst for docs changes 2017-02-12 18:51:41 +01:00
Marian Beermann
95b69a433c docs: usage: remove not-updated-anymore debug* files. 2017-02-12 18:51:41 +01:00
Marian Beermann
96fa1e8414 docs: define "ours" merge strategy for auto-generated files 2017-02-12 18:51:40 +01:00
Marian Beermann
1d9378f12c man pages: generate page for subparsers, eg. borg-key(1)
Conflicts:
	docs/man/borg-key.1
2017-02-12 15:28:59 +01:00
Marian Beermann
fa24e1f38f man pages: add borg(1) master/intro page 2017-02-12 15:28:59 +01:00
Marian Beermann
15dfaae223 docs: create: move --exclude note to main doc 2017-02-12 15:28:59 +01:00
Marian Beermann
0710bbd40e docs: create: move item flags to main doc 2017-02-12 15:28:58 +01:00
Marian Beermann
1d91d2699c commit man pages 2017-02-05 15:46:46 +01:00
Marian Beermann
d6a26ca26d docs: fix examples using borg init without -e/--encryption 2017-02-05 15:46:46 +01:00
Marian Beermann
4e0422cdf0 Move change-passphrase to the "key" group (but leave old name, too) 2017-02-04 15:10:45 +01:00
Marian Beermann
5fe32866e6 Move migrate-to-repokey to the "key" command group 2017-02-04 15:10:45 +01:00
TW
c6ea34be96 Merge pull request #2111 from ThomasWaldmann/merge-1.0-maint
Merge 1.0-maint
2017-02-01 12:13:37 +01:00
Leo Antunes
dd6b90fe6c change dir_is_tagged to use os.path.exists()
Add --keep-exclude-tags option as alias to --keep-tag-files and
deprecate the later. Also make tagging accept directories as tags,
allowing things like `--exclude-if-present .git`.

fixes #1999
2017-01-29 18:13:51 +01:00
Thomas Waldmann
e19537ff6f ran build_usage 2017-01-29 05:54:25 +01:00
Thomas Waldmann
c0dc644ef6 Merge branch '1.0-maint' into merge-1.0-maint
# Conflicts:
#	MANIFEST.in
#	Vagrantfile
#	docs/changes.rst
#	docs/usage/mount.rst.inc
#	src/borg/archiver.py
#	src/borg/fuse.py
#	src/borg/repository.py
2017-01-29 05:49:53 +01:00
Thomas Waldmann
e6c1931d47 ran build_usage 2017-01-28 23:36:56 +01:00
Thomas Waldmann
dc3492642d update CHANGES (1.0-maint) 2017-01-28 23:26:25 +01:00
Marian Beermann
fbaefc98c9 docs: add CVE numbers for issues fixed in 1.0.9
https://www.cvedetails.com/product/35461/Borg-Borg.html?vendor_id=16008
2017-01-27 11:58:08 +01:00
Thomas Waldmann
e32503b84c ran setup.py build_usage 2017-01-15 02:10:55 +01:00
Thomas Waldmann
1845074b2e update CHANGES (master) 2017-01-15 02:10:55 +01:00
Thomas Waldmann
740312f725 Merge branch '1.0-maint' into merge-1.0-maint
# Conflicts:
#	requirements.d/development.txt
#	tox.ini
2017-01-15 01:15:04 +01:00
Thomas Waldmann
9e8af73d7f update CHANGES (1.0-maint) 2017-01-15 01:05:40 +01:00
Thomas Waldmann
70cc201377 Merge branch '1.0-maint' into merge-1.0-maint 2017-01-14 16:53:38 +01:00
Thomas Waldmann
85b3625bca update CHANGES (1.0-maint) 2017-01-14 16:51:08 +01:00
Marian Beermann
ecad0ed53a Merge branch '1.0-maint' into merge/1.0-maint
# Conflicts: ... everywhere ...
#	.travis.yml
#	Vagrantfile
#	borg/testsuite/key.py
#	docs/changes.rst
#	docs/quickstart.rst
#	docs/usage.rst
#	docs/usage/upgrade.rst.inc
#	src/borg/archive.py
#	src/borg/archiver.py
#	src/borg/crypto.pyx
#	src/borg/helpers.py
#	src/borg/key.py
#	src/borg/remote.py
#	src/borg/repository.py
#	src/borg/testsuite/archive.py
#	src/borg/testsuite/archiver.py
#	src/borg/testsuite/crypto.py
#	src/borg/testsuite/helpers.py
#	src/borg/testsuite/repository.py
#	src/borg/upgrader.py
#	tox.ini
2017-01-12 15:01:41 +01:00
Thomas Waldmann
6603133344 update CHANGES (1.0-maint) 2017-01-12 03:37:52 +01:00
Marian Beermann
10f48dbd0b Update 1.1.0b3 CHANGES 2017-01-12 02:44:04 +01:00
TW
b206aa771c Merge pull request #2016 from ThomasWaldmann/fix-typos
fix typos
2017-01-12 02:27:13 +01:00
Thomas Waldmann
01090d2d40 fix typos
taken from debian package, thanks to danny edel and lintian for finding these.
2017-01-12 02:25:41 +01:00
enkore
53aaee3519 Merge pull request #2000 from enkore/issue/1997
check: fail if single archive does not exist
2017-01-12 02:08:38 +01:00
TW
1c1a289c8a Merge pull request #2008 from ThomasWaldmann/update-1.0-changes
update CHANGES (1.0-maint)
2017-01-12 01:31:26 +01:00
sherbang
33be583920 Update faq.rst 2017-01-07 18:48:48 -05:00
Thomas Waldmann
69b816fe76 update CHANGES (1.0-maint) 2017-01-07 23:12:27 +01:00
Marian Beermann
be8e0c89b3 check: fail if single archive does not exist 2017-01-04 19:25:03 +01:00
Marian Beermann
7519bf8100 fix change-passphrase crashing if repository is not encrypted 2017-01-03 17:15:59 +01:00
Marian Beermann
6a5b3018c1 fix upgrade --tam crashing if repository is not encrypted 2017-01-03 17:15:32 +01:00
Marian Beermann
3e04fa972a xattr: only skip file on BufferTooSmallError
redefine __str__ to get a proper error message, not ''
2017-01-03 14:25:55 +01:00
Marian Beermann
85e79f96a1 xattr: ignore empty names returned by llistxattr(2) et al 2017-01-03 12:47:42 +01:00
enkore
cf19db466d Merge pull request #1989 from Abogical/master
Happy new year!
2017-01-01 01:14:08 +01:00
Abogical
f043b966da It's 2017 2016-12-31 16:53:30 +02:00
Marian Beermann
a0abc3eb75 CHANGES: move 1.1.0b3 to correct position 2016-12-20 23:26:22 +01:00
Marian Beermann
e0e5bc4aa4 ran build_usage 2016-12-20 23:09:28 +01:00
Thomas Waldmann
c9cc97e05b CHANGES: fix 1.0.9 release date 2016-12-20 23:06:15 +01:00
Marian Beermann
85cebd0419 Merge branch 'partial-1.0-maint' into merge/1.0-maint 2016-12-20 23:05:44 +01:00
Thomas Waldmann
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
Marian Beermann
d15fb241bd check: handle duplicate archive items neatly
# Conflicts:
#	src/borg/archive.py
2016-12-20 22:53:55 +01:00
Marian Beermann
5e1cb9d899 Add tertiary authentication for metadata (TAM) 2016-12-20 22:53:53 +01:00
Thomas Waldmann
c54a9121ae CHANGES: fix 1.0.9 release date 2016-12-20 00:49:24 +01:00
Thomas Waldmann
3362ec319e quickstart: use prune with --list
so people are better aware of what's happening, avoiding pitfalls
with wrong or missing --prefix.
2016-12-19 16:06:54 +01:00
Thomas Waldmann
580599cf32 ran build_usage 2016-12-19 04:21:13 +01:00
Thomas Waldmann
1c55930840 ran build_usage 2016-12-17 20:06:41 +01:00
Marian Beermann
f2f50efc28 check: handle duplicate archive items neatly
Signed-off-by: Thomas Waldmann <tw@waldmann-edv.de>
2016-12-17 20:06:41 +01:00
Marian Beermann
28ad779a6f Add tertiary authentication for metadata (TAM)
Signed-off-by: Thomas Waldmann <tw@waldmann-edv.de>
2016-12-17 20:06:41 +01:00
Marian Beermann
a9db2a2e55 Merge branch '1.0-maint' into master
# Conflicts:
#	src/borg/archive.py
#	src/borg/archiver.py
#	src/borg/helpers.py
2016-12-17 13:26:28 +01:00
enkore
49c05719d8 Merge pull request #1941 from enkore/issue/1936
Fix some clock problems
2016-12-17 13:20:56 +01:00
Marian Beermann
445365b3ff update changes 2016-12-17 12:00:25 +01:00
Thomas Waldmann
6b6ddecd93 document windows 10 linux subsystem install
also add note about remote repos being broken on cygwin.
2016-12-17 00:25:49 +01:00
Thomas Waldmann
82cd1fd392 run setup.py build_usage 2016-12-14 03:42:38 +01:00
Thomas Waldmann
c855c687eb Merge branch '1.0-maint' 2016-12-14 03:33:53 +01:00
TW
60bbd7a944 update CHANGES (1.0-maint) (#1954) 2016-12-14 01:29:43 +01:00
Marian Beermann
9147c7038b update 1.1 beta CHANGES 2016-12-11 15:18:52 +01:00
Thomas Waldmann
09b1079b18 update CHANGES (master / 1.1 beta) 2016-12-11 06:20:10 +01:00
Thomas Waldmann
bd8b4a4489 update CHANGES (1.0-maint) 2016-12-09 04:42:23 +01:00
Marian Beermann
288cac788c setup.py: build_usage: don't generate includes for debug commands 2016-12-02 13:28:49 +01:00
Thomas Waldmann
a100fb67eb Merge branch '1.0-maint' into merge-1.0-maint
# Conflicts:
#	AUTHORS
#	src/borg/archive.py
#	src/borg/key.py
2016-11-30 05:38:04 +01:00
Thomas Waldmann
d6d3f275df docs: add python3-devel as a dependency for cygwin-based installation 2016-11-30 02:50:20 +01:00
Marian Beermann
c3a2dc5f55 Rename BORG_NONCES_DIR to BORG_SECURITY_DIR 2016-11-29 17:43:06 +01:00
Thomas Waldmann
4746d20534 ran build_usage
had merge conflicts in the usage files, decided to just recreate them afterwards.
2016-11-28 02:25:56 +01:00
Thomas Waldmann
c83a124e65 Merge branch '1.0-maint' (into master) 2016-11-28 02:23:32 +01:00
TW
2780a83452 Merge pull request #1885 from jcrben/patch-1
Clarify extract is relative to current directory
2016-11-27 20:41:39 +01:00
Ben Creasy
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
Marian Beermann
bf3a1f0c33 docs/usage: fix literal/emph without end-string (two instances) 2016-11-27 20:18:27 +01:00
Marian Beermann
a2505517ee FAQ: fix link to changelog 2016-11-27 20:15:05 +01:00
Thomas Waldmann
5de31f57e5 ran build_usage 2016-11-27 02:33:57 +01:00
Thomas Waldmann
91fa568d5e add note about issue #1837 2016-11-27 02:22:33 +01:00
Thomas Waldmann
bd0e14040e move "important notes" to own section 2016-11-27 02:22:28 +01:00
Thomas Waldmann
cc15806766 update CHANGES (1.0-maint) 2016-11-27 02:21:14 +01:00
Thomas Waldmann
30d1e21e53 fixup: fixes, clarify 2016-11-26 20:49:39 +01:00
Thomas Waldmann
76c5f1a258 add more details about resource usage 2016-11-26 04:34:01 +01:00
Thomas Waldmann
0a0b913739 implement BORG_NEW_PASSPHRASE, fixes #1768 2016-11-24 23:43:27 +01:00
Thomas Waldmann
c8b58e0fd8 improve cache / index docs, esp. files cache docs, fixes #1825 2016-11-24 01:53:23 +01:00
Thomas Waldmann
5fe5b6b339 docs: different pattern matching for --exclude, fixes #1779 2016-11-19 22:26:07 +01:00
Thomas Waldmann
d8e806aac1 docs: datetime formatting examples for {now} placeholder, fixes #1822 2016-11-19 22:04:13 +01:00
Thomas Waldmann
3d174aef35 docs: clarify passphrase mode attic repo upgrade, fixes #1854 2016-11-19 21:52:11 +01:00
Thomas Waldmann
d7284a92f0 docs: clarify --umask usage, fixes #1859 2016-11-19 21:38:13 +01:00
Thomas Waldmann
afab1cc9b0 Merge branch '1.0-maint'
# Conflicts:
#	borg/platform.py
#	src/borg/archiver.py
#	src/borg/helpers.py
#	src/borg/platform/darwin.pyx
#	src/borg/platform/freebsd.pyx
#	src/borg/platform/linux.pyx
#	src/borg/testsuite/__init__.py
2016-11-17 23:56:34 +01:00
Thomas Waldmann
e17fe2b295 borg umount, fixes #1855
this refactors umount code we already used for the testsuite into the platform module's namespace.

also, it exposes that functionality via the cli api, so users can use it via "borg umount <mountpoint>",
which is more consistent than using borg to mount and fusermount -u (or umount) to un-mount.
2016-11-17 20:16:28 +01:00
Abdel-Rahman
9cf4846c27 Typo 2016-11-15 00:11:32 +02:00
Thomas Waldmann
c81f861ba6 developers docs: clarify how to choose PR target branch 2016-11-14 03:26:39 +01:00
Marian Beermann
c2eb2539b9
Document maintenance merge command 2016-11-13 16:07:06 +01:00
enkore
223f7890fe Merge pull request #1819 from enkore/issue/1800
Add BLAKE2b key types
2016-11-11 03:11:38 +01:00
Marian Beermann
a31ca4f022
crypto: link against system libb2, if possible 2016-11-11 03:08:11 +01:00
Marian Beermann
05a52ec8ec
Merge branch '1.0-maint' into merge/1.0-maint 2016-11-09 23:56:54 +01:00
TW
94ff4959ee Merge pull request #1808 from anarcat/restore-size
restore normal size
2016-11-05 02:37:43 +01:00
Antoine Beaupré
adfd66d636 restore normal size
otherwise code examples overflow
2016-11-04 21:27:21 -04:00
Antoine Beaupré
057ad07d4b fix a heading that was incorrectly set 2016-11-04 21:16:41 -04:00
Antoine Beaupré
ec0ef2eaca remove third level headings, too verbose 2016-11-04 21:15:31 -04:00
Antoine Beaupré
af23eea39d fix levels in authors section
that way in the TOC, it doesn't look like borg authors are attic
2016-11-04 21:14:59 -04:00
Antoine Beaupré
19ae2a7870 add FAQ about security 2016-11-04 20:58:27 -04:00
Antoine Beaupré
b4d0388785 move security verification to support section
the rationale is to simplify the README file to the bare
minimum. security researchers will be able to find the contact
information if they look minimally and people installing the software
will find a link where relevant (in binary releases only, since all
the others have other trust paths)
2016-11-04 20:58:27 -04:00
Antoine Beaupré
aeb10d1a85 show URLs in PDF, better font 2016-11-04 16:01:18 -04:00
Antoine Beaupré
5def2350d0 fix PDF rendering structure
without those changes, all of the toctree document headings do not
show up. they are considered to be "below" the last heading of the
README file.

we also remove the "Notes" section from the readme as there is only
one note, regarding the fork.

we introduce a stub "introduction" element in the toctree, otherwise
it is impossible for the PDF rendered to render the README correctly.

this is to workaround a bug in the PDF renderer.
2016-11-04 16:01:18 -04:00
Antoine Beaupré
18f3d64e4c PDF docs: add logo and fix authors
the PDF documentation looks much better with those
2016-11-04 15:59:55 -04:00
Antoine Beaupré
7f9a147e46 move fork differences to FAQ
it seems now that the fork is more of historical value than a current
thing. people interested in the differences between borg and attic can
look in the FAQ, but I do not see why this is present in the README.

a new section regarding compatibility is created to keep that warning
in place.
2016-11-04 12:34:41 -04:00
Antoine Beaupré
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
Thomas Waldmann
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
84637322f2 ran build_usage 2016-10-29 01:58:21 +02:00
TW
89c31d6b44 Merge pull request #1763 from ThomasWaldmann/update-1.0-changes
update CHANGES (1.0-maint)
2016-10-29 01:44:39 +02:00
Thomas Waldmann
20f4a1f478 update CHANGES (1.0-maint) 2016-10-29 01:18:55 +02:00
Thomas Waldmann
a16c7d8e16 mention file:// 2016-10-28 05:04:23 +02:00
Thomas Waldmann
11e9780393 quickstart: add a comment about other (remote) filesystems 2016-10-28 04:57:15 +02:00
Thomas Waldmann
e0298b2932 simplify quickstart
only give one possible ssh url syntax, all others are documented in usage chapter.
2016-10-28 04:51:46 +02:00
Thomas Waldmann
ca15cc80e5 document repo URLs / archive location 2016-10-28 04:43:33 +02:00
Thomas Waldmann
9b9179312d ssh: repo url docs - fix typo 2016-10-28 03:32:37 +02:00
Thomas Waldmann
09e74af7bf Merge branch '1.0-maint' 2016-10-24 21:41:20 +02:00
Florian Klink
88f7f8673d docs/deployment.rst: do not use bare variables in ansible snippet
The current snippet throws deprecation warnings:

```
[DEPRECATION WARNING]: Using bare variables is deprecated. Update your 
playbooks so that the environment value uses the full variable syntax 
('{{auth_users}}').
This feature will be removed in a future 
release. Deprecation warnings can be disabled by setting 
deprecation_warnings=False in ansible.cfg.
```
2016-10-24 02:34:28 +02:00
Thomas Waldmann
d363907b5a document BORG_NONCES_DIR, fixes #1592 2016-10-21 04:15:33 +02:00
Thomas Waldmann
c000eb8083 add clarification about append-only mode, fixes #1689 2016-10-19 02:31:39 +02:00
Thomas Waldmann
3550b24ed9 ran build_usage 2016-10-17 03:59:47 +02:00
Thomas Waldmann
b3133f6394 update api.rst 2016-10-17 03:58:22 +02:00
Thomas Waldmann
4d7af95ad2 update 1.0 CHANGES 2016-10-17 03:50:47 +02:00
Thomas Waldmann
b0cc4fd74a Merge branch '1.0-maint' into merge-1.0-maint 2016-10-13 19:10:04 +02:00
Thomas Waldmann
b88e82d99d remove debug-xxx commands, fixes #1627
we use "debug xxx" subcommands now. docs updated.

also makes "borg help" shorter as not all debug-xxx commands
show up, but just 1 main "debug" command.
2016-10-10 00:22:01 +02:00
Marian Beermann
573cb616d3 deployment: synthesize alternative --restrict-to-path example 2016-10-06 01:00:07 +02:00
Simon Heath
cf1c73b4f9 Added docs explaining multiple --restrict-to-path flags, with example (take 2) 2016-10-03 09:25:48 +02:00
enkore
ce72d24825 Clarify FAQ regarding backup of virtual machines (#1672) 2016-10-02 20:11:34 +02:00
Thomas Waldmann
e6241cce12 update CHANGES 2016-10-01 18:45:52 +02:00
Thomas Waldmann
f57feb121d fix module names in api.rst 2016-10-01 18:29:45 +02:00
Thomas Waldmann
0411512750 ran build_usage 2016-10-01 18:23:36 +02:00
Thomas Waldmann
4c01857461 Merge branch '1.0-maint' into merge-1.0-maint 2016-09-30 23:42:48 +02:00
Thomas Waldmann
a65707beb8 add more specific warning about write-access debug commands 2016-09-30 21:09:02 +02:00
Thomas Waldmann
f47f7cec89 update CHANGES (master / 1.1) 2016-09-30 15:21:23 +02:00
Thomas Waldmann
e124f3c67b update CHANGES 2016-09-29 17:16:57 +02:00
Thomas Waldmann
2a864be84f Merge branch '1.0-maint' into merge-1.0-maint
# Conflicts:
#	setup.py
#	src/borg/archiver.py
#	src/borg/helpers.py
2016-09-27 21:31:41 +02:00
textshell
b84014e7d9 archiver: Add documentation for "key export" and "key import" commands. (#1641)
archiver: Add documentation for "key export" and "key import" commands
2016-09-27 15:24:31 +02:00
Martin Hostettler
4f9f25db02 development.rst: Add sphinx_rtd_theme to the sphinx install command
It’s used by default, so install it as well.
2016-09-25 21:45:15 +02:00
Thomas Waldmann
28c57f98c9 Merge branch '1.0-maint'
# Conflicts:
#	src/borg/archive.py
#	src/borg/archiver.py
#	src/borg/helpers.py
#	src/borg/testsuite/archiver.py
2016-09-25 17:30:55 +02:00
Stefano Probst
deadc81729 Fix inconsistency in FAQ
The script in the FAQ is named pv-wrapper. But in the variable export pv-wrapper.sh was used.
2016-09-17 09:14:01 +02:00
Thomas Waldmann
2aa06533a3 fixup: typo in development.rst 2016-09-14 02:59:52 +02:00
Thomas Waldmann
1287d1ae92 Merge branch '1.0-maint' into merge-1.0-maint
# Conflicts:
#	docs/development.rst
#	src/borg/archive.py
#	src/borg/archiver.py
#	src/borg/hashindex.pyx
#	src/borg/testsuite/hashindex.py
2016-09-14 02:53:41 +02:00
Thomas Waldmann
b2e389e0a0 docs: add contribution guidelines 2016-09-08 19:40:32 +02:00
Thomas Waldmann
f70008238a link reference docs and faq about BORG_FILES_CACHE_TTL, fixes #1561 2016-09-03 19:23:59 +02:00
Thomas Waldmann
83c99943c3 ran build_usage 2016-08-28 00:17:24 +02:00
Thomas Waldmann
6dd29cfb1e ran build_api, reorder as in 1.0 2016-08-28 00:16:19 +02:00
Thomas Waldmann
3f159ba18a update CHANGES 2016-08-28 00:03:16 +02:00
Thomas Waldmann
1f04820d9d fuse: implement versions view
all archives, all items are read to build a unified view.
files are represented by a same-name directory with the versions of the file.
A filename suffix computed by adler32(chunkids) is used to disambiguate the versions.

also: refactor code a little, create methods for leaves, inner nodes.
2016-08-27 23:17:57 +02:00
Marian Beermann
e0b9aede29 update changes (1.1.0b1) 2016-08-27 22:43:41 +02:00
Thomas Waldmann
1974824595 Merge branch '1.0-maint' 2016-08-26 20:47:23 +02:00
sven
248ccf0149 Update borg.css 2016-08-23 15:01:39 +02:00
sven
ff04c059b7 Addjust border color
This changes the border-color to match with the background-color
2016-08-23 14:27:26 +02:00
Thomas Waldmann
6da34fcc5a add debug-info usage help file 2016-08-22 00:14:11 +02:00
Carlo Teubner
3f30649a85 internals.rst: fix typos 2016-08-22 00:10:49 +02:00
Thomas Waldmann
a7c370b5ed add debug-info usage help file 2016-08-21 23:37:07 +02:00
Andrew Engelbrecht
f8bb73732c added doc for "pull" type backup over sshfs
Fixes #900
2016-08-21 01:04:16 -04:00
Carlo Teubner
1c666222a7 internals.rst: fix typos 2016-08-21 00:15:56 +02:00
Thomas Waldmann
c355f3617a Merge branch '1.0-maint' 2016-08-20 00:04:55 +02:00
Thomas Waldmann
f32c8858ad update CHANGES with description of issue #1428 2016-08-18 23:22:50 +02:00
Thomas Waldmann
2aae0b17c6 update CHANGES 2016-08-18 22:15:30 +02:00
Thomas Waldmann
e3c155e75a use a clean repo to test / build the release 2016-08-15 15:41:24 +02:00
Marian Beermann
ac80332ce7 Merge branch '1.0-maint' into master
# Conflicts:
#	src/borg/repository.py
#	src/borg/testsuite/repository.py
2016-08-14 15:51:49 +02:00
Thomas Waldmann
8be6761c26 Merge commit 'feb7e2517ef7ec07cc638953a86c726aada7d37e' 2016-08-14 15:05:11 +02:00
enkore
17aacb9719 Fix changes.rst formatting, clarify changelog 2016-08-13 10:18:41 +02:00
Thomas Waldmann
07b47ef4a5 update CHANGES 2016-08-13 02:23:40 +02:00
TW
00449ad7b0 Merge pull request #1470 from ThomasWaldmann/document-archive-limit
document archive limitation, #1452
2016-08-13 00:12:17 +02:00
TW
4e5b80bbd5 Merge pull request #1464 from ThomasWaldmann/fix-xattr-exception
xattr: dynamically grow result buffer until it fits, fixes #1462
2016-08-12 18:21:59 +02:00
Thomas Waldmann
3c7dddcb99 update changelog 2016-08-12 18:00:50 +02:00
Thomas Waldmann
c834b2969c document archive limitation, #1452 2016-08-12 17:54:15 +02:00
Thomas Waldmann
6e658a5a6c docs: improve prune examples 2016-08-10 15:45:57 +02:00
Thomas Waldmann
c955d59273 Merge branch '1.0-maint' 2016-08-09 20:09:13 +02:00
Thomas Waldmann
a360307938 repo: do not put objects that we won't get, fixes #1451
we will not get() objects that have a segment entry larger than MAX_OBJECT_SIZE.
thus we should never produce such entries.

also: introduce repository.MAX_DATA_SIZE that gives the max payload size.
2016-08-09 18:05:22 +02:00
Thomas Waldmann
6c1c87f7ae add forgotten usage help file from build_usage 2016-08-06 01:28:02 +02:00
Thomas Waldmann
dbe862f3d8 Merge branch '1.0-maint' into merge-1.0-maint 2016-08-06 01:24:22 +02:00
Thomas Waldmann
a56b010960 ran build_usage 2016-08-05 20:26:09 +02:00
Thomas Waldmann
5b575f69dc CHANGES: add date to 1.0.7rc1 2016-08-05 20:23:47 +02:00
Thomas Waldmann
b79e913244 update CHANGES 2016-08-05 19:56:10 +02:00
Robert Marcano
bc6050bc3c Add backup using stable filesystem names recommendation 2016-08-03 22:54:51 -04:00
anarcat
661e8ebceb point to code, issues and support in devel section
real story: users that are also developpers expect to find out where
to submit issues and pull requests in the development section, but
couldn't. add some meat there and point to the support section for
everything else.
2016-08-03 11:37:46 -04:00
enkore
3079b6451e Merge pull request #1410 from ThomasWaldmann/doc-tweaks
docs: remove borg list example, be more specific about compression heuristics
2016-07-31 23:21:15 +02:00
Thomas Waldmann
8e222d8fd9 glibc compatibility: add FAQ entry, fixes #491 2016-07-31 14:42:34 +02:00
Thomas Waldmann
ad38f794e0 add hint about borg with-lock to FAQ, fixes #1353 2016-07-31 02:04:56 +02:00
Thomas Waldmann
5f7b466969 implement BORG_FILES_CACHE_TTL, update FAQ
raise default ttl to 20 (previously: 10).
2016-07-31 01:33:46 +02:00
Thomas Waldmann
9865509105 docs: remove borg list example, be more specific about compression heuristics 2016-07-30 21:21:45 +02:00
Thomas Waldmann
4e737cb64b OS X: install pkg-config to build with FUSE support 2016-07-30 21:08:20 +02:00
enkore
e09a059ce8 Merge pull request #1336 from enkore/issue/1272
Check free space before committing
2016-07-30 16:04:59 +02:00
Marian Beermann
e9a73b808f Check for sufficient free space before committing 2016-07-30 00:04:27 +02:00
Marian Beermann
ba23265559 docs, development: link to appveyor 2016-07-30 00:01:19 +02:00
Marian Beermann
4e3bfabebf docs, platform/features: linux has BSD flag emulation 2016-07-30 00:01:05 +02:00
TW
9f996da640 Merge pull request #1380 from jzacsh/document-envvars-pitfalls
doc: quickstart on shell pitfalls for env. vars
2016-07-28 20:18:32 +02:00
Jonathan Zacsh
1eaf1b7365
follow automation quickstart w/env. var pitfalls
Mostly commentary on proper `export` usage, pitfall w/sudo, and debugging tips.
2016-07-28 14:10:28 -04:00
Thomas Waldmann
04ad1d1b0b use "part file", "part", etc. consistently
use .borg_part_N as filename to avoid collisions
2016-07-28 19:39:29 +02:00
Thomas Waldmann
a7fca52f07 create part items rather than checkpoint items
checkpoint items: chunks abc, abcdef, abcdefghi, ....
part items: chunks abc, def, ghi

solves the "restore a big file over unstable connection issue" (not very comfortably, but
one can just extract one part after the other and concatenate them to get the full file)
2016-07-28 19:39:29 +02:00
Thomas Waldmann
e5bd6cef20 add --consider-checkpoint-files option, update FAQ 2016-07-28 19:39:29 +02:00
Thomas Waldmann
0ea6745250 update faq: we have in-file checkpoints now
note: until there is some means to list and extract the (partial) checkpoint
items, we do not need to talk about them.
2016-07-28 19:39:29 +02:00
Lee Bousfield
b652f4039c
Remove trailing whitespace 2016-07-28 10:35:41 -04:00
Marian Beermann
ac8c8119a7
Merge branch '1.0-maint' into master 2016-07-28 00:29:43 +02:00
enkore
f811624fab Merge pull request #1388 from enkore/f/document-platforms2
Platform feature matrix
2016-07-28 00:17:26 +02:00
Marian Beermann
c5fffbefff Platform feature matrix 2016-07-27 23:54:15 +02:00
Lee Bousfield
0a4a95eb17
Remove trailing whitespace 2016-07-27 10:05:51 -04:00
Thomas Waldmann
b33f8b4ff1 update faq with new 30 mins checkpoint interval 2016-07-21 21:03:22 +02:00
Marian Beermann
b9952efd68 faq: 'A' unchanged file; remove ambiguous entry age sentence. 2016-07-15 00:43:49 +02:00
Marian Beermann
2e6eb63174
Merge branch '1.0-maint' into master 2016-07-14 01:28:26 +02:00
Thomas Waldmann
bbb280c129 ran build_usage 2016-07-12 23:10:13 +02:00
Marian Beermann
06a1a899ee update CHANGES 2016-07-12 20:55:26 +02:00
Thomas Waldmann
cf4d761042 docs: fix the highlighting
default is "python", that's why some help fragments and bash scripts looked strange.
2016-07-11 23:16:53 +02:00
Thomas Waldmann
8c4802312d add picture made by anarcat 2016-07-11 02:47:43 +02:00
Thomas Waldmann
3baa8a3728 Merge branch '1.0-maint'
# Conflicts:
#	docs/changes.rst
#	docs/usage/mount.rst.inc
#	src/borg/archive.py
#	src/borg/archiver.py
#	src/borg/fuse.py
#	src/borg/testsuite/archiver.py
2016-07-11 01:23:27 +02:00
Thomas Waldmann
b8198c4ff1 ran build_usage 2016-07-10 19:00:55 +02:00
Thomas Waldmann
232abd16a8 update CHANGES 2016-07-10 18:45:46 +02:00
TW
57dcb938eb Merge pull request #1306 from ThomasWaldmann/docs-issues
docs issues
2016-07-10 17:27:15 +02:00
Thomas Waldmann
4fecd223c8 api.rst: remove problematic stuff, fixes #881
some cython stuff can't be processed by sphinx.
some platform-dependant modules can't get imported.

also: reordered modules in api.rst so order makes some sense.
2016-07-10 17:26:04 +02:00
Thomas Waldmann
2f21488e81 fix most python-source related sphinx warnings 2016-07-10 17:26:04 +02:00
Thomas Waldmann
5660cd1f96 fix most non-python-source related sphinx warnings
literal blocks must be followed by an empty line

suppressed the non-local image uri warning via sphinx config

the links on the resources page must have different label texts

setup.py: do not generate pointless "::\n" - it does not create a literal block if the stuff below is not indented
2016-07-10 17:25:51 +02:00
Marian Beermann
c4a8c53547
changelog: Added release dates to older borg releases 2016-07-10 00:55:51 +02:00
Thomas Waldmann
fe627246e4 Merge branch '1.0-maint' 2016-07-08 12:13:52 +02:00
Thomas Waldmann
66cc520880 update CHANGES 2016-07-07 22:25:49 +02:00
Thomas Waldmann
1fe3781186 backport some FAQ entries from master branch 2016-07-07 21:56:06 +02:00
Thomas Waldmann
3218c5945a ran build_api / build_usage 2016-07-07 05:04:19 +02:00
Thomas Waldmann
a4603cf010 update CHANGES 2016-07-07 04:57:44 +02:00
TW
91d1a4f76f Merge pull request #1278 from ThomasWaldmann/update-cygwin-docs
update cygwin installation docs
2016-07-07 04:12:47 +02:00
Thomas Waldmann
12f55f4e9f Merge branch '1.0-maint' 2016-07-06 01:33:53 +02:00
Thomas Waldmann
8db670cf7f update CHANGES 2016-07-06 00:37:01 +02:00
TW
9fa8aa495c Merge pull request #1263 from enkore/issue/1262
Repository: cleanup on ENOSPC
2016-07-06 00:23:55 +02:00
Thomas Waldmann
740c638030 update usage files 2016-07-05 23:30:08 +02:00
Marian Beermann
7ed425dae0
Repository: cleanup on ENOSPC 2016-07-05 20:33:07 +02:00
Jens Rantil
2922948100 Update faq.rst
Fix misspelling.
2016-07-05 18:23:42 +02:00
TW
6977fcf9e2 Merge pull request #1202 from ThomasWaldmann/update-1.0-changes
update CHANGES
2016-07-05 01:04:48 +02:00
Thomas Waldmann
19d1bbfa14 add advice about issue #1138, fixes #1223 2016-07-05 00:58:42 +02:00
Thomas Waldmann
54e5667477 update CHANGES 2016-07-05 00:58:42 +02:00
enkore
2fd6e5cf12 Merge pull request #1260 from ThomasWaldmann/update-frontpage
update frontpage / support docs
2016-07-04 23:38:02 +02:00
TW
65c1f40e2a Merge pull request #1261 from dragetd/patch-doc-compression
Update docs about lzma compression levels above 6
2016-07-04 23:36:17 +02:00
Thomas Waldmann
20eab2b5c8 update frontpage / support docs
less items in frontpage link list
add IRC chat link
minor other changes
2016-07-04 22:37:24 +02:00
Michael Gajda
0b488760a7 Update docs about lzma compreesion levels above 6
lzma compression levels above 6 do not increase compression ration but waste a lot of cpu cycles.
2016-07-04 21:58:52 +02:00
Thomas Waldmann
f363ddd7ca Merge branch '1.0-maint' 2016-07-04 20:11:21 +02:00
Thomas Waldmann
3325126988 add missing BORG_REMOTE_PATH env var, fixes #1258 2016-07-04 15:06:20 +02:00
Thomas Waldmann
d59a1d5fef doc and help update for --read-special 2016-07-04 14:06:30 +02:00
Thomas Waldmann
7231107b5a update cygwin installation docs
cython is installed with pip later.
liblz4 is available from normal cygwin packages now.
creation of virtualenv worked now without issues.
2016-07-04 03:47:54 +02:00
Joachim Breitner
f6deb09184 Documentation: Explicate that Fnmatch is default
This fixes #1247. It also regenerates the usage documentation, so that
styling fixex in that section (as well as other existing changes) make
it into the files in docs/.
2016-07-03 16:57:23 +02:00
Lee Bousfield
c515d6018d
Add --append-only to borg serve
Fixes #1168
2016-06-30 17:58:36 -04:00
Thomas Waldmann
87d6755108 Merge branch '1.0-maint' 2016-06-29 18:28:33 +02:00
Thomas Waldmann
c773c882b9 add prune visualization / example, fixes #723 2016-06-27 21:20:35 +02:00
Thomas Waldmann
ed128e517b Merge branch '1.0-maint' 2016-06-25 17:18:14 +02:00
Thomas Waldmann
b10025c6e5 document sshd settings, fixes #545 2016-06-24 23:30:27 +02:00
Thomas Waldmann
f54f159db8 more details about checkpoints, add split trick, fixes #1171 2016-06-24 22:32:38 +02:00
Thomas Waldmann
ad65c5ac16 support docs: add freenode web chat link, fixes #1175 2016-06-24 21:48:21 +02:00
Thomas Waldmann
5ae340998c update docs about placeholders 2016-06-22 08:40:31 +02:00
Abogical
6658112f8c Add documentation for listing repository archives 2016-06-21 20:01:01 +03:00
Thomas Waldmann
9a64835b4d Merge branch '1.0-maint'
Also: add missing keys to ARCHIVE_KEYS set.
2016-06-13 00:14:08 +02:00
Michael Herold
d45a13babf Changes archive format from uuid to uuid4
This allows for future support of other uuid versions
2016-06-11 22:57:03 +02:00
Michael Herold
5aa97e283c Adds uuid to archive format tags 2016-06-11 12:03:55 +02:00
Dan Helfman
7642632359 Update resources.rst to rename atticmatic to borgmatic
atticmatic wrapper script has been renamed to borgmatic!
2016-06-10 19:27:19 -07:00
anarcat
5167dca58c update install docs table again
* sort install list (fedora was out of place)
* add EPEL
* borg is not young anymore, warn about old distros
* more coherent *BSD ports naming
* add raspbian, openindiana and mageia
2016-06-04 10:42:07 -04:00
Thomas Waldmann
d62f55158e sphinx: fix sys.path so it finds the borg package 2016-05-30 23:00:33 +02:00
Thomas Waldmann
b8303a38bf Merge branch '1.0-maint' 2016-05-20 22:48:57 +02:00
Thomas Waldmann
5be71b506e update CHANGES 2016-05-20 21:49:01 +02:00
Thomas Waldmann
8d8374d23c ran build_api + build_usage 2016-05-20 14:34:48 +02:00
Thomas Waldmann
1e061a2fa4 update CHANGES 2016-05-20 14:05:05 +02:00
Ed Blackman
226e5519f3 Print implied output without --info/-v
There are persistent questions why output from options like --list
and --stats doesn't show up.  Also, borg currently isn't able to
show *just* the output for a given option (--list, --stats,
--show-rc, --show-version, or --progress), without other INFO level
messages.

The solution is to use more granular loggers, so that messages
specific to a given option goes to a logger designated for that
option.  That option-specific logger can then be configured
separately from the regular loggers.

Those option-specific loggers can also be used as a hook in a
BORG_LOGGING_CONF config file to log the --list output to a separate
file, or send --stats output to a network socket where some daemon
could analyze it.

Steps:
- create an option-specific logger for each of the implied output options
- modify the messages specific to each option to go to the correct logger
- if an implied output option is passed, change the option-specific
  logger (only) to log at INFO level
- test that root logger messages don't come through option-specific loggers

They shouldn't, per https://docs.python.org/3/howto/logging.html#logging-flow
but test just the same.  Particularly test a message that can come from
remote repositories.

Fixes #526, #573, #665, #824
2016-05-18 14:58:44 -04:00
Marian Beermann
deab8ca7e2
init: move epilogue from docs/usage into help output
Also tell which algos are used and that HW accel is supported.
2016-05-17 01:00:48 +02:00
Marian Beermann
c52861e0ca
Improve LoggedIO write performance, make commit mechanism more solid
- Instead of very small (5 MB-ish) segment files, use larger ones
- Request asynchronous write-out or write-through (TODO) where it is supported,
  to achieve a continuously high throughput for writes
- Instead of depending on ordered writes (write data, commit tag, sync)
  for consistency, do a double-sync commit as more serious RDBMS also do
  i.e. write data, sync, write commit tag, sync
  Since commits are very expensive in Borg at the moment this makes no
  difference performance-wise.

New platform APIs: SyncFile, sync_dir

[x] Naive implementation (equivalent to what Borg did before)
[x] Linux implementation
[ ] Windows implementation
[-] OSX implementation (F_FULLSYNC)
2016-05-14 22:47:18 +02:00
TW
2cc117f4b0 Merge pull request #1028 from ThomasWaldmann/improve-example-script
improve backup example script, fixes #1020
2016-05-07 20:41:53 +02:00
Thomas Waldmann
06caee2ed0 improve backup example script, fixes #1020 2016-05-07 19:22:48 +02:00
Thomas Waldmann
d2988444c0 better help / docs for borg extract --dry-run, fixes #1022 2016-05-07 18:53:58 +02:00
Thomas Waldmann
4c52fcffcc faq: be more detailed about how checkpoints work, fixes #994 2016-05-05 18:59:03 +02:00
TW
571329e6ae Merge pull request #1013 from ThomasWaldmann/docs-fix-issue-links
faq: fix issue links
2016-05-05 18:31:04 +02:00
Thomas Waldmann
619654b802 faq: fix issue links 2016-05-05 18:16:32 +02:00
Thomas Waldmann
8304b8a591 FAQ: add entries about compromised machines and other troubles
also: fix append-only mode description - "multiple machines" and "central server" are over-specific and not required for this scenario.
2016-05-05 17:52:31 +02:00
Thomas Waldmann
39c0757020 Merge branch '1.0-maint' 2016-05-05 13:55:38 +02:00
TW
f9638645d1 Merge pull request #996 from ThomasWaldmann/update-1.0-docs
update CHANGES in 1.0-maint
2016-05-05 13:51:59 +02:00
Thomas Waldmann
7457c0f5da update CHANGES in 1.0-maint 2016-05-05 13:43:40 +02:00
Thomas Waldmann
9e09786b33 borg create help: document format tags, fixes #894
docs: rephrased, more useful examples
2016-05-05 13:38:08 +02:00
Thomas Waldmann
962c2e9d54 borg with-lock REPO CMD ARGS 2016-05-02 23:29:17 +02:00
Thomas Waldmann
e7ca74fbef move BORG_KEY_FILE closer to BORG_KEYS_DIR 2016-05-02 00:38:16 +02:00
Félix Sipma
a5ba0abe42 support new env var 'BORG_KEY_FILE' 2016-05-01 21:15:09 +02:00
Thomas Waldmann
b641d11e1b Merge branch '1.0-maint' 2016-05-01 20:28:17 +02:00
Thomas Waldmann
240e5696b7 fix vagrant ssh syntax, fixes #999 2016-05-01 20:18:17 +02:00
Thomas Waldmann
700e715b23 add missing docs for borg break-lock, fixes #992 2016-04-30 00:32:25 +02:00
Thomas Waldmann
4b73ebc613 update readthedocs urls, fixes #991 2016-04-29 03:19:27 +02:00
TW
2bb9bc46ad Merge pull request #810 from ThomasWaldmann/flexible-compression
Flexible compression - pattern matching on path/filename
2016-04-27 23:41:54 +02:00
Thomas Waldmann
f20a78cda8 flexible compression 2016-04-27 03:08:55 +02:00
anarcat
0a30d40a9d fix debian sid cross-reference in install docs 2016-04-25 22:54:36 -04:00
TW
f6d363ecf9 Merge pull request #956 from icefoxen/master
Added Salt example to documentation
2016-04-25 15:30:14 +02:00
TW
a220a2d617 Merge pull request #969 from rumpelsepp/patch-2
docs/installation: Add FreeBSD Ports tree
2016-04-23 13:55:37 +02:00
TW
17afc7d851 Merge pull request #961 from scoobadog/fedora-instructions
Fix Fedora installation instructions
2016-04-23 13:54:08 +02:00
Janne K
61a8ff40f3 Package is not needed in Korora 2016-04-23 11:51:38 +03:00
Stefan Tatschner
ab4a1a1025 docs/installation: Add FreeBSD Ports tree
https://svnweb.freebsd.org/ports?view=revision&revision=413469

It is not yet in "pkg"; that will automatically happen in the next quarterly period.
2016-04-23 09:02:02 +02:00
Janne K
257995d185 Fix Fedora installation instructions
Update installation instructions so that the following error won't occur:

gcc: error: /usr/lib/rpm/redhat/redhat-hardened-cc1: No such file or directory
error: command 'gcc' failed with exit status 1
2016-04-22 17:07:31 +03:00
Thomas Waldmann
f8fb99d245 update CHANGES 2016-04-22 03:33:03 +02:00
Simon Heath
43fc7a267f Fixed formatting 2016-04-21 15:11:43 -04:00
Simon Heath
621aed00db Contributed Salt example to docs 2016-04-21 15:10:25 -04:00
Thomas Waldmann
4de14fdd28 Merge branch '1.0-maint' 2016-04-16 16:58:43 +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
Hans-Peter Jansen
4bf40f4178 Fix package naming for openSUSE 2016-04-11 10:08:16 +02:00
Benjamin Pereto
1e1dae3bb6 added package docs for fedora 2016-04-10 17:55:36 +02:00
TW
c3e6bc2b7e Merge pull request #812 from enkore/feature-rewrite
feature recreate
2016-04-10 17:20:41 +02:00
TW
ea1ebb80bf Merge pull request #868 from anarcat/patch-2
add link to OpenBSD port and OpenSUSE
2016-04-10 17:06:45 +02:00
Marian Beermann
d5ad063d13
recreate: add experimental warning for now 2016-04-10 16:53:38 +02:00
Marian Beermann
0bc0fa22b4
recreate: improve tests, docs, check chunk availability[1]
[1] So if e.g. delete/prune/check are run these can delete the
    recreate_partial_chunks. This is now caught and handled correctly.
2016-04-10 15:59:12 +02:00
Marian Beermann
4b5e6ffa77
Assimilate "borg comment" into "borg recreate" 2016-04-10 14:09:09 +02:00
Marian Beermann
a3ee9d2c5f borg recreate: Re-create existing archives.
Use with caution: permanent data loss by specifying incorrect patterns
is easily possible. Make a dry run to make sure you got everything right.

borg recreate has many uses:
- Can selectively remove files/dirs from old archives, e.g. to free
  space or purging picturarum biggus dickus from history
- Recompress data
- Rechunkify data, to have upgraded Attic / Borg 0.xx archives deduplicate
  with Borg 1.x archives. (Or to experiment with chunker-params for
  specific use cases

It is interrupt- and resumable.

Chunks are not freed on-the-fly.
Rationale:
  Makes only sense when rechunkifying, but logic on which new chunks to
  free what input chunks is complicated and *very* delicate.

Future TODOs:
- Refactor tests using py.test fixtures
  -- would require porting ArchiverTestCase to py.test: many changes,
     this changeset is already borderline too large.
- Possibly add a --target option to not replace the source archive
  -- with the target possibly in another Repo
     (better than "cp" due to full integrity checking, and deduplication
      at the target)
- Detect and skip (unless --always-recompress) already recompressed chunks

Fixes #787 #686 #630 #70 (and probably some I overlooked)
Also see #757 and #770
2016-04-10 13:54:44 +02:00
Marian Beermann
0a369c0985
Better help texts and Sphinx reproduction of usage
- Group options
- Nicer list of options in Sphinx
- Deduplicate 'Common options'
  (including --help)

The latter is done by explicitly declaring --help in the common_parser,
which is then inherited by the sub-parsers; no change in observable
behaviour.
2016-04-10 01:28:19 +02:00
Thomas Waldmann
cece7f9e6d merged 1.0-maint into master 2016-04-10 01:13:35 +02:00
anarcat
17c0a3a8fa cleanup ubuntu in install list
ubuntu was showing up twice in the list of supported OSes... it seems it was because the line was getting too long, so I removed the "names" and kept only the numbers to keep the line short.
2016-04-09 16:27:43 -04:00
anarcat
3cd6f52521 add link to OpenBSD port and OpenSUSE
see the ever-growing #105
2016-04-09 16:19:03 -04: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
Lauri Niskanen
327c7219df Add archive comments
- Archives now have a new metadata field 'comment'
- 'info' command shows a comment if it's present
- 'create' command now has option '--comment' for adding comments to archives.
- A new command 'comment' is added for modifying the comments on existing
  archives.

Resolves #842.
2016-04-08 19:03:14 +03: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
anarcat
287f49503b add jessie-backports to supported platforms
see #105
2016-04-03 12:23:32 -04: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
TW
d6590b4e2d Merge pull request #821 from borgbackup/1.0-maint
merge 1.0-maint
2016-04-01 00:19:01 +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
TW
d56e4c5370 Merge pull request #818 from borgbackup/1.0-maint
merge append-only from 1.0 maint
2016-03-31 20:28:49 +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
Lauri Niskanen
9d1a30c08b Add '--sort' option for sorting diff command output
Previously, on 'borg diff', the output always had first the modifications, then
additions, and finally removals. Output may be easier to follow if the various
kinds of changes are interleaved. This commit is a simple solution that first
collects the output lines and sorts them by file path before printing. This new
behavior is optional and disabled by default. It can be enabled with '--sort'
command line option.

This option will be especially useful after the planned multi-threading changes
arrive. Multi-threading may shuffle the archive order of files making diff
output hard to follow without sorting.

Resolves #797.
2016-03-31 18:55:02 +03:00
Ed Blackman
2ab324c03f Add 'x' status for excluded paths (#814)
Makes it easy to see paths excluded by --exclude* options for testing of
regexes, and for ongoing monitoring that files desired for backup aren't
getting excluded accidentally.
2016-03-30 22:38:31 -04:00
Lauri Niskanen
1d3e69e4c7 Improve 'borg diff' output format
The main design goals of the new format:
 - One file takes exactly one line of output
 - The format is easy to read with typical, long list of changes
 - Metadata changes are visible and easy to examine
 - Unuseful information is not shown

Resolves #757.
2016-03-26 23:50:03 +02:00
Thomas Waldmann
d6b85a6a3b Merge branch 'packaged-for-guix' of https://github.com/lfam/borg into lfam-packaged-for-guix 2016-03-26 14:20:48 +01:00
wormingdead
f5ea7f5643 Document logo font. Recreate logo png. Remove GIMP logo file. 2016-03-25 22:43:29 -07:00
infectormp
7412e30977 Installation: Mention Gentoo package
docs/installation.rst: Add Gentoo package to list of distribution packages.
2016-03-25 09:21:18 +03:00
lfam
587abf5376 Installation: Mention GNU Guix package.
* docs/installation.rst: Add GNU Guix package to list of distribution packages.
2016-03-25 00:13:24 -04:00
Thomas Waldmann
601313836d Merge branch 'master' of github.com:borgbackup/borg 2016-03-21 16:14:24 +01:00
Thomas Waldmann
de7582a9d7 Merge branch '1.0-maint' 2016-03-21 16:13:08 +01:00
Thomas Waldmann
40dbb7411c fix cygwin requirements (gcc-g++) 2016-03-21 16:11:43 +01:00
Marian Beermann
9cf129935e borg diff help: clarify: for new archives different chunker params still require content compare 2016-03-18 15:42:32 +01:00
Marian Beermann
e64d91b735 Update borg diff help message regarding --same-chunker-params 2016-03-18 13:30:39 +01:00
Marian Beermann
0e9aea2660 Update borg diff example 2016-03-18 13:30:02 +01:00
Marian Beermann
343d84b427 ItemFormatter: group keys in help output 2016-03-18 13:29:49 +01:00
Marian Beermann
89120a9843 Update usage docs 2016-03-18 12:17:57 +01:00
Daniel Reichelt
9adf13d8b9 add changes from running build_api and build_usage 2016-03-17 14:35:56 +01:00
Daniel Reichelt
e1f6a34820 provide wrapper for borg mount, fixes #743
- add archiver.main_mount()

- provide borgfs behaviour when the monolithic binary is called via a
  symlink called borgfs

- docs: update usage of mount subcommand, provide examples for borgfs and
  add symlink creation to standalone binary installation

- run build_usage

- add entry point in setup.py

- patch helpers.py:get_keys_dir() to allow mounting fstab entries with
  "user" option set

  Without this, setuid() called at some point by mount changes the HOME
  environment variable to '/root' and os.expanduser('~') would return
  '/root' as well, thus the mount would fail with
 	 PermissionError: [Errno 13] Permission denied: '/root/.config'
  After setuid(), the HOME variable stays intact, so we still can
  explicitly query USER's home.

  Also, os.path.expanduser() behaves differently for '~' and '~someuser'
  as parameters: when called with an explicit username, the possibly set
  environment variable HOME is no longer respected. So we have to check if
  it is set and only expand the user's home directory if HOME is unset.

- add myself to AUTHORS
2016-03-17 01:40:17 +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
Thomas Waldmann
21bd01ef16 add a --filter option replacing --changed/--unchanged
the problem here was that we do not just have changed and unchanged items,
but also a lot of items besides regular files which we just back up "as is" without
determining whether they are changed or not. thus, we can't support changed/unchanged
in a way users would expect them to work.

the A/M/U status only applies to the data content of regular files (compared to the index).
for all items, we ALWAYS save the metadata, there is no changed / not changed detection there.

thus, I replaced this with a --filter option where you can just specify which
status chars you want to see listed in the output.

E.g. --filter AM will only show regular files with A(dded) or M(odified) state, but nothing else.
Not giving --filter defaults to showing all items no matter what status they have.

Output is emitted via logger at info level, so it won't show up except if the logger is at that level.
2015-12-02 03:29:20 +01:00
Stavros Korokithakis
e6d3720d9b Clarify encryption. 2015-12-02 01:48:08 +02:00
Vlad
5280c0830e Borg moved to Arch Linux [community] 2015-12-02 00:16:25 +02:00
Antoine Beaupré
b09643e14f change file status test and cleanup last ref to --verbose
this ports the changes here to #445
2015-11-24 12:11:43 -05:00
Antoine Beaupré
a062e8f821 update documentation to follow changes 2015-11-24 12:07:57 -05:00
TW
d1377e5e15 Merge pull request #445 from anarcat/status-bug
add test for the weird unchanged file status
2015-11-24 18:04:09 +01:00
Thomas Waldmann
a8227aeda0 update CHANGES 2015-11-24 17:38:12 +01:00
Antoine Beaupré
48bb4c326d cross-reference the status oddity in the usage 2015-11-23 19:48:33 -05:00
Antoine Beaupré
af7b17960e clarify documentation on the A status oddity 2015-11-23 19:44:54 -05:00
Thomas Waldmann
25140e8c82 add --log-level to set the level of the builtin logging configuration, fixes #426 2015-11-21 02:09:16 +01:00
Thomas Waldmann
c4dae52ca4 configure logging via env var, use LazyLogger
logging.raiseExceptions not needed any more for py >= 3.2
2015-11-21 01:14:07 +01:00
Thomas Waldmann
42e9a77f5b style changes of previous changeset did not work on rtd, try 2 2015-11-20 19:32:04 +01:00
Thomas Waldmann
077bcd0cde logo: have a separate, bigger logo (do not reuse the favicon)
currently just scaled up / converted to png from the favicon.ico.
2015-11-20 19:06:40 +01:00
Thomas Waldmann
87bb886705 rtd theme adjustment: borg darkness for the upper left corner 2015-11-20 18:51:11 +01:00
Thomas Waldmann
7a08368b65 fix html_theme_path overriding previous definition of it 2015-11-20 17:56:35 +01:00
Thomas Waldmann
57ffa4d648 more precise binary installation steps 2015-11-20 15:49:53 +01:00
Thomas Waldmann
67c85734ba upgrade OS X FUSE to 3.0.9, update release todo docs 2015-11-20 01:12:31 +01:00
Thomas Waldmann
dcab7dd8a7 new mailing list borgbackup@python.org
also: remove mailing list and irc channel address from development docs,
it is enough to have this information on the main page and on the support page.
2015-11-18 15:40:23 +01:00
Thomas Waldmann
2e64c29e01 use ISO-8601 date and time format, fixes #375 2015-11-16 23:51:21 +01:00
Thomas Waldmann
559c8908c1 add FAQ entry about unexpected 'A' status for unchanged file(s), fixes #403 2015-11-16 21:30:16 +01:00
Thomas Waldmann
38472900af add 'E' file status to docs 2015-11-16 15:38:06 +01:00
Antoine Beaupré
917236231f correct ubuntu release number 2015-11-16 09:07:59 -05:00
Antoine Beaupré
3bbd3319a4 use 'distribution' more consistently 2015-11-15 22:43:08 -05:00
Antoine Beaupré
d78d6d60b1 turn distro list into a table, adding Debian, Ubuntu, OSX 2015-11-15 22:40:00 -05:00
Antoine Beaupré
2c3f3f1b07 install docs: don't use "from" twice
it always abstracts "pypi" and "github" away (technical words that are
not necessary). pip remains.
2015-11-15 22:20:07 -05:00
Thomas Waldmann
3a72fbe418 update CHANGES 2015-11-15 20:30:58 +01:00
Thomas Waldmann
0070ef0c4a minor install docs fixes 2015-11-15 20:23:33 +01:00
TW
eefc137ec9 Merge pull request #412 from anarcat/install-docs-nitpick
Install docs nitpick
2015-11-15 20:19:17 +01:00
Thomas Waldmann
234a88bec6 avoid hidden import, make it easy for pyinstaller
this fixes #218 in an easier way so one doesn't have to type
--hidden-import=logging.config all the time when using pyinstaller.
2015-11-15 15:52:02 +01:00
Thomas Waldmann
d6b8de943b add docs for item flags / status output, fixes #402 2015-11-15 14:32:19 +01:00
Antoine Beaupré
aa4c76872c move pyinstaller mention out of heading
pyinstaller probably means nothing for most people, while standalone binary is more meaningful
2015-11-14 21:08:28 -05:00
Antoine Beaupré
a8d2c18fee split packaging meta-info in a separate paragraph and link to github 2015-11-14 21:07:16 -05:00
Antoine Beaupré
9f8700e383 restructure install page headings
do not repeat "installation" all the time, and regroup git and pip under "from source"

also link to the sections in the summary
2015-11-14 21:03:38 -05:00
Thomas Waldmann
fd5ccadcac update CHANGES 2015-11-14 23:48:44 +01:00
Antoine Beaupré
811c18dcd4 explain how to regenerate usage and API files and when 2015-11-13 10:46:13 -05:00
Antoine Beaupré
8e36075fe9 commit usage files directly into git
the generation of those files was causing us way too much pain to
justify automatically generating them all the time.

those will have to be re-generated with `build_api` or `build_usage`
as appropriate, for example when function signatures or commandline
flags change.

see #384
2015-11-13 10:42:52 -05:00
Antoine Beaupré
f13dd6e579 completely remove have_cython() hack
this was making us require mock, which is really a test component and
shouldn't be part of the runtime dependencies. furthermore, it was
making the imports and the code more brittle: it may have been
possible that, through an environment variable, backups could be
corrupted because mock libraries would be configured instead of real
once, which is a risk we shouldn't be taking.

finally, this was used only to build docs, which we will build and
commit to git by hand with a fully working borg when relevant.

see #384.
2015-11-13 10:40:53 -05:00
Thomas Waldmann
4a2e4ec683 update CHANGES 2015-11-08 17:10:18 +01:00
Thomas Waldmann
f48a5ae6a7 fix formatting issue in changes.rst 2015-11-08 02:17:37 +01:00
Thomas Waldmann
cd40ec280d update CHANGES 2015-11-08 01:29:53 +01:00
Thomas Waldmann
303bed9d12 docs: minor development docs update 2015-11-07 15:17:40 +01:00
Thomas Waldmann
c34ef37516 CHANGES: some fixes, add compatibility notes 2015-11-06 22:04:37 +01:00
Thomas Waldmann
47fec587d4 updated CHANGES 2015-11-06 21:33:43 +01:00
Thomas Waldmann
b1eb784bd1 docs: add section about debug commands 2015-11-06 18:31:06 +01:00
Thomas Waldmann
6c1b765741 docs: group general stuff under 1 headline, fix another headline level 2015-11-06 18:22:30 +01:00
Thomas Waldmann
f6244f006e docs: warn about not running out of space 2015-11-04 01:51:09 +01:00
Thomas Waldmann
bdf7dc65bd docs: add example for rename 2015-11-02 20:53:04 +01:00
Thomas Waldmann
734dae80ef improve chunker params docs, fixes #362 2015-11-02 19:47:09 +01:00
Thomas Waldmann
44083f7f73 updated CHANGES 2015-10-29 16:22:02 +01:00
Thomas Waldmann
b787ac6ea1 docs: remove api docs (too much breakage on rtd) 2015-10-27 20:46:57 +01:00
Thomas Waldmann
a16ae01289 borgbackup install+basics presentation(asciinema + script) 2015-10-24 23:40:51 +02:00
Thomas Waldmann
39fb9b176a update docs about return codes 2015-10-22 01:40:34 +02:00
TW
a1f88c73aa Merge pull request #322 from anarcat/docs
explicitely commit to the units standard
2015-10-21 15:30:23 +02:00
Antoine Beaupré
76c0804bd5 explicitely commit to the units standard, see #289 2015-10-21 09:25:46 -04:00
Antoine Beaupré
03d381c2f9 describe the current style guide in documentation 2015-10-20 14:43:49 -04:00
Thomas Waldmann
a4f136afba update CHANGES.rst (add issue / PR numbers) 2015-10-20 16:23:23 +02:00
Thomas Waldmann
344a25c102 update CHANGES.rst 2015-10-20 15:52:22 +02:00
Antoine Beaupré
de9e9d14b7 soften environment security warning to a note, and cross-ref to avoid dupe 2015-10-19 16:25:24 -04:00
Antoine Beaupré
c7c02ef725 fix path to favicon 2015-10-19 12:15:39 -04:00
Antoine Beaupré
5cd5fa72f6 warn users about the environment on multi-user systems 2015-10-19 11:29:22 -04:00