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
Alexander Neumann
3a2539e0ac
doc: Update manpages
2017-09-24 23:13:04 +02:00
Alexander Neumann
9be24a1c9f
Add cache
...
This commits adds rudimentary support for a cache directory, enabled by
default. The cache directory is created if it does not exist. The cache
is used if there's anything in it, newly created snapshot and index
files are written to the cache automatically.
2017-09-24 21:54:53 +02:00
Michael Pratt
3b2106ed30
gs: document required permissions
...
In the manual, state which standard roles the service account must
have to work correctly, as well as the specific permissions required,
for creating even more specific custom roles.
2017-09-24 11:25:57 -07:00
Alexander Neumann
d41dce5ecb
Merge pull request #1272 from jniggemann/doc-faq-add-prio
...
doc: FAQ: Add info on IO and CPU prioritization
2017-09-23 20:08:17 +02:00
Jan Niggemann
52a3eafede
doc: FAQ: Add info on IO and CPU prioritization
2017-09-23 19:32:07 +02:00
Alexander Neumann
55dfc85159
manual: Add hint for RESTIC_PASSWORD_FILE
2017-09-23 19:16:07 +02:00
Alexander Neumann
a7a478a19e
doc: Correct FAQ
2017-09-23 19:15:21 +02:00
Alexander Neumann
2080afd9de
Merge pull request #1259 from jniggemann/doc-add-restic-check-advice
...
adds advice to run restic check regularly
2017-09-23 14:07:55 +02:00
Alexander Neumann
9aa136b982
Merge pull request #1260 from jniggemann/doc-add-info-on-special-items
...
Doc add info on special items
2017-09-23 14:07:20 +02:00
Dmitriy Morozov
efd65a1b65
Update manpage for forget
2017-09-22 16:35:58 -07:00
Jan Niggemann
3b904525d9
manual: Add info on special items (device files)
2017-09-22 22:58:26 +02:00
Jan Niggemann
1e31f5202f
manual: Add info on special items
...
Add info about handling of symlinks and bind-mounts.
Closes: #1014
2017-09-22 22:51:31 +02:00
Jan Niggemann
f12d41138a
Add advice to run check regularly
2017-09-22 22:27:10 +02:00
Jan Bader
727fb6eabe
Add note about rescan to hostname flag ( fixes #1221 )
2017-09-22 14:29:04 +02:00
Jan Niggemann
397fec0152
documents metadata handling, fixes #647
2017-09-19 15:49:54 +02:00
Antoine Beaupré
bcd1e45ba7
fix typo, add note about file permissions
2017-09-18 08:55:18 -04:00
Antoine Beaupré
7a0b4428e3
add explanation of restic automation
...
every time i look at restic, i block on this and figured it may be useful for others
2017-09-16 10:17:36 -04:00
Alexander Neumann
e2deeceb1b
Update manpage
2017-09-16 11:29:37 +02:00
Alexander Neumann
dce35fcb00
Merge pull request #1232 from prattmic/patch-1
...
doc: remove broken link
2017-09-13 14:18:46 +02:00
Alexander Neumann
c8c01a5cae
Merge pull request #1223 from mrzv/snapshots-compact
...
Add --compact option to snapshots
2017-09-13 14:02:31 +02:00
Michael Pratt
f7ece90129
doc: remove broken link
...
The link to SFTP is broken, remove it.
I don't even bother to put a new link, since SFTP is literally the next section.
2017-09-12 21:02:34 -07:00
Alexander Neumann
0f25ef9498
Merge pull request #1230 from shayneholmes/update-short-help
...
Update style in short help commands
2017-09-11 22:25:31 +02:00
Shayne Holmes
9f52fe1a10
Update manpages
...
This is a programmatic change; just ran `restic man-page`
2017-09-11 12:05:51 -07:00
Alexander Neumann
36eaa22ed0
Merge pull request #1205 from mungomat/backup_time
...
Backup time
2017-09-11 19:01:41 +02:00
Shayne Holmes
00797fdd85
Synchronize manual with help output
...
Two commands in the output weren't mentioned in the manual.
2017-09-11 09:33:19 -07:00
Shayne Holmes
9eb39cef05
Capitalize short help commands
...
Unify existing Cobra help command, and git-help's style.
2017-09-11 09:32:44 -07:00
Shayne Holmes
ee6150f67c
Change short help messages to imperative voice
...
Unify the output of `restic help`.
2017-09-11 09:26:13 -07:00
Alexander Neumann
b1af544b1d
Merge pull request #1224 from restic/improve-exclude-caches
...
Allow multiple exclude-if-present
2017-09-11 17:31:24 +02:00
Dmitriy Morozov
7d5b17ac72
Update man page for snapshots
2017-09-10 15:28:06 -07:00
Alexander Neumann
8e5b1e6f2f
Add --group-by to manual
2017-09-10 21:00:51 +02:00
Alexander Neumann
b6aeea425b
Merge pull request #1196 from mungomat/forget_groupByTagsOnly
...
forget: group-by-tags-only
2017-09-10 20:52:15 +02:00
Alexander Neumann
89938bc21c
Update manual pages
2017-09-10 15:33:20 +02:00
Damien Couroussé
7090c5ceeb
manual: typo fix
2017-09-09 16:58:17 +02:00
Tobias Klein
8f9ef4402b
error in case of unknown grouping option
2017-09-09 15:55:37 +02:00
Tobias Klein
81d7ecba2b
manual updated
2017-09-09 13:26:35 +02:00
Fabian Wickborn
dbda892542
Add option to exclude directories with a tagfile
...
The option is named --exclude-if-present and accepts a parameter
filename[:content]. Directories are excluded and their contents is not
backed up if they contain a file with the specified name and,
optionally, that starts with the specified content. The tagfile itself
is never excluded.
There is also a shortcut --exclude-caches that works in the same way as
the likewise-named option of tar(1): Directories are recognized as cache
if they contain a file named "CACHEDIR.TAG.
Closes #317 .
2017-09-09 09:57:42 +02:00
Ricardo Seriani
204c2bf09c
Fix manual to use key remove instead of key rm
2017-09-05 16:22:42 -03:00
Alexander Neumann
de8c64e767
Use deterministic date for man pages
2017-09-02 09:27:11 +02:00
Alexander Neumann
73d6b15095
Merge pull request #1201 from gjmf/patch-1
...
Fixed word-o. ("Package", not "packet".)
2017-09-01 21:21:18 +02:00
Graham Freeman
61d2519111
Fixed word-o. ("Package", not "packet".)
...
Fixed a word-o. homebrew is a package manager, not a packet manager. :)
2017-08-31 13:34:53 -07:00
Matthieu OLIVIER
e61c94a846
Update manual.rst
...
`key remove` becomes `key rm`.
2017-08-31 18:26:04 +02:00
Filippo Valsorda
3dccca1f27
doc/design: fix keys.data MAC format description
...
"not including the last 32 byte" was wrong, should have been 16 bytes. But the whole description is redundant anyway.
2017-08-29 00:22:11 +02:00
Michael Pratt
ae43c47ca8
doc: add mention of restore --exclude/--include
...
There is a lot more detail that could be added here, but it is worth
getting things off the ground with at least a mention that it is
possible to restore individual files.
Updates #396
2017-08-27 18:36:00 -07:00
Michael Pratt
2fa4060991
doc: fix inconsistencies
...
* Replace references to ~/shared/work/web which should be ~/web.
* Replace references to ~/tmp which should be /tmp.
* Restore /home/art to /tmp/restore-art instead of /tmp/restore-work,
which is clearly a copy/paste from the command above.
2017-08-27 18:35:01 -07:00
Paul Waring
637f57ca71
Update minimum Go version
...
Minimum version is now 1.8 according to build.go (from latest master, cloned a few minutes ago):
```
paul@voga:~/third-dev/restic$ go run build.go
Go version go1.7.4 detected, restic requires at least Go 1.8
exit status 1
```
2017-08-24 19:51:11 +01:00
Ricardo Seriani
b7d4b0f821
Update man pages
2017-08-17 16:44:28 -03:00
Alexander Neumann
b67c178672
Merge pull request #1149 from restic/azure-support
...
Add Azure blob storage as backend
2017-08-09 21:30:35 +02:00
Alexander Neumann
8dd6beba15
gs: Add section to the manual
2017-08-09 20:22:07 +02:00
Alexander Neumann
bdd43bd430
Add a section to the manual
2017-08-09 20:13:34 +02:00
Alexander Neumann
6bc43a4198
manpage: Remove auto gen tag from man page
2017-08-06 21:31:01 +02:00
Alexander Neumann
739350fd8e
backup: Do not print hostname in help text
...
This is necessary so that the manpage generation is deterministic and we
can test if the man pages are up to date when the CI tests run.
2017-08-05 12:05:53 +02:00
Alexander Neumann
db389058fa
Add generated manual pages
2017-08-05 12:05:53 +02:00
Alexander Neumann
750ee35dbf
Add more examples to the manual
2017-07-16 21:40:53 +02:00
Toby Allen
cb3cd57926
Update links to design.md to design.rst
2017-07-15 19:35:45 +01:00
Alexander Neumann
144b7f3386
doc: Correct path in manual
2017-06-22 19:54:55 +02:00
Alexander Neumann
5f449045d2
Merge pull request #1003 from fwilhe/contributing-md-link
...
Fix relative link to CONTRIBUTING.md
2017-06-09 20:56:21 +02:00
Florian Wilhelm
635633379a
Fix link to CONTRIBUTING.md
2017-06-09 00:36:31 +02:00
Stephan Müller
d11f8d294f
Fixing tiny typo
2017-06-08 13:27:22 +02:00
Alexander Neumann
40a61b82ce
Merge pull request #978 from restic/add-backblaze-backend
...
Add Backblaze B2 backend
2017-06-03 14:54:04 +02:00
Bartłomiej Święcki
5681d41f76
Implement OpenStack swift backend
...
This commit implements support for OpenStack swift
storage server, tested on OVH public cloud storage.
Special thanks to jayme-github <tuxnet@gmail.com>
who helped with the implementation.
2017-06-03 14:26:29 +02:00
Alexander Neumann
122462b9b1
Add Backblaze B2 backend
...
This is based on prior work by Joe Turgeon <arithmetric@gmail.com>
@arithmetric.
2017-06-03 14:24:59 +02:00
Thor77
96c9ecd20e
Fix paragraph not indented correctly
2017-05-31 21:40:47 +02:00
Alexander Neumann
55ae5dab2b
design: Add s3.layout option
2017-05-15 23:37:16 +02:00
Alexander Neumann
a4e3a0dd97
design: Remove cloud layout
2017-05-15 21:51:19 +02:00
Alexander Neumann
04264c6338
Remove doc/PKGBUILD
2017-05-15 19:48:57 +02:00
Alexander Neumann
13393c76dc
Merge pull request #957 from middelink/fix-953
...
Change backup policy to be inclusive
2017-05-15 17:19:04 +02:00
Alexander Neumann
13c12ca83d
Fix PKGBUILD
...
Closes #963
2017-05-15 17:17:23 +02:00
Pauline Middelink
7fffd408af
Do not use singleton counter.
...
Revert change for running the numbered tests as subtests.
2017-05-15 08:53:59 +02:00
Alexander Neumann
091dc29f72
doc: Fix s3 tutorial
2017-05-12 21:04:04 +02:00
Pauline Middelink
929f90344e
Change backup policy to be inclusive, meaning all given policies
...
are evaluated for each snapshot, thereby making sure that each
keep-* is able to retain its most recent snapshot. Thereby insuring
that weeklies keep Sundays around and monthlies keep the last day of
the month around.
Added testcase to make sure when multiple --keep-tags are given,
ALL of them need to match.
2017-05-11 22:34:50 +02:00
Pauline Middelink
2c42629c51
Add bash autocompletion generation
...
Fix #942
2017-05-06 12:39:23 +02:00
Thor77
228566c0a1
Fix links broken during conversion to rst
2017-04-30 18:25:45 +02:00
Alexander Neumann
1e4bcf3367
design.rst: Fix tree IDs in example
...
Closes #913
2017-04-29 20:15:30 +02:00
JP Mens
a1496547fd
Small typo in Frankfurt
2017-04-18 11:42:40 +02:00
Alexander Neumann
0befa06cd0
Merge pull request #919 from Phaeilo/s3-tutorial
...
Added AWS S3 tutorial.
2017-04-17 22:44:12 +02:00
Alexander Neumann
407b8c179b
doc: Use "code-block console" for session blocks
2017-04-17 22:43:04 +02:00
Alexander Neumann
aafee25d58
Convert AWS S3 tutorial to rst
2017-04-17 22:41:23 +02:00
Philip Huppert
adb602dbfe
Added AWS S3 tutorial.
2017-04-17 22:14:39 +02:00
Alexander Neumann
085b6bede8
doc: Add hline
2017-04-17 22:13:43 +02:00
Alexander Neumann
096aab592b
doc: Move doc/references/* to doc/
2017-04-17 22:07:06 +02:00
Alexander Neumann
2f117982e9
Add symlink to make old link to Design.md work
2017-04-17 21:17:15 +02:00
Thor77
9344b0b3a8
Documentation: Refactor and switch to Sphinx
...
* convert documentation to reStructuredText
* switch from mkdocs to sphinx
* rewrite README.md (now .rst) to include less information and be more
attractive
2017-04-17 20:53:38 +02:00
Alexander Neumann
55bdc1fa16
Add documentation for new options
2017-04-14 00:14:11 +02:00
Alexander Neumann
95c354fe81
doc: s3 backend deviations, cloud repo layout
2017-03-26 10:55:08 +02:00
Alexander Neumann
1733b24f9d
doc: Add section about how to change the sftp port
...
Closes #895
Related to #785
2017-03-25 09:07:50 +01:00
Alexander Neumann
2a8f275a28
Manual: Document TMPDIR
env variable
...
Closes #873
2017-03-11 10:02:33 +01:00
Alexander Neumann
55c3150946
Manual: Fix section about JSON
2017-03-11 09:59:36 +01:00
Alexander Neumann
fdb9872cef
Add cross-compilation to README and Manual
2017-03-09 11:37:44 +01:00
Pauline Middelink
b4526c4e6e
Enable the use of context
in restic
...
Set up a cancelble context in global options, hook it into the ctrl-C handler
for proper cancel propegation.
Bump up minimal requirement for Go to version 1.7 in documentation
and test-build files.
2017-03-08 20:12:16 +01:00
Alexander Neumann
07695b3622
Documentation fixes
2017-03-05 20:12:25 +01:00
Pauline Middelink
be15a9261a
Add design and user documentation for the restic tag
command
2017-03-05 19:55:23 +01:00
Alexander Neumann
db08581352
Add hint for other backend URI formats
2017-03-05 16:58:24 +01:00
welpo
12ed2f65e3
Fix Minio Server URL
...
The previous link gave a 404
2017-03-04 13:19:50 +01:00
Alexander Neumann
4a51ddf741
Add section to the manual about same directory names
...
Related to #652
2017-02-21 20:46:26 +01:00
Alexander Neumann
685f5ebbd1
Add --prune
switch to forget
2017-02-21 10:58:30 +01:00
ibib
3ed4127297
Adds JSON support for the snapshots command
2017-02-12 21:43:39 +01:00
Jaap Gordijn
3e2ae15882
Manual: Add section about hard links for fuse
2017-02-11 21:54:54 +01:00
opennota
25e459659a
Fix some typos
2017-02-09 06:43:10 +07:00
Brikou Carré
dfb94290ae
Add link to release page in doc
2017-02-03 09:09:49 +01:00
Alexander Neumann
844c959912
Merge pull request #750 from restic/document-rest-create-repo
...
Document creating a new repo via REST
2017-02-02 10:03:07 +01:00
Alexander Neumann
7e9bfa51e9
REST: Make create repository idempotent
2017-01-30 19:33:17 +01:00
Alexander Neumann
658bee17e9
Clean up documentation, remove inconsistencies
2017-01-30 10:48:59 +01:00
Alexander Neumann
f806d8818d
Add DELETE
2017-01-29 10:55:47 +01:00
Alexander Neumann
1a538509d0
Document creating a new repo via REST
...
Closes #736
2017-01-28 10:31:44 +01:00
Alexander Neumann
6c1032548b
Correct FAQ
2017-01-19 11:47:33 +01:00
Alexander Neumann
c88b0d20e8
Correct typo
2017-01-18 21:57:59 +01:00
Alexander Neumann
fbecae7362
Add FAQ document
2017-01-18 21:48:39 +01:00
Mirko Dziadzka
d47758a540
fix typo
2017-01-18 10:46:04 +01:00
Zlatko Čalušić
c70bc7ed0b
Document REST backend
...
Closes #644
2016-12-31 13:14:44 +01:00
Alexander Neumann
505a2097ad
Manual: Add note about s3 bucket locations
2016-11-27 20:18:57 +01:00
Alexander Thaller
b7b03dbd4a
Added new flag to backup subcommand that reads the files to backup from a file
2016-11-12 15:45:32 +01:00
Alexander Neumann
5e721afb5d
doc/mkdocs: Improve code hilighting
...
Additionally, refresh the restic sample output.
2016-11-08 20:23:39 +01:00
Alexander Neumann
5b7dd32c20
Manual: Reword section about fuse support
2016-10-02 16:03:02 +02:00
Alexander Neumann
968b2ece43
Add section to the manual about debug message filters
2016-09-28 20:22:22 +02:00
Alexander Neumann
0873821b98
Add section about --one-file-system
to manual
2016-09-18 20:18:52 +02:00
Alexander Neumann
a85ffc66ae
Add documentation for tags
2016-09-13 21:09:55 +02:00
Fabian P. Schmidt
085cf36199
doc/Manual: Update usage help listing
2016-09-12 20:42:38 +02:00
Alexander Neumann
f63cd12569
Document new option
2016-09-12 14:10:36 +02:00
Micha Rosenbaum
8ded453ab0
Fix a small typo in stdin
example
...
s/--stdin-filenam/--stdin-filename/
2016-09-05 19:01:53 +02:00
trbs
71263b5090
show progress every second when run non interactively
2016-08-25 22:13:47 +02:00
Alexander Neumann
78c0995853
Improve documentation, add explanation and weekly
2016-08-21 11:53:05 +02:00
Alexander Neumann
2be0aa9dbc
Merge pull request #518 from restic/implement-prune
...
Implement prune
2016-08-21 09:22:22 +02:00
Alexander Neumann
3337b5d3c4
Add prune/forget to the manual
2016-08-20 18:38:16 +02:00
Alexander Neumann
2a2fb74ba8
Merge pull request #569 from restic/fix-568
...
Use the platform-independent function for joining
2016-08-19 17:53:09 +02:00
Alexander Neumann
812cb0ba77
Update Go version in manual
2016-08-16 21:24:48 +02:00
Alexander Neumann
1fe8deeb6e
Use new URI syntax in documentation
2016-08-11 20:37:49 +02:00
Vincent Rischmann
d4a9b546c1
Fix the debug environment variable name in the manual
2016-08-01 22:23:42 +02:00
Lauri Ojansivu
4e98c951e0
Fix typo in Manual.md
2016-06-26 14:35:48 +03:00
koolhead17
789b8c8b49
Added minor modification to the doc as suggested by the author.
2016-05-25 02:26:00 +05:30
Gerdus van Zyl
73e9cac5c4
gofmt + small doc fix
2016-05-10 22:20:03 +02:00
Gerdus van Zyl
49f82f54b0
rebase, change source to host and add description to manual
2016-05-10 21:40:32 +02:00
Alexander Neumann
143fde66bc
Add documentation
2016-05-09 20:11:32 +02:00
Alexander Neumann
60f1fbe35b
Update domain for readthedocs
2016-05-05 13:25:06 +02:00
Thor77
4fb6669196
add documentation for environment-var expanding in exclude-files
2016-04-16 22:07:36 +02:00
Alexander Neumann
32a5778602
Merge pull request #490 from Thor77/backupExcludeFile
...
add backup --exclude-file
2016-04-06 00:09:46 +02:00
Thor77
b4493b4640
add documentation for --exclude[-file] and patterns
2016-04-01 15:56:52 +02:00
xmaka
90765a7dac
add debian stable help
...
add a little clue to debian stable users, to install 'go' from the repositories
2016-03-31 21:02:05 +02:00
Alexander Neumann
921c2f6069
rest backend: Improve documentation
2016-02-21 17:03:27 +01:00
Alexander Neumann
c2348ba768
Add REST backend
...
This is a port of the original work by @bchapuis in
https://github.com/restic/restic/pull/253
2016-02-21 15:33:13 +01:00
Alexander Neumann
9b93b3a72c
doc: Reduce text in README, add to Manual
2016-02-21 13:37:55 +01:00
Alexander Neumann
1edf9c1ee4
doc: Add paragraph about mkdocs
2016-02-21 13:04:45 +01:00
Alexander Neumann
45e9561b48
doc: Add paragraph about documentation version
2016-02-21 12:58:42 +01:00
Alexander Neumann
7de8bf6c27
Manual: Correct headings, add section about debug
2016-02-21 12:56:25 +01:00
Alexander Neumann
1c2992e2e5
Update manual
2016-02-21 12:52:31 +01:00
Alexander Neumann
dc994699d9
Remove obsolete structure image
2016-02-21 12:29:13 +01:00
Alexander Neumann
a13f9f14d0
Add something to the front page
2016-02-21 12:28:46 +01:00
Alexander Neumann
7c4bd662cb
Manual: Fix shell blocks and ToC
2016-02-21 12:28:46 +01:00
Alexander Neumann
6559fa7382
Add mkdocs for readthedocs.org
2016-02-21 12:28:46 +01:00
Florian Daniel
360193320f
Update PKGBUILD to reflect restic official version numbering
2015-12-27 22:05:05 +01:00
Alexander Neumann
7944e8e323
Update index format
2015-10-12 20:53:07 +02:00
Alexander Neumann
3a50c2bbfb
Fix docs
2015-08-22 23:03:25 +02:00
Alexander Neumann
e0e9cd8680
More documentation fixes
2015-08-22 15:09:53 +02:00
Alexander Neumann
b6872fb454
Clarify documentation about MAC key
2015-08-22 15:09:21 +02:00
Florian Daniel
8b485c59fc
Update README and Design documentation
2015-08-21 22:14:37 +02:00
Alexander Neumann
e3ffe33216
doc: Add obsolete Index files
2015-07-05 11:07:10 +02:00
Alexander Neumann
a217f51f2c
Add locks to the design document
2015-06-28 13:52:22 +02:00
Alexander Neumann
d51fd436b5
Add locking functions
2015-06-28 13:52:22 +02:00
Alexander Neumann
e6c62c4ba9
Update Archlinux package file
2015-06-27 11:36:41 +02:00
Alexander Neumann
be943eaf8b
doc: Clarify storage ID
2015-05-04 20:39:07 +02:00
Alexander Neumann
062c328f2d
doc: Add config
2015-05-03 15:00:26 +02:00
Florian Weingarten
90e6a8eb86
consistently rename signature to mac
2015-04-30 13:41:50 -04:00
Alexander Neumann
f889c5e1ed
doc: Add comment about pack header
2015-04-30 00:31:21 +02:00
Alexander Neumann
8f3b91ba32
Add packer, update Design.md
2015-04-29 23:27:08 +02:00
TW
2bc2de006d
fix typos / wording in Design.md
2015-04-26 11:35:38 +02:00
Florian Weingarten
170d147427
Consistent writing
2015-04-24 19:43:27 -04:00
Alexander Neumann
58f289003c
Clarify terminology
2015-04-09 20:48:32 +02:00
Alexander Neumann
b99474154c
Fix indenting
2015-04-09 19:59:16 +02:00
Alexander Neumann
874d6ee2fe
Add new structure to documentation
2015-04-09 19:56:41 +02:00