From dfe7091eb5d2f2b618c4dd37ba07cbdbd80a7909 Mon Sep 17 00:00:00 2001 From: Martchus Date: Tue, 27 Oct 2020 18:33:11 +0100 Subject: [PATCH] =?UTF-8?q?Document=20the=20"Consider=20=E2=80=A6=20status?= =?UTF-8?q?=20=E2=80=A6"=20checkboxes;=20one=20still=20needs=20the=20re-co?= =?UTF-8?q?nnect?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/Martchus/syncthingtray/issues/79#issuecomment-716136144 --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 7fd28a9..860a15d 100644 --- a/README.md +++ b/README.md @@ -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