Martchus
/
syncthingtray
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document the "Consider … status …" checkboxes; one still needs the re-connect 

See https://github.com/Martchus/syncthingtray/issues/79#issuecomment-716136144
This commit is contained in:
Martchus 2020-10-27 18:33:11 +01:00
parent a18ade7a36
commit dfe7091eb5
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -101,6 +101,7 @@ Syncthing installation. You might consider different configurations:
which you can consider to use. Keep in mind that automatic updates of Syncthing are not possible this way.
* In any case you can simply point the launcher to the binary of Syncthing (which you have to download/install
separately).
* Checkout the *Configuring the built-in launcher* section for further details.
* It is also possible to let Syncthing Tray connect to a Syncthing instance running on a different machine.
## Screenshots
@ -144,6 +145,12 @@ features are available:
However, these features are optional. To use them they must be enabled in the settings dialog
first.
It is recommended to enable "Consider unit status …". Note that Syncthing might still not be immediately
ready to serve API requests when the systemd unit turns active. Hence it is still required to configure
a re-connect interval. The re-connect interval will only be in effect while the systemd unit is active.
So despite the re-connect interval there will be no connection attempts while the systemd unit is
inactive. That's all the systemd integration can optimize in that regard.
Be aware that Syncthing Tray assumes by default that the systemd unit is a
[user unit](https://wiki.archlinux.org/index.php/Systemd/User). If you are using
a regular system-wide unit (including those started with `…@username`) you need to enable the
@ -182,6 +189,15 @@ alternative init systems do *not* need to provide differently configured version
Disabling the systemd integration is mainly intended for systems which do not use systemd at all (e.g.
Windows and MacOS).
## Configuring the built-in launcher
The built-in launcher can be accessed and configured within the settings dialog. The GUI should be
self-explaining.
It is recommended to enable "Consider process status …". Note that Syncthing might not be immediately
ready to serve API requests when started. Hence it is still required to configure a re-connect interval.
The re-connect interval will only be in effect while the Syncthing process is running. So despite the
re-connect interval there will be no connection attempts while the Syncthing process is not running.
## Hotkeys
Use the same approach as for launching an arbitrary application via a hotkey. Make it invoke