mirror
/
restic
mirror of https://github.com/restic/restic.git
1
0
Fork 0
Code Issues Releases Wiki Activity
6,515 Commits 7 Branches 48 Tags 92 MiB
Commit Graph

641 Commits

Author SHA1 Message Date
MichaelEischer ea81a0e282
Merge pull request #2606 from middelink/fix-323 
Add copy functionality.
 2020-08-30 10:18:24 +02:00
Michael Eischer bbe8b73f03 Update help text of backup command in docs 2020-08-29 10:48:44 +02:00
Michael Eischer 91e8d998cd Add documentation for copy command 2020-08-29 10:48:44 +02:00
Alexander Weiss 9867c4bbb4 Add flag --iexclude-file to backup 2020-08-28 21:04:41 +02:00
Jason Cox 2447f3f110 Update usage strings to put flags before args 
The standard UNIX-style ordering of command-line arguments places
optional flags before other positional arguments. All of restic's
commands support this ordering, but some of the usage strings showed the
flags after the positional arguments (which restic also parses just
fine). This change updates the doc strings to reflect the standard
ordering.

Because the `restic help` command comes directly from Cobra, there does
not appear to be a way to update the argument ordering in its usage
string, so it maintains the non-standard ordering (positional arguments
before optional flags).
 2020-08-28 02:16:22 +00:00
