Skip to content

Commit 5e6e418

Browse files
update rest-server help output in readme
1 parent 3a6e9e1 commit 5e6e418

File tree

1 file changed

+22
-20
lines changed

1 file changed

+22
-20
lines changed

README.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -32,25 +32,27 @@ Usage:
3232
rest-server [flags]
3333

3434
Flags:
35-
--append-only enable append only mode
36-
--cpu-profile string write CPU profile to file
37-
--debug output debug messages
38-
-h, --help help for rest-server
39-
--htpasswd-file string location of .htpasswd file (default: "<data directory>/.htpasswd")
40-
--listen string listen address (default ":8000")
41-
--log filename write HTTP requests in the combined log format to the specified filename
42-
--max-size int the maximum size of the repository in bytes
43-
--no-auth disable .htpasswd authentication
44-
--no-verify-upload do not verify the integrity of uploaded data. DO NOT enable unless the rest-server runs on a very low-power device
45-
--path string data directory (default "/tmp/restic")
46-
--private-repos users can only access their private repo
47-
--prometheus enable Prometheus metrics
48-
--prometheus-no-auth disable auth for Prometheus /metrics endpoint
49-
--tls turn on TLS support
50-
--tls-cert string TLS certificate path
51-
--tls-key string TLS key path
52-
--tls-min-ver string TLS min version (1.2|1.3, default: 1.2)
53-
-v, --version version for rest-server
35+
--append-only enable append only mode
36+
--cpu-profile string write CPU profile to file
37+
--debug output debug messages
38+
--group-accessible-repos let filesystem group be able to access repo files
39+
-h, --help help for rest-server
40+
--htpasswd-file string location of .htpasswd file (default: "<data directory>/.htpasswd)"
41+
--listen string listen address (default ":8000")
42+
--log filename write HTTP requests in the combined log format to the specified filename (use "-" for logging to stdout)
43+
--max-size int the maximum size of the repository in bytes
44+
--no-auth disable .htpasswd authentication
45+
--no-verify-upload do not verify the integrity of uploaded data. DO NOT enable unless the rest-server runs on a very low-power device
46+
--path string data directory (default "/tmp/restic")
47+
--private-repos users can only access their private repo
48+
--prometheus enable Prometheus metrics
49+
--prometheus-no-auth disable auth for Prometheus /metrics endpoint
50+
--proxy-auth-username string specifies the HTTP header containing the username for proxy-based authentication
51+
--tls turn on TLS support
52+
--tls-cert string TLS certificate path
53+
--tls-key string TLS key path
54+
--tls-min-ver string TLS min version, one of (1.2|1.3) (default "1.2")
55+
-v, --version version for rest-server
5456
```
5557

5658
By default the server persists backup data in the OS temporary directory (`/tmp/restic` on Linux/BSD and others, in `%TEMP%\\restic` in Windows, etc). **If `rest-server` is launched using the default path, all backups will be lost**. To start the server with a custom persistence directory and with authentication disabled:
@@ -69,7 +71,7 @@ If you want to disable authentication, you must add the `--no-auth` flag. If thi
6971

7072
NOTE: In older versions of rest-server (up to 0.9.7), this flag does not exist and the server disables authentication if `.htpasswd` is missing or cannot be opened.
7173

72-
By default the server uses HTTP protocol. This is not very secure since with Basic Authentication, user name and passwords will be sent in clear text in every request. In order to enable TLS support just add the `--tls` argument and add a private and public key at the root of your persistence directory. You may also specify private and public keys by `--tls-cert` and `--tls-key` and set the minimum TLS version by `--tls-min-ver [1.2|1.3]`.
74+
By default the server uses HTTP protocol. This is not very secure since with Basic Authentication, user name and passwords will be sent in clear text in every request. In order to enable TLS support just add the `--tls` argument and add a private and public key at the root of your persistence directory. You may also specify private and public keys by `--tls-cert` and `--tls-key` and set the minimum TLS version to 1.3 using `--tls-min-ver 1.3`.
7375

7476
Signed certificate is normally required by the restic backend, but if you just want to test the feature you can generate password-less unsigned keys with the following command:
7577

0 commit comments

Comments
 (0)