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

691 Commits

Author SHA1 Message Date
Michael Eischer 41b0f1d43a doc: fix link to amazon s3 section 2022-11-27 17:01:22 +01:00
Michael Eischer 6a793db9ca rewrite: fix link anchors in documentation 2022-11-27 16:38:10 +01:00
Michael Eischer 8ad231bcad bump version numbers in instructions to reproduce binaries 2022-11-27 13:18:44 +01:00
Michael Eischer 686b0b2a3e update the minimum required go version to 1.18 2022-11-27 13:18:43 +01:00
Michael Eischer 4b5234924b
Merge pull request #2875 from fgma/issue2699 
issue2699: restore symlinks on windows when run as admin user
 2022-11-12 20:06:45 +01:00
Leo R. Lundgren f175da2756 rewrite: Polish documentation 2022-11-12 19:55:22 +01:00
Leo R. Lundgren c15bedccc0 rewrite: Revert unrelated documentation change 2022-11-12 19:55:22 +01:00
Michael Eischer 11b8c3a158 rewrite: add documentation 2022-11-12 19:55:22 +01:00
fgma 8e5eb1090c issue2699: restore symlinks on windows when run as admin user 2022-10-29 21:19:33 +02:00
FelixBurkhard 575d26ec87
Clearify what Azure account name means 
When reading it first it was not clear to me the 'account name' meant the name of the
Azure Storage Account and not the Azure account itself.
 2022-10-29 00:27:43 +02:00
Michael Eischer 3e60d38a23 Remove misleading wildcard from negative exclude pattern example 
There is no need to use a special wildcard `**` to demonstrate negative
patterns. Actually, it is both slower than the simpler variant and seems
to confuse users.
 2022-10-21 20:48:45 +02:00
Michael Eischer 8b7c952f17
Merge pull request #3953 from keachi/typo 
Fix typo
 2022-10-07 22:18:32 +02:00
Rob Hoelz 03e9a26018 Update copy documentation to use --from-repo option 
Removing the last references to the deprecated --repo2 option
 2022-10-07 22:00:12 +02:00
tr 43cc01d63e
doc: Fix typo 2022-10-05 21:03:14 +02:00
Michael Eischer 2e606ca70b backup: rework read concurrency 2022-10-02 22:55:14 +02:00
Kyle Brennan 4a501d7118 backup: add option for file read concurrency 2022-10-02 22:51:45 +02:00
Leo R. Lundgren ebe9f2c969 rclone/sftp: Improve handling of ErrDot errors 
Restic now yields a more informative error message when exec.ErrDot occurs.
 2022-09-25 16:19:03 +02:00
rawtaz 20f1913ef7
doc: Clarify S3 recommendation for B2 slightly 
This gives slightly more background to the recommendation for using restic's S3 backend with Backblaze B2.
 2022-09-12 17:48:59 +02:00
Herbert Graeber 988b386e8b Add powershell completion 
- Add code for powersehll complition available in cobra
- Add documentation for powershell completion
- Add changelog for pr3925
 2022-09-11 00:44:12 +02:00
Michael Eischer 5d0649faaf Update help output in docs 2022-08-26 20:44:01 +02:00
MichaelEischer 0e1d082b12
Merge pull request #3886 from MichaelEischer/recommend-s3-over-b2 
doc: recommend usage of B2's S3 API
 2022-08-26 20:29:05 +02:00
Alexander Neumann d464543171 Update repo version table 2022-08-25 21:30:25 +02:00
Alexander Neumann c1a5da56e3 Update manpages and auto-completion 2022-08-25 19:55:00 +02:00
MichaelEischer b4ae05627f
Merge pull request #3876 from MichaelEischer/document-aws-session-token 
doc: document aws session token
 2022-08-24 22:20:26 +02:00
Leo R. Lundgren cb5a61c46e doc: Improve/clarify preparing and versions of repositories 2022-08-24 02:08:46 +02:00
Michael Eischer e0d6bf525c doc: fix typo 2022-08-21 19:12:19 +02:00
Michael Eischer 5d0523e2f1 Add note that larger packs increase disk wear 2022-08-21 19:12:19 +02:00
Michael Eischer c586a5e20f doc: recommend usage of B2's S3 API 2022-08-21 11:39:03 +02:00
Michael Eischer b6c86ababe doc: document aws session token 2022-08-19 20:41:15 +02:00
Michael Eischer 2758d76b77 copy: replace --repo2 with --from-repo 
`init` and `copy` use `--repo2` with two different meaning which has
proven to be confusing for users. `--from-repo` now consistently marks a
source repository from which data is read. `--repo` is now always the
target/destination repository.
 2022-08-19 18:33:26 +02:00
