felixfoertsch/syncthing
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

gui, man, authors: Update docs, translations, and contributors

Browse Source
This commit is contained in:
Jakob Borg
2021-01-27 07:45:21 +01:00
parent d7e86af6c6
commit 7c1ed420a9
19 changed files with 190 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/stdiscosrv.1
+6 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "STDISCOSRV" "1" "Jan 14, 2021" "v1" "Syncthing"
.TH "STDISCOSRV" "1" "Jan 25, 2021" "v1" "Syncthing"
.SH NAME
stdiscosrv \- Syncthing Discovery Server
.
@@ -124,6 +124,11 @@ Start this in whatever way you are most comfortable with; double clicking
should work in any graphical environment. At first start, stdiscosrv will
generate certificate files and database in the current directory unless
given flags to the contrary.
.sp
The discovery server can also be obtained through apt, the Debian/Ubuntu package
manager. Recent releases can be found at syncthing’s
\fI\%apt repository\fP <\fBhttps://apt.syncthing.net/\fP>\&. The name of the package is
syncthing\-discosrv.
.SS Configuring
.sp
\fBNOTE:\fP
man/strelaysrv.1
+17 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "STRELAYSRV" "1" "Jan 14, 2021" "v1" "Syncthing"
.TH "STRELAYSRV" "1" "Jan 25, 2021" "v1" "Syncthing"
.SH NAME
strelaysrv \- Syncthing Relay Server
.
@@ -146,6 +146,22 @@ An optional description about who provides the relay.
Listen address for status service (blank to disable) (default “:22070”).
Status service is used by the relay pool server UI for displaying stats (data transferred, number of clients, etc.)
.UNINDENT
.SS Installing
.sp
Go to \fI\%releases\fP <\fBhttps://github.com/syncthing/relaysrv/releases\fP> and
download the file appropriate for your operating system. Unpacking it will
yield a binary called \fBrelaysrv\fP (or \fBrelaysrv.exe\fP on Windows).
Start this in whatever way you are most comfortable with; double clicking
should work in any graphical environment. At first start, relaysrv will
generate certificate files and database in the current directory unless
given flags to the contrary. It will also join the default pools of relays,
which means that it is publicly visible and any client can connect to it.
The startup message prints instructions on how to change this.
.sp
The relay server can also be obtained through apt, the Debian/Ubuntu package
manager. Recent releases can be found at syncthing’s
\fI\%apt repository\fP <\fBhttps://apt.syncthing.net/\fP>\&. The name of the package is
syncthing\-relaysrv.
.SH SETTING UP
.sp
Primarily, you need to decide on a directory to store the TLS key and
man/syncthing-bep.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-BEP" "7" "Jan 14, 2021" "v1" "Syncthing"
.TH "SYNCTHING-BEP" "7" "Jan 25, 2021" "v1" "Syncthing"
.SH NAME
syncthing-bep \- Block Exchange Protocol v1
.
man/syncthing-config.5
+34 -8
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-CONFIG" "5" "Jan 14, 2021" "v1" "Syncthing"
.TH "SYNCTHING-CONFIG" "5" "Jan 25, 2021" "v1" "Syncthing"
.SH NAME
syncthing-config \- Syncthing Configuration
.
@@ -45,11 +45,16 @@ $HOME/Library/Application Support/Syncthing
.UNINDENT
.SH DESCRIPTION
.sp
Syncthing uses a single directory to store configuration, crypto keys
and index caches. The location defaults to \fB$HOME/.config/syncthing\fP
New in version 1.5.0: Database and config can now be set separately. Previously the database was
always located in the same directory as the config.
.sp
Syncthing uses a single directory to store configuration and crypto keys.
Syncthing also has a database, which is often stored in this directory too.
The config location defaults to \fB$HOME/.config/syncthing\fP
(Unix\-like), \fB$HOME/Library/Application Support/Syncthing\fP (Mac),
or \fB%LOCALAPPDATA%/Syncthing\fP (Windows). It can be changed at runtime
using the \fB\-home\fP flag. In this directory the following files are
using the \fB\-config\fP flag. In this directory the following files are
located:
.INDENT 0.0
.TP
@@ -64,14 +69,35 @@ device ID. The key must be kept private.
The certificate and key for HTTPS GUI connections. These may be replaced
with a custom certificate for HTTPS as desired.
.TP
.B \fBindex\-\fP\fI*\fP\fB\&.db\fP
A directory holding the database with metadata and hashes of the files
currently on disk and available from peers.
.TP
.B \fBcsrftokens.txt\fP
A list of recently issued CSRF tokens (for protection against browser cross
site request forgery).
.UNINDENT
.sp
The database is stored either in the same directory as the config (usually the
default), but may also be located in one of the following directories (Unix\-like
platforms only):
.INDENT 0.0
.IP \(bu 2
If a database exists in the old default location, that location is
still used.
.IP \(bu 2
If \fB$XDG_DATA_HOME\fP is set, use \fB$XDG_DATA_HOME/syncthing\fP\&.
.IP \(bu 2
If \fB~/.local/share/syncthing\fP exists, use that location.
.IP \(bu 2
Use the old default location (same as config).
.UNINDENT
.sp
The location of the database can be changed using the \fB\-data\fP flag. The
\fB\-home\fP flag sets both config and database locations at the same time.
The database contains the following files:
.INDENT 0.0
.TP
.B \fBindex\-\fP\fI*\fP\fB\&.db\fP
A directory holding the database with metadata and hashes of the files
currently on disk and available from peers.
.UNINDENT
.SH CONFIG FILE FORMAT
.sp
The following shows an example of the default configuration file (IDs will differ):
man/syncthing-device-ids.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-DEVICE-IDS" "7" "Jan 14, 2021" "v1" "Syncthing"
.TH "SYNCTHING-DEVICE-IDS" "7" "Jan 25, 2021" "v1" "Syncthing"
.SH NAME
syncthing-device-ids \- Understanding Device IDs
.
man/syncthing-event-api.7
+81 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-EVENT-API" "7" "Jan 14, 2021" "v1" "Syncthing"
.TH "SYNCTHING-EVENT-API" "7" "Jan 25, 2021" "v1" "Syncthing"
.SH NAME
syncthing-event-api \- Event API
.
@@ -213,6 +213,10 @@ Emitted when a device was paused.
.UNINDENT
.UNINDENT
.SS DeviceRejected
.sp
Deprecated since version v1.13.0: This event is still emitted for compatibility, but deprecated. Use
the replacement pending\-devices\-changed event instead.
.sp
Emitted when there is a connection from a device we are not configured
to talk to.
@@ -419,6 +423,10 @@ The statechanged event.
.UNINDENT
.UNINDENT
.SS FolderRejected
.sp
Deprecated since version v1.13.0: This event is still emitted for compatibility, but deprecated. Use
the replacement pending\-folders\-changed event instead.
.sp
Emitted when a device sends index information for a folder we do not
have, or have but do not share with the device in question.
@@ -725,6 +733,78 @@ is false and in any case the given username is returned.
.fi
.UNINDENT
.UNINDENT
.SS PendingDevicesChanged
.sp
New in version 1.14.0.
.sp
Emitted when pending devices were added / updated (connection from
unknown ID) or removed (device is ignored or added).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
"id": 87,
"type": "PendingDevicesChanged",
"time": "2020\-12\-22T22:24:37.578586718+01:00",
"data": {
"added": [
{
"address": "127.0.0.1:51807",
"device": "EJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK",
"name": "My dusty computer"
}
],
"removed": [
{
"device": "P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2"
}
]
}
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS PendingFoldersChanged
.sp
New in version 1.14.0.
.sp
Emitted when pending folders were added / updated (offered by some
device, but not shared to them) or removed (folder ignored or added or
no longer offered from the remote device).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
"id": 101,
"type": "PendingFoldersChanged",
"time": "2020\-12\-22T22:36:55.66744317+01:00",
"data": {
"added": [
{
"device": "EJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK",
"folder": "GXWxf\-3zgnU",
"folderLabel": "My Pictures"
}
],
"removed": [
{
"device": "P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2",
"folder": "neyfh\-sa2nu"
}
]
}
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS RemoteChangeDetected
.sp
Generated upon scan whenever a file is locally updated due to a remote change.
man/syncthing-faq.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-FAQ" "7" "Jan 14, 2021" "v1" "Syncthing"
.TH "SYNCTHING-FAQ" "7" "Jan 25, 2021" "v1" "Syncthing"
.SH NAME
syncthing-faq \- Frequently Asked Questions
.
man/syncthing-globaldisco.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-GLOBALDISCO" "7" "Jan 14, 2021" "v1" "Syncthing"
.TH "SYNCTHING-GLOBALDISCO" "7" "Jan 25, 2021" "v1" "Syncthing"
.SH NAME
syncthing-globaldisco \- Global Discovery Protocol v3
.
man/syncthing-localdisco.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-LOCALDISCO" "7" "Jan 14, 2021" "v1" "Syncthing"
.TH "SYNCTHING-LOCALDISCO" "7" "Jan 25, 2021" "v1" "Syncthing"
.SH NAME
syncthing-localdisco \- Local Discovery Protocol v4
.
man/syncthing-networking.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-NETWORKING" "7" "Jan 14, 2021" "v1" "Syncthing"
.TH "SYNCTHING-NETWORKING" "7" "Jan 25, 2021" "v1" "Syncthing"
.SH NAME
syncthing-networking \- Firewall Setup
.
man/syncthing-relay.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-RELAY" "7" "Jan 14, 2021" "v1" "Syncthing"
.TH "SYNCTHING-RELAY" "7" "Jan 25, 2021" "v1" "Syncthing"
.SH NAME
syncthing-relay \- Relay Protocol v1
.
man/syncthing-rest-api.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-REST-API" "7" "Jan 14, 2021" "v1" "Syncthing"
.TH "SYNCTHING-REST-API" "7" "Jan 25, 2021" "v1" "Syncthing"
.SH NAME
syncthing-rest-api \- REST API
.
man/syncthing-security.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-SECURITY" "7" "Jan 14, 2021" "v1" "Syncthing"
.TH "SYNCTHING-SECURITY" "7" "Jan 25, 2021" "v1" "Syncthing"
.SH NAME
syncthing-security \- Security Principles
.
man/syncthing-stignore.5
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-STIGNORE" "5" "Jan 14, 2021" "v1" "Syncthing"
.TH "SYNCTHING-STIGNORE" "5" "Jan 25, 2021" "v1" "Syncthing"
.SH NAME
syncthing-stignore \- Prevent files from being synchronized to other nodes
.
man/syncthing-versioning.7
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-VERSIONING" "7" "Jan 14, 2021" "v1" "Syncthing"
.TH "SYNCTHING-VERSIONING" "7" "Jan 25, 2021" "v1" "Syncthing"
.SH NAME
syncthing-versioning \- Keep automatic backups of deleted files by other nodes
.
man/syncthing.1
+1 -1
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING" "1" "Jan 14, 2021" "v1" "Syncthing"
.TH "SYNCTHING" "1" "Jan 25, 2021" "v1" "Syncthing"
.SH NAME
syncthing \- Syncthing
.