mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity
3,605 Commits 9 Branches 137 Tags 57 MiB
Commit Graph

751 Commits

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