rawtaz 2cb2aa31cd
doc: Fix typo in compression section 2022-08-12 22:17:38 +02:00
Michael Eischer 40c8755b13 doc: Update more links to GCS documentation 2022-08-08 20:00:44 +02:00
rawtaz f673068dbb
doc: Update link to GCS documentation 
Updates the link to Google Cloud Storage documentation about creating a service account key.
 2022-08-08 12:51:43 +02:00
MichaelEischer 2930a102de
Merge pull request #3731 from metalsp0rk/feature/min-packsize-flag 
Feature: min packsize flag
 2022-08-07 14:54:45 +02:00
Michael Eischer b3cdee66a9 update documentation to reflect DEBUG_LOG for release builds 2022-08-05 23:49:39 +02:00
Michael Eischer 1b076cda97 rename option to --pack-size 2022-08-05 23:47:43 +02:00
Michael Eischer 8a44258b6f update restic help snippets in documentation 2022-08-05 23:47:43 +02:00
Michael Eischer 420ddc03c9 rework pack size parameter documentation 2022-08-05 23:47:43 +02:00
Kyle Brennan e43be84eb8 document minPackSize 2022-08-05 23:47:41 +02:00
Michael Eischer 5723c72eb1 Add environment variable RESTIC_COMPRESSION 2022-07-30 16:21:53 +02:00
Michael Eischer 5639c41b6a azure: Strip ? prefix from sas token 2022-07-16 23:55:18 +02:00
Roger Gammans 64a7ec5341 azure: add SAS authentication option 2022-07-16 23:55:18 +02:00
rawtaz f5c219f5a2
doc: Add note about using rclone for Google Drive 
It wasn't clear that Google Cloud Storage and Google Drive are two different services and that one should use the rclone backend for the latter. This commit adds a note with this information.
 2022-07-16 13:22:38 +02:00
MichaelEischer d71b29221b
Merge pull request #3822 from JsBergbau/doc-max-compression 
Added hint for --compression max in migration process
 2022-07-12 23:02:45 +02:00
Michael Eischer 71ff6b77f0 doc: Rework hint to repack with max compression 2022-07-12 21:24:40 +02:00
Michael Eischer 2aad6f24b5 doc: update sample help output 2022-07-12 20:49:01 +02:00
Michael Eischer ec4dfa3c66 Wording: replace further repo occurrences with repository 2022-07-12 20:48:01 +02:00
JsBergbau 8d3f04aefa
Added hint for --compression max in migration process 
Added hint for --compression max in migration process. Since this is a onetime process users should be aware of this and consider this step.
 2022-07-12 00:08:26 +02:00
Lorenz Bausch d6e3c7f28e
Wording: change repo to repository 2022-07-08 20:05:35 +02:00
mattxtaz 87d899c099 Fix minor typo in docs 2022-07-05 20:06:27 +01:00
Michael Eischer 3af9c2cc58 Document automatic CPU/IO-concurrency 2022-07-03 12:19:26 +02:00
Michael Eischer dbb5860dc9 Document connections and compression option 2022-07-03 11:19:24 +02:00
Alexander Neumann d2c5843c68
Merge pull request #3704 from MichaelEischer/compression-migrations 
Support migration to repository format with compression
 2022-05-29 15:52:21 +02:00