rawtaz b43ab67a22 doc: Add missing environment variables 2020-08-24 00:49:34 +02:00
NoNE da6a34e044 doc: Add more explanation for --one-file-system option 2020-08-21 19:19:13 +02:00
aawsome 0fed6a8dfc
Use "pack file" instead of "data file" (#2885) 
- changed variable names, especially changed DataFile into PackFile
- changed in some comments
- always use "pack file" in docu
 2020-08-16 11:16:38 +02:00
rawtaz 643bbbe156
doc: Correct wording for repository (#2884) 
Replaces "backend" with "repository" to match restic output.
 2020-08-11 22:30:17 +02:00
MichaelEischer 84b6f1ec53
Merge pull request #2874 from MichaelEischer/fix-verbose 
Adjust description of --verbose=n parameter
 2020-08-04 23:21:05 +02:00
Michael Eischer e38d415173 Adjust description of --verbose=n parameter 2020-08-04 23:07:53 +02:00
josephrocca bd36731119
`--verbose 2` to `--verbose=2` 
`--verbose 2` seems to be incorrect here (gives an error/warning that "the `2` directory does not exist, skipping")
 2020-08-04 08:39:43 +10:00
Michael Eischer 7c23381a2b Drop support for Go version 1.11 2020-07-24 18:52:39 +02:00
Peter Schultz 758b44b9c0 gs: support authentication with access token 
In the Google Cloud Storage backend, support specifying access tokens
directly, as an alternative to a credentials file. This is useful when
restic is used non-interactively by some other program that is already
authenticated and eliminates the need to store long lived credentials.

The access token is specified in the GOOGLE_ACCESS_TOKEN environment
variable and takes precedence over GOOGLE_APPLICATION_CREDENTIALS.
 2020-07-22 16:23:03 +02:00
David Sommer 5729d967f5 backup: Return exit status code 3 when failing to read source data 
The backup command used to return a zero exit code as long as a snapshot
could be created successfully, even if some of the source files could not
be read (in which case the snapshot would contain the rest of the files).

This made it hard for automation/scripts to detect failures/incomplete
backups by looking at the exit code. Restic now returns the following exit
codes for the backup command:

 - 0 when the command was successful
 - 1 when there was a fatal error (no snapshot created)
 - 3 when some source data could not be read (incomplete snapshot created)
 2020-07-20 22:19:01 +02:00
darkdragon-001 c6b74962df Update 040_backup.rst 
Changes proposed in #2763:

- Adding `RESTIC_CACHE_DIR` environment variables (introduced in #2425 for Unix and #2607 for Mac, Win).
- Adding used system-wide environment variables with links to the corresponding section.
 2020-07-12 00:31:56 +02:00
Tony Scelfo 6a607d6ded
--hostname flag is deprecated 
Update documentation to follow the deprecation warning "Flag --hostname has been deprecated, use --host" that is given on the latest build(s).
 2020-06-29 12:53:57 -06:00
@lessfoobar df946fd9f8
Update 080_examples.rst 2020-06-26 00:01:30 +02:00
Andreas Olsson 0fcef2ec23
Use https:// for linking CACHEDIR.TAG specs 
That site might not have supported https:// when those links were
originally added. It does now.

Also dropping the _spec.html_ ending of the url, there being a `<link
rel="canonical" ...>` tag suggesting that that no longer being the
preferred address.
 2020-06-21 19:36:26 +02:00
greatroar 55c3a90a0d Clarify rclone-over-SSH docs 
Also added a link to S. Ruderich's blog post explaining append-only
repos using rclone and SSH.
 2020-06-17 15:22:20 +02:00
Martin Michlmayr 5cc1760fdf
Fix typos 2020-05-16 14:05:26 +08:00
azak-azkaran c5100d5632
Update 030_preparing_a_new_repo.rst 
fixed markdown for wasabi region link
 2020-04-23 09:24:19 +02:00
rawtaz 9dba7a2577
doc: Add note on tilde expansion in exclude files 
Explains to the reader that tilde expansion does not work in exclude files, and that they should instead use the $HOME variable.
 2020-04-18 12:47:47 +02:00
Michael Eischer 6bee62e346 Update doc excerpts for `--help` 
This adds some previously missing changes and the new paramters names
from the previous commit.
 2020-04-03 19:49:06 +02:00
Michael Eischer f1b4d97945 doc: Warn about compatibility issues with CIFS and restic 
On Linux CIFS (SMB) seems to be incompatible with the async preemption
implementation of Go 1.14. CIFS seems not to restart syscalls (open,
read, chmod, readdir, ...) as expected by Go, which sets SA_RESTART for
its signal handler to have syscalls restarted automatically. This leads
to Go passing up lots of EINTR return codes to restic.

See https://github.com/restic/restic/issues/2659 for a detailed explanation.
 2020-03-26 21:52:37 +01:00
greatroar 18fee4806f Remove broken --allow-root from restic mount 2020-03-17 23:35:06 +01:00
rawtaz cec7d581f3
Merge pull request #2610 from restic/remove-vendor 
Remove vendored dependencies
 2020-03-01 20:22:45 +01:00
Alexander Neumann 0c03a80fc4
Merge pull request #2592 from greatroar/sftp-ipv6 
Support IPv6 in SFTP backend
 2020-03-01 19:38:44 +01:00
Alexander Neumann c0373cd307 Remove -mod=vendor from all documentation and code 2020-03-01 19:32:35 +01:00
Alexander Neumann 99fd80a585 Remove all workarounds for Go < 1.11 2020-02-26 20:35:13 +01:00
greatroar 6ac6bca7a1 Support IPv6 in SFTP backend 
The previous code was doing its own hostname:port splitting, which
caused IPv6 addresses to be misinterpreted.
 2020-02-19 15:42:12 +01:00
rawtaz af20015725
Merge pull request #2287 from benchti/patch-1 
doc: Correct parameter order in dump example
 2020-02-13 01:54:10 +01:00
rawtaz 680a14afa1
Merge pull request #2530 from restic/fix-sftp-mkdirall 
sftp: Use MkdirAll provided by the client
 2020-02-13 01:12:59 +01:00
Jakob Unterwurzacher 5ae7e6f945 docs: switch to gopher favicon 
The favicon on restic.readthedocs.io still contained the old
superman-style logo.

This changes it to the 32x32 gopher icon also used on https://forum.restic.net/ ,
just converted to .ico using Gimp.

Tested by building the documentation and opening index.html in Chrome.
The new favicon looks fine.
 2020-02-13 00:09:37 +01:00
Florian Feldmann ef5efc6a82
corrected option s3.storage-class 
Took me some time to figure it out
 2020-02-06 22:53:47 +01:00
Alexander Neumann 63c67be908 Add hint abouth absolute sftp paths for Synology NAS 2020-01-06 21:37:57 +01:00
streambinder 9b5d069ade doc: 030: sfpt: hint for domain-confined users 2019-12-19 13:15:37 +01:00
rawtaz fccb579471
doc: Improve check documentation 
Make it clearer what the difference is between regular check and check with --read-data.
 2019-12-10 21:15:59 +01:00
Alexander Neumann 6c700f95b5 Merge pull request #2358 from filippobottega/master 2019-11-29 20:27:30 +01:00
Filippo Bottega 95d070c147 FAQ: Add hint for antivirus setup 
Add a tip to configure antivirus to exclude restic process.
 2019-11-29 20:26:20 +01:00
rawtaz 476e2e8762
Merge pull request #2354 from HugoReeves/master 
Doc Addition: Wasabi repo setup instructions
 2019-11-25 13:56:49 +01:00
Alexander Neumann 14c90d9e85 Improve example for forget --keep-daily 
Following up on https://github.com/restic/restic/pull/2406
 2019-11-22 20:44:50 +01:00
Alexander Neumann fb95426f64 Rename environment variable to AWS_DEFAULT_REGION 
This seems to be the correct name, at least the AWS cli uses it:
https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html
 2019-11-22 15:24:42 +01:00
Alexander Neumann 4cadc89ad3 Add documentation and changelog 2019-11-22 15:16:59 +01:00
Ryan Lue c1ddc0c18b Clarify docs for Backblaze B2 support 2019-11-22 18:07:29 +08:00
rawtaz b6f01ffbe6
Merge pull request #2394 from bugvillage/doc-backup-passwd 
add description env var RESTIC_PASSWORD_COMMAND
 2019-11-20 23:26:55 +01:00
rawtaz 41fe9318b1
Merge pull request #2425 from thiell/restic_cache_dir_env 
Add support for $RESTIC_CACHE_DIR
 2019-11-20 21:18:57 +01:00
rawtaz 6a89c0f0ef
Merge pull request #2476 from rawtaz/update-doc 
doc: Simplify wording for check's --read-data-subset parameter.
 2019-11-19 03:38:37 +01:00
rawtaz b87230b93d
Merge pull request #2456 from jenting/installation-opensuse 
Docs: add installation guide for openSUSE
 2019-11-19 02:15:19 +01:00
JenTing Hsiao 6f2b8d622a
Add installation guide for openSUSE 
Signed-off-by: JenTing Hsiao <jenting.hsiao@suse.com>
 2019-11-19 09:08:18 +08:00
Leo R. Lundgren 90440212f2 doc: Simplify wording for check's --read-data-subset parameter. 2019-11-19 00:43:41 +01:00
rawtaz 3a5c9aadad
Merge pull request #2444 from chanibal/patch-2 
Docs: fixed escaping of argument in documentation
 2019-11-18 21:45:00 +01:00
rawtaz a78142c1bb
Merge pull request #2450 from hallamjeff/patch-1 
Update 080_examples.rst
 2019-11-18 21:43:19 +01:00
rawtaz 07045c7e23
Merge pull request #2442 from lbausch/patch-1 
Docs: Highlight option correctly
 2019-11-18 21:39:07 +01:00
Jeff Hallam 67d99b8cfb
Update 080_examples.rst 
added backticks around the -o and --option text.
 2019-11-18 16:36:20 -04:00
rawtaz e86d9307d0
Merge pull request #2472 from rawtaz/update-backup-doc 
doc: Improve exclude/include patterns info
 2019-11-18 21:04:18 +01:00
Leo R. Lundgren 37770b1d82 doc: Improve include patterns info 
Clarifies and adds information on how to specify include patterns.
 2019-11-18 02:23:01 +01:00
rawtaz 02fea4f76a doc: Improve exclude patterns info 
Improves grammar, clarifies and adds information on how to specify exclude patterns.
 2019-11-18 01:59:50 +01:00
8176135 3acc7af310
Small fix to the forget --tag command 
As described in #2460
 2019-11-03 11:48:56 +13:00
Jeff Hallam 5c4653f427
Update 080_examples.rst 
Added an explanation of how to specify the AWS S3 storage classes and what the default value is.
 2019-10-21 19:24:50 -03:00
Krzysztof Bociurko f7317a9287
Docs: fixed escaping of argument in documentation 
Issue was visible as `foo`` in https://restic.readthedocs.io/en/latest/040_backup.html
 2019-10-16 19:03:40 +02:00
lbausch 30db8057e4
Docs: Highlight option correctly 2019-10-13 21:19:03 +02:00
Stephane Thiell 0e897ef7b8 Add support for $RESTIC_CACHE_DIR 
Add support for restic-specific $RESTIC_CACHE_DIR environment variable
to override the cache directory like --cache-dir would have.
 2019-09-26 15:59:56 -07:00
bugvillage b3e727f40d fixing typo/align around RESTIC_PASSWORD_COMMAND 2019-09-07 15:30:23 +02:00
bugvillage 17feccd998 add description env var RESTIC_PASSWORD_COMMAND 
The environment variable RESTIC_PASSWORD_COMMAND works but has
not been documented yet. e.g. it could contain a command that
would fetch the password from a local user keyring

enhances: https://github.com/restic/restic/pull/2094
 2019-09-07 14:00:53 +02:00
Hugo Reeves 3ca306d69a
Doc Addition: Added Wasabi repo setup 2019-07-26 22:00:48 +12:00
Michael M. Chang e9af012229
Debian has updated restic 
Debian now has restic 0.9.4+ds-2+b1 in stable (buster)
 2019-07-10 11:53:17 -04:00
Ben 5d272e5c08
Dump : parameter order in sample 
Usage:
  restic dump [flags] snapshotID file
 2019-05-28 18:20:52 +02:00
Alexander Neumann c029881379 Update manpages and auto-completion 2019-04-23 13:19:39 +02:00
Martin Michlmayr 0561155963 Split paragraph from list in restic stats --help 
The help text for `restic stats` lists a number of modes in a list.
Make sure the "more info" text is a separate paragraph rather than
being part of the list.
 2019-04-23 10:36:33 +07:00
Martin Michlmayr f11789c437 Add missing opening parenthesis 2019-04-23 10:36:26 +07:00
Alexander Neumann 5979414bcd Merge pull request #2124 from Kidswiss/tar 
Ability to dump folders to tar via stdout
 2019-04-22 20:58:59 +02:00
Simon Beck cc8b690b52 Restore whole folder to sdtout as tar 
With this change it is possible to dump a folder to stdout as a tar. The

It can be used just like the normal dump command:

`./restic dump fa97e6e1 "/data/test/" > test.tar`

Where `/data/test/` is a a folder instead of a file.
 2019-04-22 20:44:33 +02:00
Jan Niklas Richter 9a26be4e5b Add documentation for --group-by flag for snapshots command 2019-04-22 14:57:53 +02:00
Alexander Neumann 2b09a10234 Merge pull request #2218 from kcthrn/patch-1 
Fix minor error in doc for forgetting snapshots
 2019-04-13 14:55:40 +02:00
Alexander Neumann 4d77c0c21c Merge pull request #2228 from cstegm/patch-1 
Update 030_preparing_a_new_repo.rst
 2019-04-13 14:20:01 +02:00
Jack Henschel ecd7ee85e8 Mention Cache Directoy Tagging Standard in man page and help text 
This patch makes it more explicit what is meant by the CACHEDIR.TAG file.
It not only has to have this particular name, but also a specific content
(described at http://bford.info/cachedir/spec.html), which is not immediately
obvious to the user.
 2019-04-02 15:53:07 +02:00
Alexander Neumann 2022355800 doc: Fix versions in self-update example 2019-03-30 09:44:59 +01:00
cstegm fe886a6439
Update 030_preparing_a_new_repo.rst 
Helps users having this issue: https://github.com/restic/restic/issues/2216
 2019-03-29 18:24:17 +01:00
kcthrn 2970e38d92
Fix minor error in doc for forgetting snapshots 2019-03-24 17:59:19 -04:00
Alexander Neumann 95434cff16 Merge pull request 2156 from kayrus/swift-app-cred 
Swift: introduce application credential auth support
 2019-03-16 12:17:17 +01:00
Heiko Bornholdt db8f5864fc Add --ignore-inode option to backup cmd 
revised version of https://github.com/restic/restic/pull/2047
 2019-03-10 21:24:29 +01:00
Alexander Neumann 7519c73987 Clarify documentation on --exclude-if-present 2019-02-22 15:22:29 +01:00
Martin Michlmayr a2f30cde4c
Fix typos 2019-02-17 15:31:07 +00:00
kayrus 6ebcfe7c18 Swift: introduce application credential auth support 2019-02-14 14:19:05 +01:00
Alexander Neumann 0022926eba Merge pull request 2167 from moritzdietz/master 
Update dead link in docs
 2019-02-11 21:10:44 +01:00
Moritz Dietz c125fb763d
Update dead link 2019-02-11 20:18:43 +01:00
Alexander Neumann aa7043151a Merge pull request 2147 from kilburn/macports 
Document installation with MacPorts
 2019-02-10 12:50:52 +01:00
Alexander Neumann ebf22a35f4 Merge pull request 2154 from ciderpunx/patch-1 
Remove stray "in" from b2 instructions
 2019-02-10 12:50:11 +01:00
Alexander Neumann 3f069ac404 Merge pull request 2153 from dmd/umount-message 
more accurate umount help message, for #815
 2019-02-10 12:43:48 +01:00
Alexander Neumann 56e5467096 Merge pull request 2032 from j6s/feature.case-insensitive-exclude 
Add options for case insensitive includes & excludes
 2019-02-10 12:40:33 +01:00
Alexander Neumann fed25714a4 Merge pull request 2139 from restic/fail-zero-bytes-stdin 
Return error when reading zero byte from stdin
 2019-02-10 12:34:05 +01:00
ciderpunx 186e10e0cb
Remove stray "in" from b2 instructions 2019-01-29 12:39:46 +00:00
Daniel M. Drucker 29a5bd5b30 more accurate umount help message, for #815 2019-01-28 16:53:35 -05:00
Marc Pujol 06a01bc016 Document installation with MacPorts 2019-01-21 08:13:53 +01:00
Alexander Neumann a439cdeb05 Update manpages and auto-completion 2019-01-06 21:40:32 +01:00
Alexander Neumann 4609b5c24d Merge pull request 2094 from juergenhoetzel/password-command 
Add support for reading password from external command
 2019-01-06 21:14:52 +01:00
Alexander Neumann 0dc3648416 Add documentation for `--password-command` 2019-01-06 20:41:38 +01:00
Alexander Neumann d71dba3788 Merge pull request 2130 from andreaso/docs-https-links 
Prefer https:// links in the documentation
 2019-01-06 20:24:42 +01:00
Alexander Neumann e482633943 Merge pull request 2137 from kevinawoo/patch-1 
doc: Add more clarity to B2 application key
 2019-01-06 20:24:00 +01:00
Alexander Neumann 900621051a Merge pull request 2120 from turnkey-commerce/fix-doc-typo 
Fix a few typos in the FAQ doc.
 2019-01-06 15:08:13 +01:00
Alexander Neumann 1f246c5309 Merge pull request 2090 from plumbeo/within-hours 
Increase the granularity of the "keep within" snapshot retention policy
 2019-01-06 15:04:55 +01:00
Alexander Neumann e40805b002 Merge pull request 2103 from cdhowie/master 
--one-file-system unsupported on Windows
 2019-01-06 14:59:46 +01:00
Alexander Neumann 6f69ae1b8d Add docs, changelog file 2019-01-06 14:52:20 +01:00
Kevin Woo d65bea1b2a
doc: Add more clarity to B2 application key 2019-01-05 20:05:11 -08:00
Andreas Olsson 3b68acf853
Prefer https:// links in the documentation 
All the changed urls are available by way of https://. Most of them
already redirect.
 2018-12-29 15:57:44 +01:00
James Culbertson 82a70643a2 Fix a few typos in the FAQ doc. 2018-12-18 08:47:52 -06:00
Andreas Olsson 7a6bfcd58c
Remove moot sudo usage from documentation 
That usage of sudo only applies to the echo command itself. It has no
effect on the permissions of the stdout redirect.
 2018-12-09 17:43:50 +01:00
Chris Howie 05222b7343 --one-file-system unsupported on Windows 2018-11-27 11:14:47 -05:00
plumbeo 3edc723bf0 Update 'restic forget --keep-within' documentation and add changelog entry 2018-11-26 14:27:48 +01:00
Alexander Neumann 2434ab2106 Merge pull request 2098 from cdhowie/key-hinting 
Add key hinting (#2097)
 2018-11-25 17:52:54 +01:00
Chris Howie 1688713400 Add key hinting (#2097) 2018-11-25 09:13:18 -05:00
Johannes Hertenstein 8a97bb8661 Add documentation for insensitive includes & excludes 2018-11-25 13:32:16 +01:00
Joe Groocock 09e9b74cbd Allow --files-from multiple times 
Fixes https://github.com/restic/restic/issues/2085
 2018-11-25 12:55:03 +01:00
Markus 6caa9d38ac
Update install instructions for Arch Linux 
restic has been added to the official community repositories in august 2018.
 2018-10-20 13:09:52 +00:00
Alexander Neumann 9484a14ab2 Update manpages and auto-completion 2018-10-13 13:48:30 +02:00
Alexander Neumann 484844aa1a Document the build and release processes 2018-10-13 13:48:03 +02:00
Alexander Neumann 4ed10239ad doc: Add developer information 2018-10-11 22:37:25 +02:00
Joda Stößer b7959c44d2
doc: cache: fix typo 2018-10-11 14:00:51 +02:00
Moritz Dietz b36345fd84 Add example to spot path expansion errros 2018-10-07 12:09:46 +02:00
Daniel Bretoi 966e5a5575 use latest instead of newest in forget language 2018-10-06 12:02:22 -07:00
Johannes Hertenstein 0916ff71bd Add defaults to command line help of --cache-dir 2018-10-04 19:50:05 +02:00
Alexander Neumann 0c0a8e3d2b docs: Explain recognizing modified files 2018-10-02 14:21:08 +02:00
Alexander Neumann 0882aca3a8 Add hint for FUSE on FreeBSD 2018-09-26 21:40:43 +02:00
Alexander Neumann 2f774acce3 Merge pull request #2006 from Calinou/doc-add-scoop-installation 
Add Scoop installation method to the documentation
 2018-09-25 13:23:28 +02:00
Hugo Locurcio 2bb1be4d4e
Add Scoop installation method to the documentation 2018-09-23 18:42:50 +02:00
Hugo Locurcio 40e0016403
Rename OS X to macOS in the documentation 
macOS is the official name since the release of macOS 10.12 (Sierra).
 2018-09-23 16:13:34 +02:00
Alexander Neumann 746182c526 Correct name for Apple's desktop OS 2018-09-05 20:41:37 +02:00
Alexander Neumann 08beb7d84c Add section about FreeBSD, move anchor 2018-09-05 20:40:28 +02:00
Till Maas e9cdcf131c Update installation instructions 
- sort sections for different third-party methods
- Mention that Fedora can now just be installed via dnf
- Fix some typos
 2018-09-04 14:39:40 +02:00
Alexander Neumann e9a764129f Update docs for Go 1.11 2018-08-31 22:00:47 +02:00
Moritz Dietz 99ae913414
Update B2 env variable information 
* Fixed the B2 environment variables as they had the same description
* Added the variables for the newly introduced Application Key support #1906
 2018-08-29 21:05:57 +02:00
Thomas Damgaard df78896e59 doc: Add list of environment variables 2018-08-28 22:18:47 +02:00
Quentin Bourgeois a563f87818
<docs/manual_rest: Fix broken link to restc Design page> 2018-08-26 01:46:38 +02:00
Alexander Neumann 31176d212b doc: Add explanation for "processed" vs "added" 2018-08-18 14:26:57 +02:00
Alexander Neumann 10b5cf8f32 Add self-update to the docs 2018-08-12 23:56:06 +02:00
Alexander Neumann c221d662d0 Update manpages and auto-completion 2018-08-06 21:28:59 +02:00
Marie-Helene Burle 9de51d04ec
minor-fixes_examples 
- update link to latest restic release to install restic for `restic` user
- correct typo in path to this app
 2018-08-05 02:15:17 -07:00
cuspat96 30fa305c07
Clarify B2 Application Keys once again 
This commit fixes documentation about Application Keys in Backblaze B2.
 2018-08-02 21:29:29 +02:00
Alexander Neumann 686f24b578 doc: Clarify B2 application keys 2018-08-02 21:14:05 +02:00
Alexander Neumann 3422c1ca83 Merge pull request #1729 from mholt/stats 
Implement `restic stats` command to get more info about a repository
 2018-07-31 23:24:36 +02:00
Matthew Holt f6b2731aa5 stats: Add manual doc, improve -h doc 
Also rename files-by-content to files-by-contents, once and for all
 2018-07-31 22:54:10 +02:00
Mike Lissner 2caf8edc55 Add warning of the performance of prune 
I went pretty loud with this, but I think the performance is bad enough
that it's really worth highlighting, especially since it locks the index
during the prune.
 2018-07-31 22:41:40 +02:00
Alexander Neumann 57873502f8 Add note about B2 application keys to the docs 2018-07-31 20:49:54 +02:00
Matthew Holt f7659bd8b0 stats: Initial implementation of stats command 2018-07-27 21:27:39 +02:00
Mike Lissner d3ad63a4ec
b2 bucket names need to be unique 
Adds a small warning indicating that b2 bucket names need to be unique. It's an easy mistake to make, and it's surprising to get the following error if you're not accustomed to the way B2 works:

    Fatal: create repository at b2:postgres failed: NewBucket: b2_create_bucket: 400: Bucket name is already in use
 2018-07-23 11:48:59 -07:00
Alexander Neumann 67535e00a8 Merge pull request #1889 from ProactiveServices/patch-3 
doc: Minor grammar, RST syntax fixes
 2018-07-18 21:22:10 +02:00
Adam Piggott 254239c2a9
doc: Minor grammar, RST syntax fixes 
Fix unescaped backslash
Fix wording of Windows installation
 2018-07-18 02:28:23 +01:00
Adam Piggott cce1a1f768
doc: Minor grammar fixes 2018-07-18 02:25:31 +01:00
Alexander Neumann 64d27eed86 doc: Improve dump to stdout 
Closes #1884
 2018-07-14 20:45:52 +02:00
Alexander Neumann 025ec9dff5 Allow excluding files with $ via --exclude-file 
Previously it wasn't possbile to exclude files with a literal dollar
sign (`$`) via exclude files, now users can write `$$` for that.
 2018-06-22 20:46:04 +02:00
Alexander Neumann ae72b438b0 doc: Fix typo 2018-06-18 22:19:01 +02:00
Alexander Neumann ddf2065ce2 doc: Split references out into smaller files 
Closes #1852
 2018-06-18 22:17:48 +02:00
Alexander Neumann 228a970540 doc: Add paragraph about finding path in file 2018-06-17 20:49:11 +02:00
Clemens Bergmann ff785924de
Clarify live status display 
When I backup one of my filesystems which has a lot of Hard Links (Backup directory of burp) the live status shows me 4.5 TB but it only takes up 1.2 TB of space in the repository. This is confusing because my repo is on S3 and I feared a huge Bill. This change should clarify this.
 2018-06-15 12:41:48 +02:00
Alex JOST cb8d2d3df5
doc: enhance FAQ about AV software on Windows 
As discussed in #1840, realtime protection of AV software can cause serious performance degradation on Windows OS.
 2018-06-14 19:39:04 +02:00
Alexander Neumann a884ce1566 Merge pull request #1841 from jernst/master 
Added documentation about what happens if you run out of space during a backup
 2018-06-14 19:13:31 +02:00
Giacomo Sanchietti 85eca1b5e9 Documentation: minor RST syntax fixes 
- Fix bad link syntax
- Fix compilation warning
 2018-06-14 15:01:49 +02:00
Johannes Ernst a1536f38fa Fixed typo and grammar per feedback on PR. 2018-06-13 00:24:42 +00:00
Johannes Ernst 888f52afd1 Added documentation about what happens if you run out of space 
during a backup, based on conversation on the forum:
https://forum.restic.net/t/limited-backup-destination-space/733/6
 2018-06-11 21:20:08 +00:00
Alexander Neumann 9a73869c27 Update docs for RHEL/CentOS 2018-06-09 23:41:40 +02:00
Matt Holt ee4202f7c3
doc: Clarify multiple forget policies get ORed 2018-05-23 17:28:02 -06:00
Alexander Neumann abd34ab76f Update manpages and auto-completion 2018-05-21 15:57:32 +02:00
Alexander Neumann e6f25c4811 Update docs, clarify --cacert 
Closes #1789
 2018-05-21 12:06:30 +02:00
Alexander Neumann 375868edcf Add documentation 2018-05-13 12:54:23 +02:00
Alexander Neumann 8943741a0b Fix code block 2018-05-08 20:36:58 +02:00
Alexander Neumann 6793300850 Raise minimum Go version to 1.9 
The golang.org/sys/crypto library uses math/bits, which was only
introduced in Go 1.9.
 2018-05-07 23:28:48 +02:00
Martin Michlmayr bb1a22d1e6 Fix typos in section on rclone 2018-04-30 18:32:10 +02:00
Alexander Neumann c3cc5d7cee Update docs 2018-04-28 22:08:11 +02:00
Ryan DeShone a144b81c4a
Update Autocompletion Generation Documentation 
The autocompletion command has been changed to generate. Update documentation to reflect this change.
 2018-04-12 11:50:26 -04:00
rawtaz 1e2f23d77a
Add "Including and Exluding Files" heading in docs 
Adds "Including and Exluding Files" heading in the backup section in the docs.

[ci skip]
 2018-04-11 21:14:26 +02:00
Ali Razeen 325957443e Add scripting section to docs 2018-04-04 10:43:20 -04:00
Alexander Neumann 3f48e0e0f4 Add extra options to rclone 
For details see https://github.com/restic/restic/pull/1657#issuecomment-377707486
 2018-04-01 10:34:30 +02:00
Alexander Neumann 360ff1806a doc: Fix instructions for rclone backend 2018-04-01 10:18:38 +02:00
Alexander Neumann 1beeb7d0dd doc/REST: Make documentation match reality 2018-04-01 10:18:38 +02:00
Alexander Neumann e978b36713 doc: Add hint how to debug rclone 2018-04-01 10:18:38 +02:00
Alexander Neumann 011217e4bf backend/rclone: Improve documentation and README 2018-04-01 10:18:38 +02:00
Alexander Neumann 4172fcd167 doc: Add rclone backend 2018-04-01 10:18:38 +02:00
Alexander Neumann 518bf4e5f6 doc: Correct verbatim text in the manual 2018-04-01 10:18:38 +02:00
Alexander Neumann 17312d3a98 backend/rest: Ensure base URL ends with slash 
This makes it easier for rclone.
 2018-04-01 10:18:38 +02:00
xulongwu4 432e167255
Add instructions for installation on Solus 2018-03-30 17:36:29 -04:00
Gennady Trafimenkov a64f24029b
Correct spelling mistakes 2018-03-25 00:42:33 +03:00
Alexander Neumann 84a22eac92 Merge pull request #1675 from oliver/doc-fixes 
Minor doc fixes/improvements
 2018-03-21 20:54:51 +01:00
Bowen Song 34671d7c9b Skip archiver.Scan before backup when --quiet is set 2018-03-20 20:44:10 +00:00
Alexander Neumann 4a524da736 FAQ: Add suggestion on how to solve sftp error 2018-03-18 21:39:11 +01:00
Oliver Gerlich e361cc3807 040_backup.rst: add note regarding paths in --files-from argument 2018-03-18 20:51:04 +01:00
Alexander Neumann 3cd8a7bc96 Fix small things left open by #1552 2018-03-18 19:54:12 +01:00
Alexander Neumann 8206f85d2e Merge pull request #1552 from lawrencejones/use-auto-auth 
Automatically load Google auth
 2018-03-18 19:53:30 +01:00
Oliver Gerlich 1bee3e01fa 040_backup.rst: fix typo 2018-03-18 17:06:21 +01:00
Oliver Gerlich 624a2d8305 040_backup.rst: quote wildcard characters 
This doesn't really matter for --exclude in most cases, but it avoids
spreading bad ideas.
 2018-03-18 17:05:53 +01:00
Leo R. Lundgren c161aba084 doc: Add more info about using pre-compiled builds. 2018-03-15 21:23:07 +01:00
Alexander Neumann dedf17f5e8 Merge pull request #1650 from copart/patch-1 
Added copr repositories for RHEL/Centos/Fedora
 2018-03-11 21:52:18 +01:00
Lawrence Jones 492baf991f
Update docs and add changelog entry: Google auth 
Add documentation around using default Google application credentials,
along with a changelog extra that describes the feature and the
potential impact on existing restic uses (read: none).
 2018-03-11 17:12:30 +00:00
Alexander Neumann 54c6837ec4 Merge pull request #1651 from qbit/obsd_inst 
doc: Add install instructions for OpenBSD
 2018-03-11 14:49:40 +01:00
Aaron Bieber 24ce08e122
doc: Add install instructions for OpenBSD 2018-03-05 06:31:57 -07:00
copart 864eaeab7c
Added copr repositories for RHEL/Centos/Fedora 2018-03-04 15:50:30 -05:00
Jasper Lievisse Adriaanse 96311d1a2b Add support for illumos/Solaris 
This does come without xattr/fuse support at this point.

NB: not hooking up the integration tests as restic won't compile without
    cgo with Go < 1.10.
 2018-03-04 20:11:29 +00:00
Alexander Neumann 68bf1509bd Update manpages and auto-completion 2018-02-26 21:32:16 +01:00
Igor Fedorenko 07d080830e Add --read-data-subset flag to check command 
Signed-off-by: Igor Fedorenko <igor@ifedorenko.com>
 2018-02-18 23:31:27 -05:00
Alexander Neumann 3c08f956a3 Update manpages and auto-completion 2018-02-17 20:27:28 +01:00
Alexander Neumann 4eb9df63cf Merge pull request #1616 from rawtaz/fix-backup-doc 
Restructure and complement exclude options doc
 2018-02-14 22:11:14 +01:00
rawtaz fbb08c14de
Note that multiple `--exclude-file` may be used. 2018-02-14 22:05:52 +01:00
Leo R. Lundgren 8b95b48bae Fix grammar and formatting. 2018-02-14 02:59:47 +01:00
Leo R. Lundgren 71a4ccea71 Document refusal to process empty forget policy. 2018-02-14 02:59:41 +01:00
Leo R. Lundgren 5a9c7c51e6 Fix --keep-* options list formatting. 2018-02-14 02:59:33 +01:00
rawtaz 5abd133e26
Restructure and complement exclude options doc 2018-02-14 02:03:04 +01:00
Alexander Neumann 54c0794cf3 Merge pull request #1603 from jfparis/master 
Add support for GOARM parameter when cross compiling
 2018-02-11 21:03:29 +01:00
Alexander Neumann e17f65b23a Update logo 2018-02-05 20:48:48 +01:00
Jean-François Paris e86fb5eedd Add support for GOARM parameter when cross compiling 
Go can cross compile to older ARM architectures (e.g. v5). In order to
do so one needs to use the GOARM parameter as documented in
https://github.com/golang/go/wiki/GoArm
 2018-02-04 14:15:12 +00:00
Philip Huppert 77a6054d64 Update AWS S3 tutorial, fixing #1593 2018-01-29 20:47:27 +01:00
Alexander Neumann c34db983d8 Read TLS client cert and key from the same file 2018-01-27 14:02:01 +01:00
Bryce Chidester e805b968b1 Support for TLS client certificate authentication 
This adds --tls-client-cert and --tls-client-key parameters and enables use
of that certificate/key pair when connecting to https servers.
 2018-01-27 13:18:22 +01:00
Alexander Neumann 0f4cbea27d Document the REST v2 protocol 2018-01-23 23:15:26 +01:00
Martin 39f1ba1897
Added hint where to place restic.exe on windows 
I've added a hint for pre-compiled binaries on windows where to place them for easier use in the shell or in scripts without the hassle for absolute paths.
 2018-01-19 12:24:09 +01:00
Dennis Stosberg 60a7a9d019 manual: document how to create a full backup without running restic as root 2018-01-08 19:59:15 +01:00
Julian Gehring 70250762f3
Fix code block formatting in FAQs 
Fixes the formatting of a code block in the FAQs and makes it render properly.
 2018-01-05 23:02:03 +00:00
Alexander Neumann 6ecd14d780 Update manpages and auto-completion 2017-12-27 22:31:03 +01:00
Andreas Metzler d780ec4bce
doc: Improvements for --exclude 
Describe exclude pattern handling, adding multiple examples.

Closes #396
 2017-12-24 15:39:18 +01:00
Alexander Neumann b80b68dcb3 doc: Correct setence 2017-12-22 17:59:52 +01:00
Daniel Aleksandersen 323376efa2
Doc: Specify `key passwd` usage 
Specify that `key passwd` is used to change a password.
 2017-12-19 04:53:31 +01:00
Alexander Neumann 06cb3f7058 Merge pull request #1469 from zertrin/patch-1 
Update usage help output in doc/manual_rest.rst
 2017-12-04 21:36:16 +01:00
zertrin 2253a73837
Update usage help output in doc/manual_rest.rst 
The usage help in the documentation was outdated relative to current version (0.8.0) with some commands outdated and some missing.
 2017-12-04 22:57:00 +08:00
Alexander Neumann eb9e2bc79a manual: Document `diff` command 2017-12-03 18:33:35 +01:00
Jani 81e6a9d0d0
Fix a typo 2017-12-03 10:33:46 +02:00
Alexander Neumann ffbc68aa2e Document access time handling 2017-11-28 21:36:20 +01:00
Alexander Neumann dc38265b54 Merge pull request #1436 from restic/remove-old-cache 
Remove old cache directories
 2017-11-27 21:37:05 +01:00
Alexander Neumann 7c5ce83044 Update manpages and auto-completion 2017-11-26 19:46:16 +01:00
Alexander Neumann abde9e2fba doc: Add --cacert to REST section 2017-11-26 10:09:54 +01:00
Alexander Neumann 8253fadc96 doc: Fix typo 2017-11-25 22:11:47 +01:00
Alexander Neumann 1ebf0e8de8 Merge pull request #1437 from restic/fix-1292 
s3: Document and remove default prefix
 2017-11-25 11:34:26 +01:00
Alexander Neumann 37ea764000 cache: Add more documentation 2017-11-25 11:28:59 +01:00
Alexander Neumann 0fdb9a6129 Merge pull request #1426 from pmkane/master 
fix the signal name for progress reports in the docs
 2017-11-24 21:58:11 +01:00
Alexander Neumann 431ab5aa6a manual: Add hint about old default prefix 2017-11-21 21:33:09 +01:00
Stephen e2005e02bb
use default brew formula 2017-11-18 08:02:41 -08:00
Patrick Kane fe08686558 fix the signal name for progress reports in the docs 2017-11-16 19:17:25 -08:00
Zlatko Čalušić 134f834c60 Use lowercase in messages from check/tag commands, too 2017-10-27 21:06:34 +02:00
Martin Michlmayr 2e2c8dc620 Remove Markdown syntax from documentation 
Convert a link from Markdown to RST syntax.  This link must
have been missed during the recent conversion.
 2017-10-24 14:40:33 +01:00
Alexander Neumann 99b6163e27 Add 'dump' to manual 2017-10-16 20:24:47 +02:00
Jan Niggemann d81eee26b3 doc: Add info on docker container 
fixes #664
 2017-10-07 16:03:08 +02:00
Alexander Neumann fb09884893 Merge pull request #1311 from felix9/dump-no-trees 
"dump" command no longer has a "trees" option
 2017-10-03 12:40:24 +02:00
Michael Pratt 5ab9e12b46 Clarify cache location documentation 
PR #1287 changed the default cache location on darwin and windows.
Update the changelog and manual to reflect the new behavior.

Since the cache hasn't been included in an official release yet, I've
just changed the main cache changelog entry.

Fixes #1309
 2017-10-03 11:44:09 +02:00
Jan Niggemann f5b550191c doc: Refactors the documentation 
This commit refactors the documentation according to my proposal in #1273
and the discussion I had with fd0 on IRC.

The bits from the manual that I could not immediately put into the new
structure are contained in manual_rest.rst Anything else is still there,
nothing has been deleted.

I changed the heading markup to follow the convention used in Python’s
Style Guide for documentation, this convention is explained in a comment
at the top of every file.

I also added a paragraph on installing restic on Debian.
 2017-10-03 11:21:53 +02:00
Felix Lee 6d897def1b also fix man page 2017-10-01 18:33:41 -07:00
Alexander Neumann fae3c4d437 faq: Add entry about Synology NAS' sftp path 2017-09-30 10:30:21 +02:00
Alexander Neumann 89c2ed2a1c manual: Document that sftp does not expand tilde 2017-09-30 10:24:28 +02:00
Alexander Neumann 23f1cb06d6 Fix FAQ 2017-09-30 10:21:56 +02:00
Pascal Bach 224ebdb8b9 Fix wrong quotes for command in installation. 2017-09-29 10:08:24 +02:00
Pascal Bach 97330ac621 Add instruction on how to install restic using Nix 2017-09-27 22:41:20 +02:00
Alexander Neumann 4de938d97a Update manpages and auto-completion 2017-09-26 13:16:08 +02:00
Michael Pratt fa0be82da8 gs: allow backend creation without storage.buckets.get 
If the service account used with restic does not have the
storage.buckets.get permission (in the "Storage Admin" role), Create
cannot use Get to determine if the bucket is accessible.

Rather than always trying to create the bucket on Get error, gracefully
fall back to assuming the bucket is accessible. If it is, restic init
will complete successfully. If it is not, it will fail on a later call.

Here is what init looks like now in different cases.

Service account without "Storage Admin":

Bucket exists and is accessible (this is the case that didn't work
before):

$ ./restic init -r gs:this-bucket-does-exist:/
enter password for new backend:
enter password again:
created restic backend c02e2edb67 at gs:this-bucket-does-exist:/

Please note that knowledge of your password is required to access
the repository. Losing your password means that your data is
irrecoverably lost.

Bucket exists but is not accessible:

$ ./restic init -r gs:this-bucket-does-exist:/
enter password for new backend:
enter password again:
create key in backend at gs:this-bucket-does-exist:/ failed:
service.Objects.Insert: googleapi: Error 403:
my-service-account@myproject.iam.gserviceaccount.com does not have
storage.objects.create access to object this-bucket-exists/keys/0fa714e695c8ecd58cb467cdeb04d36f3b710f883496a90f23cae0315daf0b93., forbidden

Bucket does not exist:

$ ./restic init -r gs:this-bucket-does-not-exist:/
create backend at gs:this-bucket-does-not-exist:/ failed:
service.Buckets.Insert: googleapi: Error 403:
my-service-account@myproject.iam.gserviceaccount.com does not have storage.buckets.create access to bucket this-bucket-does-not-exist., forbidden

Service account with "Storage Admin":

Bucket exists and is accessible: Same

Bucket exists but is not accessible: Same. Previously this would fail
when Create tried to create the bucket. Now it fails when trying to
create the keys.

Bucket does not exist:

$ ./restic init -r gs:this-bucket-does-not-exist:/
enter password for new backend:
enter password again:
created restic backend c3c48b481d at gs:this-bucket-does-not-exist:/

Please note that knowledge of your password is required to access
the repository. Losing your password means that your data is
irrecoverably lost.
 2017-09-25 22:25:51 -07:00