Martin Michlmayr
41e6a02bcc
Fix typos
2023-10-27 18:56:32 +02:00
Martin Michlmayr
b51fe2fb69
Format option correctly
2023-10-27 18:56:32 +02:00
Michael Eischer
feea567868
Remove readthedocs special case from docs configuration
...
Apparently it's now required to bring your own theme.
2023-10-26 21:56:36 +02:00
Alexander Neumann
524c2721b4
Update manpages and auto-completion
2023-10-24 20:02:55 +02:00
Michael Eischer
85abceb99c
doc: update minimum required Go version
2023-10-23 19:02:20 +02:00
Michael Eischer
7f05af02b9
Merge pull request #4480 from AgathaSorceress/add-rest-auth-env
...
Support reading basic auth credentials for REST server from environment variables
2023-10-21 17:41:08 +00:00
Michael Eischer
eabc177a42
Merge pull request #4442 from Refutable4890/copy-doc
...
Add a description of the resumption of `copy`
2023-10-21 17:38:15 +00:00
Michael Eischer
baf9b54891
sftp: simplify documentation for sftp.args
2023-10-21 19:28:27 +02:00
Michael Manganiello
41f70f1f4f
backend/sftp: Add sftp.args option
...
Allow setting custom arguments for the `sftp` backend, by using the
`sftp.args` option. This is similar to the approach already implemented
in the `rclone` backend, to support new arguments without requiring
future code changes for each different SSH argument.
Closes #4241
2023-10-21 19:25:44 +02:00
Agatha V. Lovelace
0f97356b21
docs: add new REST server env variables
2023-10-20 13:04:58 +02:00
Daniel Danner
a858ab254b
Include inode in JSON output for find and ls
...
This introduces the inode attribute to the JSON output emitted for nodes
in `ls` and matches in `find`. There doesn't seem to be any discernible
reason to omit the inode and it can be useful in scripting scenarios.
2023-10-11 21:10:01 +02:00
Refutable4890
aa86c76aab
Add a description of the resumption of copy
2023-10-08 12:07:40 +08:00
James Alseth
02ab511c2f
docs(examples): Use restic binary from system path
...
Signed-off-by: James Alseth <james@jalseth.me>
2023-09-17 19:39:45 -07:00
Michael Eischer
fb4d458cce
Merge pull request #4452 from lbausch/docs/add-current-key-hint
...
docs: explain meaning of asterisk when managing repository keys
2023-09-06 20:28:33 +00:00
Lorenz Bausch
84a1170dee
docs: remove trailing whitespace
2023-08-27 10:49:34 +02:00
Lorenz Bausch
0b4d9c9a51
docs: add missing whitespace to avoid malformed table warning
2023-08-27 10:46:55 +02:00
Lorenz Bausch
5422a7daa5
docs: explain meaning of asterisk when managing repository keys
2023-08-27 10:40:55 +02:00
Refutable4890
e09f6f540f
Add a description of the resumption of copy
2023-08-08 12:51:40 +08:00
Lorenz Bausch
9a69f44de2
docs: fix percent_done
description
2023-08-04 16:15:18 +02:00
Alexander Neumann
62680af734
Update manpages and auto-completion
2023-07-31 20:23:24 +02:00
Michael Eischer
be03c1a457
Merge pull request #4422 from MichaelEischer/document-non-utf-symlinks
...
Document `linktarget_raw` field for non utf symlinks
2023-07-28 23:14:08 +02:00
Michael Eischer
b87a37f318
doc: Fix typos
2023-07-25 20:14:56 +02:00
Michael Eischer
647ebf352a
doc: Describe linktarget_raw field
2023-07-25 20:14:47 +02:00
Michael Eischer
ae13cf15c1
doc: move quickstart to docs
2023-07-23 17:32:37 +02:00
Michael Eischer
55b440b520
tweak snapshot:subfolder docs
2023-07-22 23:50:17 +02:00
Michael Eischer
184b7616ba
document snapshot:subfolder syntax
2023-07-22 19:55:57 +02:00
Michael Eischer
c9f506925c
azure: Document additional auth options
2023-07-09 20:56:21 +02:00
Michael Eischer
41395e83c5
Merge pull request #2740 from metalsp0rk/document-json
...
Add JSON documentation
2023-07-08 21:34:02 +00:00
Michael Eischer
229c7b24a4
doc: add program_version field of snapshot JSON output
2023-07-08 23:31:20 +02:00
Michael Eischer
b34ce57dd4
doc: describe JSON output of restore command
2023-07-08 23:31:20 +02:00
Michael Eischer
1ce839228e
doc: Expand JSON documentation
2023-07-08 23:31:20 +02:00
Kyle Brennan
fb1170c1d6
doc tweaks
2023-07-08 23:21:41 +02:00
Kyle Brennan
e457fe22bc
Documentation improvement
2023-07-08 23:21:41 +02:00
Kyle Brennan
39299e36ef
add json documentation
2023-07-08 23:21:41 +02:00
Michael Eischer
c181b51360
doc: Update docker build process
2023-07-08 23:05:38 +02:00
Michael Eischer
cc3c218baf
small cleanups for certificate environment variables
2023-07-08 09:44:59 +02:00
arjunajesh
c1578a2035
certificates can be passed through env vars
2023-07-08 09:44:59 +02:00
Michael Eischer
678b983300
Merge pull request #4360 from Refutable4890/master
...
Add an description of `check` temporary cache directory location
2023-07-07 21:51:52 +00:00
Michael Eischer
e36d17a6f8
azure: tweak documentation for endpoint suffix
2023-07-07 23:10:26 +02:00
arjunajesh
068b115abc
added azure domain parameter
2023-07-07 23:10:26 +02:00
Louis Matthijssen
dbe2eef80c
Add hostname flag to Docker docs
...
Fixes #4380
2023-07-01 18:46:31 +02:00
Michael Eischer
8dcb0c4a9d
doc: improve description of caching behavior of the check command
2023-06-17 22:18:50 +02:00
Refutable4890
aea7538936
Add an description of check
temporary cache directory location
2023-06-07 22:35:33 +08:00
Daniel Gibson
f9dded83b3
doc/050_restore.rst: Mention that restic restore is fastest
...
Especially with lots of files (like when backing up git repos),
restic mount + cp -r can be really slow.
2023-05-31 22:44:36 +02:00
sohalt
ed5b2c2c9b
gs: support other regions than us
2023-05-26 19:54:42 +02:00
Michael Eischer
9c64a95df8
doc: rewrite troubleshooting section
2023-05-01 16:06:17 +02:00
Michael Eischer
118d599d0a
Rename 'rebuild-index' to 'repair index'
...
The old name still works, but is deprecated.
2023-05-01 15:16:44 +02:00
Alexander Weiss
99a05d5ab2
Update troubleshooting documentation
2023-05-01 14:56:42 +02:00
Alexander Weiss
9cef6b4c69
Add troubleshooting documentation
2023-05-01 14:56:42 +02:00
Michael Eischer
8d971172c4
Merge pull request #4306 from MichaelEischer/document-restic-compression-env
...
Document that the compression mode can be set via $RESTIC_COMPRESSION
2023-04-30 18:26:10 +02:00
Michael Eischer
37d0e323eb
doc: update help output in manual_rest.rst
2023-04-30 16:12:29 +02:00
Michael Eischer
face5bd7f7
Document that the compression mode can be set via $RESTIC_COMPRESSION
2023-04-30 16:11:53 +02:00
Michael Eischer
850cd9aace
Merge pull request #4299 from MichaelEischer/update-scripting-docs
...
doc: recommend `cat config` to check if a repository exists
2023-04-30 16:04:59 +02:00
Michael Eischer
c8641f4479
Merge branch 'patch-release'
2023-04-24 20:44:38 +02:00
Alexander Neumann
db6b4f8912
Update manpages and auto-completion
2023-04-24 20:28:37 +02:00
Fabien-Jrt
756f43d5f9
doc: Add resticprofile to scheduling section
2023-04-22 01:04:48 +02:00
Michael Eischer
affd04c125
doc: recommend cat config
to check if a repository exists
...
This will be much faster if a large number of snapshots exists.
2023-04-21 22:56:31 +02:00
Michael Eischer
913eab3361
Merge pull request #4234 from thndrbrrr/forget-opts-neg1-means-forever-issue-2565
...
restic forget --keep-* options will interpret -1 as "forever"
2023-04-14 23:18:47 +02:00
Michael Eischer
74f7dd0b38
Make help for --verbose less confusing
...
The output is now
```
-v, --verbose be verbose (specify multiple times or a level using --verbose=n, max level/times is 2)
```
instead of
```
-v, --verbose n be verbose (specify multiple times or a level using --verbose=n, max level/times is 2)
```
2023-04-13 22:46:37 +02:00
Michael Eischer
bdcafbc11c
Merge pull request #4282 from TorstenC/patch-1
...
040_backup.rst line 228 - #4280 --exclude-caches
2023-04-11 22:34:16 +02:00
Torsten C
ba33e41068
040_backup.rst line 228 - #4280 --exclude-caches
...
Proposal for issue #4280
2023-04-11 22:33:10 +02:00
Michael Eischer
2091fc0dde
Merge pull request #4107 from jooola/feature-wait-for-unlock
...
Add a global option --retry-lock
2023-04-11 22:21:01 +02:00
Torben Giesselmann
403b7ca2be
forget: Update documentation
2023-04-09 12:57:37 -07:00
jo
ea59896bd6
Add a global option --retry-lock
...
Fixes restic#719
If the option is passed, restic will wait the specified duration of time
and retry locking the repo every 10 seconds (or more often if the total
timeout is relatively small).
- Play nice with json output
- Reduce wait time in lock tests
- Rework timeout last attempt
- Reduce test wait time to 0.1s
- Use exponential back off for the retry lock
- Don't pass gopts to lockRepo functions
- Use global variable for retry sleep setup
- Exit retry lock on cancel
- Better wording for flag help
- Reorder debug statement
- Refactor tests
- Lower max sleep time to 1m
- Test that we cancel/timeout in time
- Use non blocking sleep function
- Refactor into minDuration func
Co-authored-by: Julian Brost <julian@0x4a42.net>
2023-04-07 16:24:14 +02:00
Michael Eischer
806a0cdce3
bump minimum go version on Solaris to 1.20
2023-04-07 15:40:57 +02:00
Leo R. Lundgren
0666fa11b8
doc: Correct broken links
2023-03-22 17:37:58 +01:00
rawtaz
caa0e89114
Merge pull request #4246 from greatroar/doc
...
doc: Fix links, focus less on implementation details
2023-03-22 14:47:31 +01:00
GuitarBilly
1f12915b0c
Update 110_talks.rst
...
Update 110_talks.rst
align date to 2nd of April as agreed.
( match podcast publication date )
2023-03-22 13:54:27 +01:00
greatroar
a7ac9a4769
doc: Fix some links, focus less on implementation details
...
The godoc for filepath.Match has the syntax, which is what is important
for writing patterns. Use pkg.go.dev instead of golang.org/pkg.
For #4245 . Not all links fixed yet.
2023-03-13 00:23:15 +01:00
Alexander Neumann
aac8c5a7ca
Merge pull request #4244 from MichaelEischer/fix-doc-typos
...
Fix documentation typos and build with Sphinx 6
2023-03-12 15:04:26 +01:00
Michael Eischer
eb7dbc88b5
Merge pull request #4210 from aawsome/patch-1
...
docs: Corrections/extra information in design.rst
2023-03-12 12:00:25 +01:00
Michael Eischer
e02aadf1d2
doc: use extlink for links to issues
2023-03-12 11:55:36 +01:00
Michael Eischer
c4e6b198ae
doc: fix building with Sphinx 6
2023-03-12 11:45:26 +01:00
Michael Eischer
f47c8eebb7
doc: fix broken link in rewrite command docs
2023-03-12 11:44:56 +01:00
Michael Eischer
a67d3781a3
doc: apply review comments and improve link formatting
2023-03-12 11:37:37 +01:00
Michael Eischer
00575ecffe
doc: Remove mixed pack files from index example
...
The example given for the format of an index shows a mixed pack file.
Mixing tree and data blobs has been deprecated for a long time. Thus,
change the pack to only contain "data" blobs.
2023-03-11 19:10:31 +01:00
aawsome
e2df73b0ac
Update doc/design.rst
...
Co-authored-by: greatroar <61184462+greatroar@users.noreply.github.com>
2023-02-17 10:07:53 +01:00
aawsome
f4329a20f6
docs: Corrections/extra information in design.rst
2023-02-16 22:41:30 +01:00
Michael Eischer
0ce182f044
document backup --group-by
2023-02-11 00:55:11 +01:00
Michael Eischer
2d700c3887
Make help for --verbose less confusing
...
The output is now
```
-v, --verbose be verbose (specify multiple times or a level using --verbose=n, max level/times is 2)
```
instead of
```
-v, --verbose n be verbose (specify multiple times or a level using --verbose=n, max level/times is 2)
```
2023-02-06 22:11:21 +01:00
Alexander Neumann
da196aa43e
Update manpages and auto-completion
2023-01-12 20:51:19 +01:00
Leo R. Lundgren
1cb920cc57
doc: Correct heading level for --no-scan
2023-01-11 21:47:38 +01:00
Michael Eischer
8f53ffb921
Merge pull request #4140 from restic/doc-manual
...
doc: Update manual page with --no-scan
2023-01-11 21:42:42 +01:00
Leo R. Lundgren
b8b5508d15
doc: Update manual page with --no-scan
2023-01-11 02:27:43 +01:00
Leo R. Lundgren
c5542ddcd2
doc: Move and update documentation for --no-scan
2023-01-11 00:09:24 +01:00
Michael Eischer
b151fa498a
doc: add description for restore --sparse
2023-01-10 23:27:42 +01:00
Michael Eischer
c354b55e62
Merge pull request #4136 from restic/doc-small-files
...
doc: Clarify text about tuning backups for small files
2023-01-08 22:00:09 +01:00
Michael Eischer
375953a001
Merge pull request #4088 from MichaelEischer/doc-cifs-backup-source
...
doc: reading from CIFS can be a problem on linux
2023-01-08 21:56:48 +01:00
Leo R. Lundgren
6306797238
doc: Clarify text about tuning backups for small files
2023-01-08 21:49:55 +01:00
Michael Eischer
ef9164fcbb
doc: reading from CIFS can be a problem on linux
2023-01-08 21:47:34 +01:00
Michael Eischer
732184a849
Correct maximum verbosity level in help message
...
The maximum for `--verbose=n` is n=2. Internally it is translated into a
scale from 0 to 3. However, the default (without verbose) is 1, thus the
verbosity level can only be increased two times.
2023-01-07 22:02:13 +01:00
Andreas Dominik Preikschat
ea37240597
remove duplicated init
...
the documentation contained the `init` command twice
2022-12-20 17:24:56 +01:00
Kjetil Torgrim Homme
14aa6f2a00
add --disable-scanner to backup command
...
The scanner process has only cosmetic effect for the progress printer,
and can be disabled without impacting functionality when the user does
not need an estimate of completion.
In many cases the scanner process can provide beneficial priming of
the file system cache, so as general advice it should not be disabled.
However, tests have shown that backup of NFS and fuse based filesystems,
where stat(2) is relatively expensive, can be significantly faster
without the scanner.
2022-12-16 21:29:59 +01:00
greatroar
5efcbe143c
doc: Remove ref to Lobaro's Docker image
...
It hasn't been updated for a while and has restic 0.12.0. Fixes #4002 .
2022-12-04 16:20:42 +01:00
Michael Eischer
0eddc89e98
doc: design.rst: Fix highlighting for index snippet
...
JSON does not support comments. As JSON is a subset of Javascript, use
the latter instead.
2022-11-27 17:01:27 +01:00
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