diff options
author | Syncthing Release Automation <release@syncthing.net> | 2023-10-09 03:45:35 +0000 |
---|---|---|
committer | Syncthing Release Automation <release@syncthing.net> | 2023-10-09 03:45:35 +0000 |
commit | 6e4574a9f7ced562e1ea326147fe4dcd5dd16706 (patch) | |
tree | 6a815ec982fcf101286e2f85cdb3a1765f0f9a64 /man | |
parent | 3d0da5ac60ab02cf47ca5cd4fada48cc70360ec9 (diff) | |
download | syncthing-6e4574a9f7ced562e1ea326147fe4dcd5dd16706.tar.gz syncthing-6e4574a9f7ced562e1ea326147fe4dcd5dd16706.zip |
gui, man, authors: Update docs, translations, and contributors
Diffstat (limited to 'man')
-rw-r--r-- | man/stdiscosrv.1 | 2 | ||||
-rw-r--r-- | man/strelaysrv.1 | 2 | ||||
-rw-r--r-- | man/syncthing-bep.7 | 2 | ||||
-rw-r--r-- | man/syncthing-config.5 | 2 | ||||
-rw-r--r-- | man/syncthing-device-ids.7 | 2 | ||||
-rw-r--r-- | man/syncthing-event-api.7 | 2 | ||||
-rw-r--r-- | man/syncthing-faq.7 | 37 | ||||
-rw-r--r-- | man/syncthing-globaldisco.7 | 2 | ||||
-rw-r--r-- | man/syncthing-localdisco.7 | 2 | ||||
-rw-r--r-- | man/syncthing-networking.7 | 2 | ||||
-rw-r--r-- | man/syncthing-relay.7 | 2 | ||||
-rw-r--r-- | man/syncthing-rest-api.7 | 11 | ||||
-rw-r--r-- | man/syncthing-security.7 | 2 | ||||
-rw-r--r-- | man/syncthing-stignore.5 | 2 | ||||
-rw-r--r-- | man/syncthing-versioning.7 | 2 | ||||
-rw-r--r-- | man/syncthing.1 | 15 |
16 files changed, 49 insertions, 40 deletions
diff --git a/man/stdiscosrv.1 b/man/stdiscosrv.1 index 34e3594ac..c4e55557f 100644 --- a/man/stdiscosrv.1 +++ b/man/stdiscosrv.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "STDISCOSRV" "1" "Sep 30, 2023" "v1.24.0" "Syncthing" +.TH "STDISCOSRV" "1" "Oct 05, 2023" "v1.25.0" "Syncthing" .SH NAME stdiscosrv \- Syncthing Discovery Server .SH SYNOPSIS diff --git a/man/strelaysrv.1 b/man/strelaysrv.1 index fa630816a..230a7181f 100644 --- a/man/strelaysrv.1 +++ b/man/strelaysrv.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "STRELAYSRV" "1" "Sep 30, 2023" "v1.24.0" "Syncthing" +.TH "STRELAYSRV" "1" "Oct 05, 2023" "v1.25.0" "Syncthing" .SH NAME strelaysrv \- Syncthing Relay Server .SH SYNOPSIS diff --git a/man/syncthing-bep.7 b/man/syncthing-bep.7 index b568d9a8e..048cfc70b 100644 --- a/man/syncthing-bep.7 +++ b/man/syncthing-bep.7 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "SYNCTHING-BEP" "7" "Sep 30, 2023" "v1.24.0" "Syncthing" +.TH "SYNCTHING-BEP" "7" "Oct 05, 2023" "v1.25.0" "Syncthing" .SH NAME syncthing-bep \- Block Exchange Protocol v1 .SH INTRODUCTION AND DEFINITIONS diff --git a/man/syncthing-config.5 b/man/syncthing-config.5 index 93a8b50b2..0f4a4273c 100644 --- a/man/syncthing-config.5 +++ b/man/syncthing-config.5 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "SYNCTHING-CONFIG" "5" "Sep 30, 2023" "v1.24.0" "Syncthing" +.TH "SYNCTHING-CONFIG" "5" "Oct 05, 2023" "v1.25.0" "Syncthing" .SH NAME syncthing-config \- Syncthing Configuration .SH SYNOPSIS diff --git a/man/syncthing-device-ids.7 b/man/syncthing-device-ids.7 index 26017bc30..619ab037c 100644 --- a/man/syncthing-device-ids.7 +++ b/man/syncthing-device-ids.7 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "SYNCTHING-DEVICE-IDS" "7" "Sep 30, 2023" "v1.24.0" "Syncthing" +.TH "SYNCTHING-DEVICE-IDS" "7" "Oct 05, 2023" "v1.25.0" "Syncthing" .SH NAME syncthing-device-ids \- Understanding Device IDs .sp diff --git a/man/syncthing-event-api.7 b/man/syncthing-event-api.7 index 9b0db3a3b..eda8f5250 100644 --- a/man/syncthing-event-api.7 +++ b/man/syncthing-event-api.7 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "SYNCTHING-EVENT-API" "7" "Sep 30, 2023" "v1.24.0" "Syncthing" +.TH "SYNCTHING-EVENT-API" "7" "Oct 05, 2023" "v1.25.0" "Syncthing" .SH NAME syncthing-event-api \- Event API .SH DESCRIPTION diff --git a/man/syncthing-faq.7 b/man/syncthing-faq.7 index 2293b6f42..3a2acf607 100644 --- a/man/syncthing-faq.7 +++ b/man/syncthing-faq.7 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "SYNCTHING-FAQ" "7" "Sep 30, 2023" "v1.24.0" "Syncthing" +.TH "SYNCTHING-FAQ" "7" "Oct 05, 2023" "v1.25.0" "Syncthing" .SH NAME syncthing-faq \- Frequently Asked Questions .INDENT 0.0 @@ -519,11 +519,10 @@ On Windows, escaping special characters is not supported as the \fB\e\fP character is used as a path separator. .SS How do I access the web GUI from another computer? .sp -The default listening address is 127.0.0.1:8384, so you can only access the -GUI from the same machine. This is for security reasons. To access the web -GUI from another computer, change the \fBGUI listen address\fP through the web -UI from \fB127.0.0.1:8384\fP to -\fB0.0.0.0:8384\fP or change the config.xml: +The default listening address is 127.0.0.1:8384, so you can only access the GUI +from the same machine. This is for security reasons. To access it from another +computer, change the \fBGUI listen address\fP option in the web GUI from +\fB127.0.0.1:8384\fP to \fB0.0.0.0:8384\fP, or change the \fBconfig.xml\fP: .INDENT 0.0 .INDENT 3.5 .sp @@ -542,19 +541,19 @@ to .sp .nf .ft C -<gui enabled=\(dqtrue\(dq tls=\(dqfalse\(dq> +<gui enabled=\(dqtrue\(dq tls=\(dqtrue\(dq> <address>0.0.0.0:8384</address> .ft P .fi .UNINDENT .UNINDENT .sp -Then the GUI is accessible from everywhere. You should set a password and -enable HTTPS with this configuration. You can do this from inside the GUI. +Then the GUI is accessible from everywhere. There is no filtering based on +e.g. source address (use a firewall for that). You should set a password and +enable HTTPS with this configuration. You can do this from inside the GUI. .sp If both your computers are Unix\-like (Linux, Mac, etc.) you can also leave the -GUI settings at default and use an ssh port forward to access it. For -example, +GUI settings at default and use an SSH port forward to access it. For example, .INDENT 0.0 .INDENT 3.5 .sp @@ -566,11 +565,11 @@ $ ssh \-L 9090:127.0.0.1:8384 user@othercomputer.example.com .UNINDENT .UNINDENT .sp -will log you into othercomputer.example.com, and present the \fIremote\fP +will log you into \fBothercomputer.example.com\fP, and present the \fIremote\fP Syncthing GUI on \fI\%http://localhost:9090\fP on your \fIlocal\fP computer. .sp -If you only want to access the remote gui and don’t want the terminal -session, use this example, +If you only want to access the remote GUI and don’t want the terminal session, +use this example: .INDENT 0.0 .INDENT 3.5 .sp @@ -582,13 +581,9 @@ $ ssh \-N \-L 9090:127.0.0.1:8384 user@othercomputer.example.com .UNINDENT .UNINDENT .sp -If only your remote computer is Unix\-like, -you can still access it with ssh from Windows. -.sp -Under Windows 10 or later (64\-bit only) you can use the same ssh command -if you install the \fI\%Windows Subsystem for Linux\fP <\fBhttps://docs.microsoft.com/windows/wsl/install\fP>\&. -.sp -Another Windows way to run ssh is to install \fI\%gow (Gnu On Windows)\fP <\fBhttps://github.com/bmatzelle/gow\fP>\&. The easiest way to install gow is with the \fI\%chocolatey\fP <\fBhttps://chocolatey.org/\fP> package manager. +If only your remote computer is Unix\-like, you can still access it with SSH from +Windows. Under Windows 10 or later you can use the same \fBssh\fP command if you +\fI\%install the OpenSSH Client\fP <\fBhttps://learn.microsoft.com/windows-server/administration/openssh/openssh_install_firstuse\fP>\&. .SS I don’t like the GUI or the theme. Can it be changed? .sp You can change the theme in the settings. Syncthing ships with other themes diff --git a/man/syncthing-globaldisco.7 b/man/syncthing-globaldisco.7 index fb347b8c3..7fa558622 100644 --- a/man/syncthing-globaldisco.7 +++ b/man/syncthing-globaldisco.7 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "SYNCTHING-GLOBALDISCO" "7" "Sep 30, 2023" "v1.24.0" "Syncthing" +.TH "SYNCTHING-GLOBALDISCO" "7" "Oct 05, 2023" "v1.25.0" "Syncthing" .SH NAME syncthing-globaldisco \- Global Discovery Protocol v3 .SH ANNOUNCEMENTS diff --git a/man/syncthing-localdisco.7 b/man/syncthing-localdisco.7 index e82aee2f0..bd4525f0a 100644 --- a/man/syncthing-localdisco.7 +++ b/man/syncthing-localdisco.7 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "SYNCTHING-LOCALDISCO" "7" "Sep 30, 2023" "v1.24.0" "Syncthing" +.TH "SYNCTHING-LOCALDISCO" "7" "Oct 05, 2023" "v1.25.0" "Syncthing" .SH NAME syncthing-localdisco \- Local Discovery Protocol v4 .SH MODE OF OPERATION diff --git a/man/syncthing-networking.7 b/man/syncthing-networking.7 index bb3ecaab3..d3ff46281 100644 --- a/man/syncthing-networking.7 +++ b/man/syncthing-networking.7 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "SYNCTHING-NETWORKING" "7" "Sep 30, 2023" "v1.24.0" "Syncthing" +.TH "SYNCTHING-NETWORKING" "7" "Oct 05, 2023" "v1.25.0" "Syncthing" .SH NAME syncthing-networking \- Firewall Setup .SH ROUTER SETUP diff --git a/man/syncthing-relay.7 b/man/syncthing-relay.7 index de9ca1b20..ca1896913 100644 --- a/man/syncthing-relay.7 +++ b/man/syncthing-relay.7 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "SYNCTHING-RELAY" "7" "Sep 30, 2023" "v1.24.0" "Syncthing" +.TH "SYNCTHING-RELAY" "7" "Oct 05, 2023" "v1.25.0" "Syncthing" .SH NAME syncthing-relay \- Relay Protocol v1 .SH WHAT IS A RELAY? diff --git a/man/syncthing-rest-api.7 b/man/syncthing-rest-api.7 index 20679cd43..2bcfb487d 100644 --- a/man/syncthing-rest-api.7 +++ b/man/syncthing-rest-api.7 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "SYNCTHING-REST-API" "7" "Sep 30, 2023" "v1.24.0" "Syncthing" +.TH "SYNCTHING-REST-API" "7" "Oct 05, 2023" "v1.25.0" "Syncthing" .SH NAME syncthing-rest-api \- REST API .sp @@ -930,6 +930,15 @@ patterns to be used by default on folders, as an array of single\-line strings. .sp \fBGET\fP returns the respective object, \fBPUT\fP replaces the entire object and \fBPATCH\fP replaces only the given child objects. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +The \fI\%gui.password\fP configuration option has special handling to +accept already hashed passwords. Any valid bcrypt hash is stored verbatim, +while a plaintext password is first hashed. +.UNINDENT +.UNINDENT .SH CLUSTER ENDPOINTS .sp Concerns the mesh network structure. diff --git a/man/syncthing-security.7 b/man/syncthing-security.7 index 4ff9b1735..2c357fd20 100644 --- a/man/syncthing-security.7 +++ b/man/syncthing-security.7 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "SYNCTHING-SECURITY" "7" "Sep 30, 2023" "v1.24.0" "Syncthing" +.TH "SYNCTHING-SECURITY" "7" "Oct 05, 2023" "v1.25.0" "Syncthing" .SH NAME syncthing-security \- Security Principles .sp diff --git a/man/syncthing-stignore.5 b/man/syncthing-stignore.5 index 56f51755f..3b812fb8c 100644 --- a/man/syncthing-stignore.5 +++ b/man/syncthing-stignore.5 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "SYNCTHING-STIGNORE" "5" "Sep 30, 2023" "v1.24.0" "Syncthing" +.TH "SYNCTHING-STIGNORE" "5" "Oct 05, 2023" "v1.25.0" "Syncthing" .SH NAME syncthing-stignore \- Prevent files from being synchronized to other nodes .SH SYNOPSIS diff --git a/man/syncthing-versioning.7 b/man/syncthing-versioning.7 index d6a4e6e3d..9153f23e8 100644 --- a/man/syncthing-versioning.7 +++ b/man/syncthing-versioning.7 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "SYNCTHING-VERSIONING" "7" "Sep 30, 2023" "v1.24.0" "Syncthing" +.TH "SYNCTHING-VERSIONING" "7" "Oct 05, 2023" "v1.25.0" "Syncthing" .SH NAME syncthing-versioning \- Keep automatic backups of deleted files by other nodes .sp diff --git a/man/syncthing.1 b/man/syncthing.1 index a529de1cc..495ca10a2 100644 --- a/man/syncthing.1 +++ b/man/syncthing.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "SYNCTHING" "1" "Sep 30, 2023" "v1.24.0" "Syncthing" +.TH "SYNCTHING" "1" "Oct 05, 2023" "v1.25.0" "Syncthing" .SH NAME syncthing \- Syncthing .SH SYNOPSIS @@ -121,7 +121,11 @@ Generate key and config in specified dir, then exit. .TP .B \-\-gui\-address=<address> Override GUI listen address. Set this to an address (\fB0.0.0.0:8384\fP) -or file path (\fB/var/run/st.sock\fP, for UNIX sockets). +or a URL (\fBhttp://0.0.0.0:8384\fP). Supported schemes are \fBhttp\fP for +plain HTTP, \fBhttps\fP for HTTP over TLS, \fBunix\fP for plain Unix sockets +or \fBunixs\fP for TLS over Unix sockets. A Unix socket could look like this: +\fBunix:///run/syncthing/syncthing.socket\fP (notice the three slashes: two +as part of the URL structure, one to specify an absolute path). .UNINDENT .INDENT 0.0 .TP @@ -132,9 +136,10 @@ Override the API key needed to access the GUI / REST API. .TP .B \-\-gui\-password=<password|\-> Specify new GUI authentication password, to update the config file. Read -from the standard input stream if only a single dash (\fB\-\fP) is given. The -password is hashed before writing to the config file. As a special case, -giving the existing password hash as password will leave it untouched. +from the standard input stream if only a single dash (\fB\-\fP) is given. A +plaintext password is hashed before writing to the config file, but an +already bcrypt\-hashed input is stored verbatim. As a special case, giving +the existing password hash as password will leave it untouched. .UNINDENT .INDENT 0.0 .TP |