Commit Graph

73 Commits

Author SHA1 Message Date
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
8bit 8d830d069f Removed all |project_name
| instances, replaced with Borg
2017-10-17 11:50:55 -05:00
8bit 8db0c770c3 The user frees space, not borg 2017-10-03 16:32:58 -04:00
8bit 821baf0528 Minor grammar correction and added consistency with subsistitution of 'Borg' 2017-10-03 13:21:28 -04:00
rugk c5c361be0c Fix bashism in shell scripts (#2820)
Fix bashism in shell scripts, also fixes #2816

This makes the scripts fully POSIX-compatible.
Used shellcheck to check.
2017-07-20 00:23:59 +02:00
rugk b27b9894d1
Simplify ssh authorized_keys file
Just using "restrict"; closes https://github.com/borgbackup/borg/issues/2121
2017-06-23 13:28:49 +02:00
Marian Beermann aa7fbff55f docs: quickstart: delete problematic BORG_PASSPRHASE use 2017-06-06 21:29:31 +02:00
TuXicc 578b76af3a Added BORG_PASSCOMMAND environment variable (#2573) 2017-05-31 19:25:21 +02:00
Marian Beermann 1bbfb24d1a quickstart: fix rst issue 2017-03-03 15:27:17 +01:00
kmq c190a87eef
Improve automated backup script in doc fixes #2214 2017-03-02 05:48:30 +02:00
Marian Beermann 332f7898bc update docs for create -C default change 2017-02-26 23:07:31 +01:00
Martin Hostettler e0f36e8613 quickstart.rst: Add link to paperkey template. 2017-02-13 20:45:49 +01:00
Marian Beermann fa24e1f38f man pages: add borg(1) master/intro page 2017-02-12 15:28:59 +01:00
Marian Beermann 85cebd0419 Merge branch 'partial-1.0-maint' into merge/1.0-maint 2016-12-20 23:05:44 +01:00
Thomas Waldmann 880578da06 quickstart: use prune with --list
so people are better aware of what's happening, avoiding pitfalls
with wrong or missing --prefix.
2016-12-20 23:03:32 +01:00
Thomas Waldmann c83a124e65 Merge branch '1.0-maint' (into master) 2016-11-28 02:23:32 +01:00
Ben Creasy a49fc6faf5 Clarify extract is relative to current directory
I'm still hoping that a destination switch can be added (requested long ago in https://github.com/jborg/attic/issues/195), but in the meantime this may help. I'm guessing this clobbers any existing files.
2016-11-27 11:35:36 -08: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 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 9b9179312d ssh: repo url docs - fix typo 2016-10-28 03:32:37 +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
Thomas Waldmann dbe862f3d8 Merge branch '1.0-maint' into merge-1.0-maint 2016-08-06 01:24:22 +02:00
Marian Beermann e9a73b808f Check for sufficient free space before committing 2016-07-30 00:04:27 +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
Marian Beermann 2e6eb63174
Merge branch '1.0-maint' into master 2016-07-14 01:28: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 12f55f4e9f Merge branch '1.0-maint' 2016-07-06 01:33:53 +02:00
Marian Beermann 7ed425dae0
Repository: cleanup on ENOSPC 2016-07-05 20:33:07 +02:00
Thomas Waldmann ed128e517b Merge branch '1.0-maint' 2016-06-25 17:18:14 +02:00
Thomas Waldmann 5ae340998c update docs about placeholders 2016-06-22 08:40:31 +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
Thomas Waldmann 06caee2ed0 improve backup example script, fixes #1020 2016-05-07 19:22:48 +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 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 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
jhemmje 7e7c33c3cf docs: Updated examples in quickstart.rst, fixes #644 2016-02-15 21:38:02 +01:00
Thomas Waldmann 435d30d61b docs: updates and fixes 2016-02-01 03:22:02 +01:00
Thomas Waldmann e06b7162c2 update docs / docstring about new key location 2016-01-28 23:15:49 +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
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
Piotr Pawlow 7851df089a Disable unneeded SSH features in authorized_keys example for security. 2016-01-18 14:35:11 +01:00
Robin Schneider 19eb8e2d3b
Use ``--option`` in RST to not render "--" as "–". 2016-01-17 20:12:23 +01:00
Thomas Waldmann 8ce84cab30 update docs / make them more clear about -v 2016-01-14 19:34:07 +01:00
Thomas Waldmann bec2f72c8e mention --save-space at the place we talk about keeping disk space free 2015-12-08 18:36:41 +01:00
Stavros Korokithakis e6d3720d9b Clarify encryption. 2015-12-02 01:48:08 +02:00
Thomas Waldmann f6244f006e docs: warn about not running out of space 2015-11-04 01:51:09 +01:00