Commit Graph

280 Commits

Author SHA1 Message Date
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