e212076f71
doc: correctly use RST backticks
...
RST uses double backticks for inline code unlike the single backticks in
Markdown.
2026-05-15 23:37:54 +02:00
b16f0bf410
doc: use sentence case for section headings
2026-05-15 23:37:54 +02:00
4c9a07e9c8
doc: stick to second-persion "you" in user docs
...
Replace usages of `we`, `one` and "it is possible" with the mainly used `you`.
2026-05-15 23:13:29 +02:00
f6c8751575
doc: consistency fixes
2026-05-15 22:42:29 +02:00
2419c03177
doc: fix several typos
2026-05-15 22:25:51 +02:00
8abbc3703d
doc: update embedded help output and misc typos ( #21804 )
2026-05-15 20:21:04 +02:00
adbd4a1d18
Fully rework docs for group-accessible repositories
...
Just tell the user what to do instead of explaining too many details.
I've dropped the read-only variant as it actually has no representation
in the local and sftp backends. Instead it relied on both backends
initially creating all directories, which can't actually be guaranteed.
Based on a suggestion by @brad2014 in significant parts.
2025-10-03 21:24:57 +02:00
537d107b6c
docs: use absolute permissions for group accessible repositories
2025-10-03 21:24:57 +02:00
06aa0f08cb
docs: fix permission setup for group-accessible repo
...
The group always needs execute access for the directories. In addition,
files should be always set to read-only for everyone as restic never
modifies files.
2025-10-03 21:24:57 +02:00
0b080c44d7
doc: Correct Wasabi link
2025-08-02 13:03:43 -05:00
5614cf4758
doc: fix typos
2025-03-29 12:40:47 +03:30
89826ef5ce
doc: fix links to Backblaze documentation
2025-02-21 23:43:02 +01:00
bff3341d10
azure: add support for hot, cool, or cool access tiers
2024-10-20 15:27:21 +05:30
113439c69b
fix: shorten sentence
2024-09-07 15:27:15 +02:00
00ca0b371b
docs: Recommend to setup B2 versions lifecycle rules
2024-09-04 13:21:37 +02:00
ebd8f0c74a
docs: make s3-compatible section standalone
2024-08-31 19:39:30 +02:00
8a8f5f3986
doc: fix typos
2024-08-26 12:24:02 +02:00
7de53a51b8
doc: shrink wasabi / alibaba cloud example
...
Remove descriptions for both providers and shorten the example to the
minimum.
2024-08-26 12:21:13 +02:00
9649a9c62b
doc: use regional urls for Amazon S3 and add generic s3 provider section
...
Split description for non-Amazon S3 providers into separate section. The
section now also includes the `s3.bucket-lookup` extended option. Switch
to using regional URLs for Amazon S3 to replace the need for setting the
region.
2024-08-26 12:17:43 +02:00
ac00229386
Fix typos
2024-07-03 20:02:06 +02:00
130506250f
document insecure-no-password
2024-05-24 22:38:20 +02:00
355f520936
Azure: add option to force use of CLI credential
2024-05-18 22:15:54 +02:00
6e775d3787
Enhancement: option to send HTTP over unix socket
...
add tests for unix socket connection
switch HTTP rest-server test to use any free port
allow rest-server test graceful shutdown opportunity
2024-03-28 17:41:41 +01:00
5771c4ecfb
docs: update environment variables for az login to azure backend
2024-02-05 01:32:43 +05:30
18806944f6
doc: remove blockquotes from unordered lists
2024-01-23 19:03:54 +01:00
5413877d33
Update Backblaze documentation
...
clarify documentation regarding B2 bucket lifecycle settings. The default lifecycle setting is probably fine for most users now; a custom policy is not necessary.
2024-01-18 16:41:01 -06:00
41e6a02bcc
Fix typos
2023-10-27 18:56:32 +02:00
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
baf9b54891
sftp: simplify documentation for sftp.args
2023-10-21 19:28:27 +02:00
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
0f97356b21
docs: add new REST server env variables
2023-10-20 13:04:58 +02:00
c9f506925c
azure: Document additional auth options
2023-07-09 20:56:21 +02:00
e36d17a6f8
azure: tweak documentation for endpoint suffix
2023-07-07 23:10:26 +02:00
068b115abc
added azure domain parameter
2023-07-07 23:10:26 +02:00
ed5b2c2c9b
gs: support other regions than us
2023-05-26 19:54:42 +02:00
0666fa11b8
doc: Correct broken links
2023-03-22 17:37:58 +01:00
caa0e89114
Merge pull request #4246 from greatroar/doc
...
doc: Fix links, focus less on implementation details
2023-03-22 14:47:31 +01:00
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
e02aadf1d2
doc: use extlink for links to issues
2023-03-12 11:55:36 +01:00
ef9164fcbb
doc: reading from CIFS can be a problem on linux
2023-01-08 21:47:34 +01:00
41b0f1d43a
doc: fix link to amazon s3 section
2022-11-27 17:01:22 +01:00
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
43cc01d63e
doc: Fix typo
2022-10-05 21:03:14 +02:00
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
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
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
d464543171
Update repo version table
2022-08-25 21:30:25 +02:00
b4ae05627f
Merge pull request #3876 from MichaelEischer/document-aws-session-token
...
doc: document aws session token
2022-08-24 22:20:26 +02:00
cb5a61c46e
doc: Improve/clarify preparing and versions of repositories
2022-08-24 02:08:46 +02:00
c586a5e20f
doc: recommend usage of B2's S3 API
2022-08-21 11:39:03 +02:00
Michael Eischer
Michael Eischer
A Crutcher
Mohammad Javad Naderi
Andreas Baumgartner
Srigovind Nayak
Git'Fellow
Viktor Szépe
Maik Riechert
Adam Eijdenberg
Ben Northway
Martin Michlmayr
Michael Eischer
Michael Manganiello
Agatha V. Lovelace
arjunajesh
sohalt
Leo R. Lundgren
rawtaz
greatroar
FelixBurkhard
tr
Alexander Neumann