Arigbede Moses 2aa75d6272
Update 030_preparing_a_new_repo.rst 2022-05-18 22:03:59 +01:00
Michael Eischer 4faff0debe doc: Describe repository upgrade process 2022-05-09 22:31:30 +02:00
Michael Eischer 7559d2f105 Document repository version and minimum restic version 2022-05-09 22:31:30 +02:00
Henrik Bengtsson 9bb532672a DOCS: Incorrectly used SI units when IEC units were meant (fix #3669) 2022-05-02 21:21:39 -07:00
Emanuele Rocca 38c0531b52 doc: specify AWS Region via AWS_DEFAULT_REGION 
If no specific Region is mentioned in RESTIC_REPOSITORY, AWS defaults to
us-east-1. For this reason, users that follow the tutorial and create
their S3 bucket in any other region get the following error:

"Fatal: create repository at [...] client.BucketExists"

Explicitly specifying the AWS region name fixes the issue.
 2022-05-02 21:26:58 +02:00
Michael Eischer dbbeac7174 prune: Add unsafe option to recover from no free space 
The new option allows prune to operate with nearly no scratch space by only removing
no longer necessary pack files and first deleting the index before
rebuilding it. By first deleting the index it becomes safe to just
delete no longer necessary pack files. However, as a downside there's
now the risk that the repository becomes inaccessible if prune fails.

To recover from that problem a user might have to manually delete the
repository index and then run (a full) `rebuild-index` again.
 2022-04-30 19:21:07 +02:00
Daniel Gröber f31b4f29c1 Use config file modes to derive new dir/file modes 
Fixes #2351
 2022-04-30 15:59:51 +02:00
Alexander Neumann dc5adef255 Add documentation for --repository-version 2022-04-30 11:34:10 +02:00
Michael Eischer 0957b74887 Misc design.rst cleanups 2022-04-30 10:07:42 +02:00
Alexander Neumann 270ed00d1f doc: Add repository compression support documentation 
Co-authored-by: Michael Eischer <michael.eischer@fau.de>
 2022-04-30 10:07:42 +02:00
Alexander Neumann e4780d3956
Merge pull request #3718 from MichaelEischer/sftp-docs-fix 
doc: sftp with password actually works
 2022-04-23 20:27:27 +02:00
Michael Eischer 6f9e20a1bb doc: Describe repository read/write order 2022-04-23 15:21:02 +02:00
Michael Eischer f9219e8608 doc: sftp with password actually works 2022-04-23 11:57:36 +02:00
Leo R. Lundgren 8ac7519fd5 doc: Clarify and make grouping in forget more noticeable 2022-04-16 01:13:13 +02:00
Michael 9563e2f75c
doc: fix missing "init" in rest-server example 2022-04-12 18:21:53 +02:00
rawtaz de4e3117eb
doc: Link to CACHEDIR.TAG specification 2022-04-08 03:07:27 +02:00
MichaelEischer 500079d265
Merge pull request #3689 from brightdroid/patch-1 
added documentation for zsh autocompletion
 2022-04-03 21:49:47 +02:00
Jernej Debevc 6e5731bf2f
Fix a typo in the docs 2022-04-01 17:16:55 +02:00
Alexander Neumann 66d50b72e3 Require Go 1.15 or later 
The library github.com/golang-jwt/jwt/v4 requires the FillByte() method
of *big.Int, so we're raising the minimum Go version to 1.15.
 2022-03-30 21:11:17 +02:00
Christoph Roeder 7510bdc247
added documentation for zsh autocompletion 2022-03-30 10:45:52 +02:00
Alexander Neumann a53a4a23fd Update manpages and auto-completion 2022-03-26 20:09:59 +01:00
Leo R. Lundgren c7d637ec39 check: Adjust help and documentation for check --read-data-subset 2022-03-26 00:11:04 +01:00
Leo R. Lundgren cdf478c8f4 doc: More updates to forget documentation and security considerations 2022-03-23 23:12:19 +01:00
Luc Gommans 80969a6347 Update docs according to comments from MichaelEischer in PR #3656 2022-03-23 23:12:19 +01:00
Leo R. Lundgren 676d5d498c doc: Update forget security considerations and thread model 2022-03-23 23:12:19 +01:00
Luc Gommans 9c1d49e312 Document "forget" security considerations and add references 
Removing data based on a policy when the attacker had the opportunity to
add data to your repository comes with some considerations. This is
added to the 060_forget.rst documentation.

That document is also updated to reflect that restic now considers
the current system time while running "forget".

References to the security considerations section are added:
- In `restic forget --help`
- In the threat model (design.rst)
- In the (030) setup section where an append-only setup is referenced

A reference is also to be added to the `rest-server` readme's
append-only paragraph (see my fork).

This commit also resolves a typo (amount->number for countable noun),
changes a password length recommendation into the metric that
actually matters when creating passwords (entropy) since I was editing
these doc files anyway, and updates the outdated copyright year in
`conf.py`.

Some wording in 060_forget (line 21..22) was changed to clarify what
"forget" and "prune" do, to try and avoid the apparent misconception
that "forget" does not remove any data.
 2022-03-23 23:12:19 +01:00
Alexander Neumann 29a5778626 Improve wording 2022-03-20 13:46:16 +01:00
Michael Eischer 53656f019a filter: address review comments 2022-03-20 13:33:08 +01:00
Vincent Bernat 2ee07ded2b filter: ability to use negative patterns 
This is quite similar to gitignore. If a pattern is suffixed by an
exclamation mark and match a file that was previously matched by a
regular pattern, the match is cancelled. Notably, this can be used
with `--exclude-file` to cancel the exclusion of some files.

Like for gitignore, once a directory is excluded, it is not possible
to include files inside the directory. For example, a user wanting to
only keep `*.c` in some directory should not use:

    ~/work
    !~/work/*.c

But:

    ~/work/*
    !~/work/*.c

I didn't write documentation or changelog entry. I would like to get
feedback if this is the right approach for excluding/including files
at will for backups. I use something like this as an exclude file to
backup my home:

    $HOME/**/*
    !$HOME/Documents
    !$HOME/code
    !$HOME/.emacs.d
    !$HOME/games
    # [...]
    node_modules
    *~
    *.o
    *.lo
    *.pyc
    # [...]
    $HOME/code/linux/*
    !$HOME/code/linux/.git
    # [...]

There are some limitations for this change:

 - Patterns are not mixed accross methods: patterns from file are
   handled first and if a file is excluded with this method, it's not
   possible to reinclude it with `--exclude !something`.

 - Patterns starting with `!` are now interpreted as a negative
   pattern. I don't think anyone was relying on that.

 - The whole list of patterns is walked for each match. We may
   optimize later by exiting early if we know no pattern is starting
   with `!`.

Fix #233
 2022-03-20 13:33:08 +01:00
Daniel Gröber 49b67c8aaa doc: Fix block quote warning 2022-03-06 18:15:55 +01:00
MichaelEischer 4a2d5a146d
Merge pull request #3507 from ahmgithubahm/document-AWS_PROFILE-support 
Document AWS_PROFILE support
 2022-02-18 23:40:25 +01:00
Michael Eischer 1efc26899d Update docs for AWS_PROFILE and AWS_SHARED_CREDENTIALS_FILE 2022-02-18 23:31:10 +01:00
gum3ng dd30083c2b [#issue 3127] Add xattr support for Solaris 2022-02-13 14:24:37 +05:30
duritong a4786dda5a
Update doc/020_installation.rst 
Co-authored-by: greatroar <61184462+greatroar@users.noreply.github.com>
 2022-02-06 21:31:18 +01:00
mh 3f0184ba2a add a note about installation via epel 2022-02-05 22:18:33 +01:00
Leona 'leo' Gottfried 4e84e8ab3f
Update msys2 wiki url after move 
https://github.com/msys2/msys2/wiki/Porting was permanently moved and redirects to https://www.msys2.org/
I substituted the new location of the /wiki/Porting page in the docs
 2022-01-27 11:09:50 +01:00
Florian Kusche 6183d0be53 Update output of restic check 2022-01-16 12:34:20 +01:00
Florian Kusche b0c1d0f9cd Update documentation regarding unreferenced packs 
Also removes an unnecessary space at the end of the last line.
 2022-01-09 11:45:03 +01:00
mattxtaz 6ff32ee4d3 Add missing colon in prune stats output and change padding to 14 chars to align the fields 2022-01-06 21:15:15 +00:00
gum3ng 9589de16db [issue 3558]: Add a FAQ section for invalid Windows filenames 2022-01-02 22:24:00 +05:30
Kyle Brennan 19ec4d8f17
Document safe passwords. Fix #2238 2021-12-27 10:43:18 -08:00
Kyle Brennan 47ecd950b8
Enhance details about user application keys. Fix #2672 2021-12-27 10:43:15 -08:00
MichaelEischer 882d58abce
Merge pull request #3163 from palbr/patch-1 
Add PGP fingerprint to 020_installation.rst
 2021-11-19 23:58:50 +01:00
Peter Albrecht 8de4401bb5
Changed URL for key-file 
The keyfile provided by restic's own webserver (https://restic.net) should be
more stable than relying on public keyservers. So I changed the URL to the
GPG keyfile, as recommended by MichaelEischer.
 2021-11-19 15:47:59 +01:00
MichaelEischer aa214f99b4
Merge pull request #3565 from mathstuf/doc-missing-metadata 
doc: mention metadata that is not backed up currently
 2021-11-18 21:28:55 +01:00
Michael Eischer 583edc39b8 doc: reorder backup metadata exceptions 2021-11-18 21:17:38 +01:00
Andrew Sultana 15ab96ecd6
docs: Fix link to "help wanted" issues 2021-11-16 00:03:34 +00:00