Commit Graph

670 Commits

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