Ryan Hitchman
77bf148460
backup: add --dry-run/-n flag to show what would happen.
...
This can be used to check how large a backup is or validate exclusions.
It does not actually write any data to the underlying backend. This is
implemented as a simple overlay backend that accepts writes without
forwarding them, passes through reads, and generally does the minimal
necessary to pretend that progress is actually happening.
Fixes #1542
Example usage:
$ restic -vv --dry-run . | grep add
new /changelog/unreleased/issue-1542, saved in 0.000s (350 B added)
modified /cmd/restic/cmd_backup.go, saved in 0.000s (16.543 KiB added)
modified /cmd/restic/global.go, saved in 0.000s (0 B added)
new /internal/backend/dry/dry_backend_test.go, saved in 0.000s (3.866 KiB added)
new /internal/backend/dry/dry_backend.go, saved in 0.000s (3.744 KiB added)
modified /internal/backend/test/tests.go, saved in 0.000s (0 B added)
modified /internal/repository/repository.go, saved in 0.000s (20.707 KiB added)
modified /internal/ui/backup.go, saved in 0.000s (9.110 KiB added)
modified /internal/ui/jsonstatus/status.go, saved in 0.001s (11.055 KiB added)
modified /restic, saved in 0.131s (25.542 MiB added)
Would add to the repo: 25.892 MiB
2021-08-04 21:19:29 +02:00
Alexander Neumann
94983a1f36
Update manpages and auto-completion
2021-08-03 11:45:36 +02:00
David le Blanc
326fefcd80
Allow --tag and --keep-tag to match untagged snapshots
2021-08-02 23:06:20 +02:00
Magnus Thor Torfason
74ebc650ab
forget: Add --keep-within-hourly (and friends)
...
Allow keeping hourly/daily/weekly/monthly/yearly snapshots for a given time period.
This adds the following flags/parameters to restic forget:
--keep-within-hourly duration
--keep-within-daily duration
--keep-within-weekly duration
--keep-within-monthly duration
--keep-within-yearly duration
Includes following changes:
- Add tests for --keep-within-hourly (and friends)
- Add documentation for --keep-within-hourly (and friends)
- Add changelog for --keep-within-hourly (and friends)
2021-07-24 16:14:43 +00:00
rawtaz
98a88b483d
doc: Correct position of --verbose in backup docs
2021-06-25 19:26:46 +02:00
Tin Lai
9cc1ecdd45
bump cobra and add completions for fish
...
Signed-off-by: Tin Lai <oscar@tinyiu.com>
2021-05-21 13:47:52 +10:00
Alexander Neumann
38ccddc84f
Merge pull request #3399 from oli-h/oli-h-patch-060_forget.rst
...
Sudden find: fix within first "forget" example
2021-05-17 11:39:36 +02:00
Leo R. Lundgren
90d75651e6
backup: Improve wording for --one-file-system description
2021-05-15 00:06:27 +02:00
oli-h
23f9cb838d
Sudden find: fix within first "forget" example
...
I think this was a typo or copy/paste problem when created the doc.
Feel free to merge. Cheers
2021-05-10 08:55:42 +02:00
adrian5
a0f1c74000
doc: Add direct link to GitHub issue
2021-05-08 21:13:11 +00:00
Alexander Neumann
be6fc02c04
Merge pull request #3376 from restic/rawtaz-doc-exclude
...
doc: Polish exclude file documentation
2021-04-27 19:25:00 +02:00
Alexander Neumann
3ce5544796
Merge pull request #3321 from restic/doc-files-from
...
doc: Improve docs for --files-from et al
2021-04-27 19:15:31 +02:00
rawtaz
556caa326f
doc: Polish exclude file documentation
2021-04-25 20:36:11 +02:00
Craig Younkins
32a84ab3e4
doc: default for --max-unused
2021-04-22 21:12:37 -04:00
Dave Gallant
4aaf10c356
doc: Fix grammar in design.rst
2021-04-14 17:25:53 -04:00
Alexander Neumann
b922fc851b
Merge pull request #3356 from restic/rawtaz-doc-dollar-sign
...
doc: Clarify dollar sign expansion in exclude files
2021-04-09 12:30:54 +02:00
Jan Niggemann
9a1f685179
doc: Add note about bash completion path
2021-04-08 23:53:38 +02:00
rawtaz
b5e40b370c
doc: Clarify dollar sign expansion in exclude files
2021-04-08 23:46:53 +02:00
Leo R. Lundgren
5861bb031c
doc: Improve docs for --files-from et al
2021-04-07 18:31:46 +02:00
greatroar
ecbe7f3a99
Backup docs: on Windows, the filesize must match for "unchanged"
2021-04-04 17:01:48 +02:00
Craig Younkins
aa0a7b78a8
doc: prune --max-unused unlimited will still repack metadata
...
Adding minor clarification to documentation of `prune --max-unused unlimited` to indicate metadata will still be repacked. The referenced PR indicates `max-repack-size` CAN limit metadata repacking.
Ref: https://forum.restic.net/t/max-unused-unlimited-still-repacks/3661
Ref: https://github.com/restic/restic/pull/3228
2021-03-21 13:19:09 -04:00
Wouter Horlings
9ccdba9df6
Add repositoryFile2 option
...
The `init` and `copy` commands can now use `--repository-file2` flag and
the `$RESTIC_REPOSITORY_FILE2` environment variable.
This also fixes the conflict with the `--repository-file` and `--repo2`
flag.
Tests are added for the initSecondaryGlobalOpts function.
This adds a NOK function to the test helper functions. This NOK tests if
err is not nil, and otherwise fail the test.
With the NOK function a couple of sad paths are tested in the
initSecondaryGlobalOpts function.
In total the tests checks wether the following are passed correct:
- Password
- PasswordFile
- Repo
- RepositoryFile
The following situation must return an error to pass the test:
- no Repo or RepositoryFile defined
- Repo and RepositoryFile defined both
2021-03-08 22:41:13 +01:00
rawtaz
f000f41c91
doc: Clarify setcap applying only to current binary
2021-03-08 19:21:06 +01:00
Alexander Neumann
4e99a3d650
Update manpages and auto-completion
2021-02-14 11:44:20 +01:00
MichaelEischer
0ce05d5725
Merge pull request #3236 from Wouter0100/patch-1
...
doc: Note only path-style URL support for S3
2021-01-31 18:44:58 +01:00
Michael Eischer
0aed8d47d7
docs: Fix typo in S3 URL support
2021-01-31 18:33:15 +01:00
Wouter van Os
8442c43209
doc: Update wording for S3 path-only requirement
2021-01-31 15:10:03 +01:00
greatroar
6bd8a2faaa
backup: Add --ignore-ctime option and document change detection
2021-01-28 23:42:10 +01:00
Matthew Vance
58c7f4694d
Update threat model
2021-01-28 14:20:42 +01:00
Wouter van Os
b5972f184c
doc: Note only path-style URL support for S3
...
This adds a node to mention that currently only path-style URL's are supported for S3, as per code at:
- aa0faa8c7d/internal/backend/s3/config.go (L42-L45)
- aa0faa8c7d/internal/backend/s3/config.go (L48-L62)
2021-01-23 16:54:08 +01:00
Michael Eischer
25f4acdaa8
Add changelog entry
2020-12-29 16:32:18 +01:00
Michael Eischer
05a987b07c
Support values less than 1 for RESTIC_PROGRESS_FPS
...
For example set the variable to 0.016666 to print the progress once per
minute.
2020-12-29 16:32:18 +01:00
Michael Eischer
684600cf42
ui: update status for the backup command on non-interactive terminals
...
Allow the backup command to print status on non-interactive terminals.
The output is disabled by setting a MinUpdatePause == 0.
2020-12-29 16:03:43 +01:00
Michael Eischer
c2ef049f1b
ui/progress: don't print progress on non-interactive terminals
...
This reverts to the old behavior of not printing progress updates on
non-interactive terminals. It was accidentally changed in #3058 .
2020-12-29 16:03:43 +01:00
Alexander Neumann
c661518df9
Merge pull request #2793 from greatroar/rclone-doc
...
Clarify rclone-over-SSH docs
2020-12-29 10:46:34 +01:00
DRON-666
da9053b184
Some gramma fixes in documentation
2020-12-19 01:16:15 +03:00
DRON-666
ef1aeb8724
dump: Update docs and changelog
2020-12-19 01:09:47 +03:00
Alexander Neumann
1cdd38d9e0
Merge pull request #3165 from restic/2747-doc-forget
...
doc: Clarify calendar boundaries for --keep-* options
2020-12-16 08:38:03 +01:00
Leo R. Lundgren
b3c0d2f45b
doc: Clarify calendar boundaries for --keep-* options
2020-12-15 12:43:06 +01:00
Peter Albrecht
cd25e36811
Add PGP fingerprint to 020_installation.rst
...
I like the idea of verifying the integrity of applications, I download from the internet. So I was very happy to see that restic does provide SHA256-checksums which are signed with the maintainers PGP key.
The only thing I miss: I could not find a direct way to download the used PGP key and verify the keys fingerprint.
Doing some searches, I found:
* https://github.com/restic/rest-server/issues/121
* https://restic.net/blog/2015-09-16/verifying-code-archive-integrity/
To help other restic users, I think you should add information about your PGP key/fingerprint to this installation doc, too. To save you some precious time, I created a draft, how this doc might be expanded, in this pull-request. You are free to accept it or change the text to your liking.
I copied the key/fingerprint text from: ``restic/restic/master/doc/090_participating.rst``
Thank you for your work in restic!
2020-12-13 17:00:00 +01:00
Michael Eischer
1d69341e88
swift: Add support for id based keystone v3 auth parameters
...
This adds support for the following environment variables, which were
previously missing:
OS_USER_ID User ID for keystone v3 authentication
OS_USER_DOMAIN_ID User domain ID for keystone v3 authentication
OS_PROJECT_DOMAIN_ID Project domain ID for keystone v3 authentication
OS_TRUST_ID Trust ID for keystone v3 authentication
2020-12-11 19:22:34 +01:00
Leo R. Lundgren
61460dee52
doc: Fix misc missing/incorrect text in manual
2020-11-29 18:59:24 +01:00
MichaelEischer
52b98f7f95
Merge pull request #3017 from greatroar/files-from0
...
Add backup options --files-from-verbatim and --files-from-raw
2020-11-29 18:15:21 +01:00
Leo R. Lundgren
f70b10d0ee
doc: Emphasize double transfer and duplication in copy command
2020-11-28 19:49:34 +01:00
greatroar
55bf76ba0c
backup: Add --files-from-{verbatim,raw} options
2020-11-28 18:22:31 +01:00
Johan Bové
c23b1a4cba
Update 04_backup.rst
...
Fixed typo - _files_ are included from _folders_, not other _files_.
2020-11-20 07:52:23 +01:00
rawtaz
1b6e8c888f
Merge pull request #3102 from tofran/remove-rclone-drive-use-tras-default-param
...
Remove `--drive-use-trash=false` from rclone param
2020-11-17 11:21:20 +01:00
fgma
8f9cea8cc0
Check data subset: check random percentage subset
2020-11-15 18:13:50 +01:00
Quentin Lemaire
e74110a833
docs: Write new entry to changelog/unreleased
2020-11-14 15:48:56 +00:00
tofran
94a154c7ca
Remove --drive-use-trash=false
from rclone param
...
Google drive trash retention policy changed making this
no longer a good default
a go
Issue #3095
2020-11-13 22:58:48 +00:00
Alexander Neumann
3e0456d88b
Highlight that s3.list-objects-v1 is a temporary
2020-11-11 20:11:35 +01:00
Nick Douma
f013662e3f
Remove separate section on Ceph, and move s3.list-objects-v1 note to S3 section
2020-11-11 15:11:14 +01:00
Nick Douma
354b7e89cc
Document the extended s3.list-objects-v1 flag in a new Ceph section
2020-11-11 12:32:46 +01:00
Alexander Weiss
fd33030556
Use in-memory index to rebuild index in prune
2020-11-06 20:23:30 +01:00
Nick Craig-Wood
86b5d8ffaa
s3: add bucket-lookup parameter to select path or dns style bucket lookup
...
This is to enable restic working with Alibaba cloud
Fixes #2528
2020-11-05 12:20:10 +01:00
Alexander Neumann
5144141321
Merge pull request #2718 from aawsome/new-cleanup-command
...
Reimplementation of prune
2020-11-05 10:12:19 +01:00
Alexander Neumann
c5300a2c56
Update manpages and auto-completion
2020-11-05 09:41:35 +01:00
Alexander Neumann
c1a3de4a6e
Refactor max-unused calculation, add unlimited
option
...
Add a callback to the PruneOptions struct which calculates the number of
bytes allowed to be unused after prune is done. This way, the logic is
closer to the option parsing code.
Also, add an explicit option `unlimited` for the use case when storage
does not matter but bandwidth and time do. Internally, this sets the
maximum number of unused bytes to MaxUint64.
Rework the documentation slightly so that no more "packs" are
mentioned and it talks about "files" instead.
Make it clear in the documentation that the percentage given to
`--max-unused` is relative to the whole repository size after pruning is
done. If specified, it must be below 100%, otherwise the repository
would contain 100% of unused data, which is pointless.
I had a hard time coming up with the correct formula to calculate the
maximum number of unused bytes based on the number of used bytes. For a
fraction `p` (0 ≤ p < 1), a repo with `u` bytes used, and the number of
unused bytes `x` the following holds:
x ≤ p * (u+x)
⇔ x ≤ p*u + p*x
⇔ x - p*x ≤ p*u
⇔ x * (1-p) ≤ p*u
⇔ x ≤ p/(1-p) * u
2020-11-03 16:42:21 +01:00
Alexander Weiss
7f9a0a5907
Reimplementation of prune
2020-11-03 16:42:21 +01:00
rawtaz
e8b4d8d8bc
Merge pull request #2998 from greatroar/env-docs
...
Systematize documentation of environment variables
2020-10-24 22:49:31 +02:00
MichaelEischer
31b8d7a639
Merge pull request #2274 from fgma/master
...
Support for Volume Shadow Copy Service (VSS) on windows
2020-10-24 15:43:34 +02:00
fgma
5695f9ebd2
vss: Implement VSS support for Windows
...
The VSS support works for 32 and 64-bit windows, this includes a check that
the restic version matches the OS architecture as required by VSS. The backup
operation will fail the user has not sufficient permissions to use VSS.
Snapshotting volumes also covers mountpoints but skips UNC paths.
2020-10-24 11:35:57 +02:00
greatroar
8091151638
doc: Update restic mount availability and requirements
...
NetBSD doesn't support restic mount either, so it's easier to list the
positive cases. Also noted that FUSE for macOS is required on the Mac.
2020-10-22 09:57:30 +02:00
greatroar
ae179ee63e
Systematize documentation of environment variables
...
Cache locations were documented inconsistently in three places.
The backup docs mentioned PATH being used to find fusermount, which is
never run by restic backup. It now mentions ssh and rclone, which are
used by backends.
The notion of a "system-wide" environment variable makes no sense.
TMPDIR is now mentioned because it allows for optimization and may
have security implications.
2020-10-22 09:57:30 +02:00
Leo R. Lundgren
f500b0d90e
doc: Add restic install instructions for Alpine Linux
2020-10-11 18:31:07 +02:00
Alexander Neumann
2f3eeff2e7
Merge pull request #2964 from MichaelEischer/fix-repro-instructions
...
Fix instructions to reproduce the release binaries
2020-10-09 21:28:24 +02:00
Lorenz Bausch
af4100e07d
Replace repo/repos with repository/repositories in --no-lock help text
2020-10-06 22:49:48 +02:00
Michael Eischer
187518a8a3
docs: Properly reproduce zip archives for windows binaries
2020-10-05 18:24:46 +02:00
Michael Eischer
a232c833dc
docs: Update binary reproduction instructions and refer to older instructions
2020-10-05 18:24:46 +02:00
rawtaz
b9b82d878d
Add FAQ on whether restic can resume backups
...
This new FAQ entry explains that restic can resume interrupted backups.
2020-10-03 21:39:45 +02:00
Michael Eischer
7b50a65492
Update backup help output in documentation
2020-10-01 00:50:27 +02:00
Michael Eischer
c18b119a9b
Document new option --repository-file
2020-10-01 00:50:27 +02:00
Andreas Oberritter
97f7855de3
Add new option --repository-file (default: $RESTIC_REPOSITORY_FILE)
...
As an alternative to -r, this allows to read the repository URL
from a file in order to prevent certain types of information leaks,
especially for URLs containing credentials.
Fixes #1458 , fixes #2900 .
2020-10-01 00:50:26 +02:00
MichaelEischer
fd02407863
Merge pull request #2849 from classmarkets/gcs-access-token
...
gs: support authentication with access token
2020-09-30 17:42:56 +02:00
Alexander Neumann
c8a94eced7
Update manpages and auto-completion
2020-09-19 17:38:26 +02:00
Alexander Neumann
6ff0082c02
Merge pull request #2928 from MichaelEischer/init-copy-chunker
...
init: Add `--copy-chunker-parameters` option
2020-09-19 17:32:13 +02:00
Alexander Neumann
95c1d7d959
Merge pull request #2927 from restic/update-deps
...
Update dependencies
2020-09-19 17:29:35 +02:00
Michael Eischer
f003410402
init: Add --copy-chunker-params
option
...
This allows creating multiple repositories with identical chunker
parameters which is required for working deduplication when copying
snapshots between different repositories.
2020-09-19 16:53:05 +02:00
Leo R. Lundgren
311ad2d2d0
Improve wording for --password-file and related options
2020-09-19 15:47:32 +02:00
Leo R. Lundgren
ffe6dce7e7
Improve wording for --password-command and --password-command2 options
2020-09-19 14:23:25 +02:00
Alexander Neumann
3c44598bf6
Drop Go 1.12, require at least 1.13
2020-09-19 14:20:04 +02:00
yoshiera
ac4b8c98ac
Support excluding files by size
2020-09-19 19:52:09 +08:00
MichaelEischer
55071ee367
Merge pull request #2859 from buschjost/stats-filter-by-tag-and-path
...
Add filter by tag and path to stats command
2020-08-31 22:11:01 +02:00
Oliver Buschjost
d3fcfeba3a
Add filter by tag and path to stats command
2020-08-30 17:14:48 +02:00
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