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
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
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
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
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
a65707beb8
add more specific warning about write-access debug commands
2016-09-30 21:09:02 +02:00
Thomas Waldmann
e124f3c67b
update CHANGES
2016-09-29 17:16:57 +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
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
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
sven
248ccf0149
Update borg.css
2016-08-23 15:01:39 +02:00
Thomas Waldmann
a7c370b5ed
add debug-info usage help file
2016-08-21 23:37:07 +02:00
Carlo Teubner
1c666222a7
internals.rst: fix typos
2016-08-21 00:15:56 +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
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
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
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
Thomas Waldmann
8e222d8fd9
glibc compatibility: add FAQ entry, fixes #491
2016-07-31 14:42:34 +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
4e737cb64b
OS X: install pkg-config to build with FUSE support
2016-07-30 21:08:20 +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
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
Marian Beermann
b9952efd68
faq: 'A' unchanged file; remove ambiguous entry age sentence.
2016-07-15 00:43:49 +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
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
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
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
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
c773c882b9
add prune visualization / example, fixes #723
2016-06-27 21:20:35 +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
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
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
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