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