Commit Graph

751 Commits

Author SHA1 Message Date
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