syncthingtray/README.md

65 lines
3.4 KiB
Markdown
Raw Normal View History

2016-08-25 00:45:32 +02:00
# Syncthing Tray
Qt 5-based tray application for [Syncthing](https://github.com/syncthing/syncthing)
* Designed to work under any desktop environment with tray icon support
2016-09-03 19:39:43 +02:00
* Tested under
* Plasma 5
* Openbox/qt5ct/Tint2
* Cinnamon
2016-09-01 16:34:30 +02:00
* Could be shown as regular window if no tray icon support is available
2016-08-25 00:45:32 +02:00
* Doesn't require desktop environment specific libraries
* Provides quick access to most frequently used features but does not intend to replace the official web UI
2016-09-01 16:34:30 +02:00
* Check state of directories and devices
* Check current traffic statistics
* Display further details about direcoties and devices, like last file, last
scan, ...
2016-09-03 19:39:43 +02:00
* Trigger re-scan of a specific directory or all directories at once
2016-09-01 16:34:30 +02:00
* Open a directory with the default file browser
2016-09-03 19:39:43 +02:00
* Pause/resume a specific device or all devices at once
2016-08-25 00:45:32 +02:00
* Shows Syncthing notifications
2016-09-01 16:34:30 +02:00
* Does *not* allow configuring Syncthing itself (currently I do not intend to add this feature as it could cause more harm than good when not implemented correctly)
2016-09-03 19:39:43 +02:00
* Can read the Syncthing configuration file for quick setup when just connecting to local instance
* Provides an option to conveniently add the tray to the applications launched when the desktop environment starts
* Can launch Syncthing when started and display stdout/stderr (useful under Windows)
2016-08-25 00:45:32 +02:00
* Provides quick access to the official web UI
* Utilizes either Qt WebKit or Qt WebEngine
* Can be built without web view support as well (then the web UI is opened in the regular browser)
2016-09-03 20:14:52 +02:00
* Allows quickly switching between multiple Syncthing instances
2016-09-01 16:34:30 +02:00
* Still under development; the following features are planned
2016-09-03 19:39:43 +02:00
* Show currently processed items
* Show recently processed items
2016-09-03 20:14:52 +02:00
* Improve notification handling
2016-08-25 00:45:32 +02:00
## Screenshots
2016-08-26 16:43:53 +02:00
### Under Openbox/Tint2
![Openbox/Tint2](/resources/screenshots/tint2.png?raw=true)
### Under Plasma 5 (dark color theme)
![Plasma 5](/resources/screenshots/plasma.png?raw=true)
### Settings dialog (dark color theme)
![Settings dialog](/resources/screenshots/settings.png?raw=true)
### Web view (dark color theme)
![Web view](/resources/screenshots/webview.png?raw=true)
2016-08-25 00:45:32 +02:00
## Download / binary repository
I will provide packages for Arch Linux and Windows when releasing. For more information checkout my
[website](http://martchus.no-ip.biz/website/page.php?name=programming).
## Build instructions
The application depends on [c++utilities](https://github.com/Martchus/cpp-utilities) and [qtutilities](https://github.com/Martchus/qtutilities) and is built the same way as these libaries. For basic instructions checkout the README file of [c++utilities](https://github.com/Martchus/cpp-utilities).
The following Qt 5 modules are requried: core network gui widgets svg webenginewidgets/webkitwidgets
2016-08-25 00:45:32 +02:00
#### Select Qt modules for WebView
* If Qt WebKitWidgets is installed on the system, the tray will link against it. Otherwise it will link against Qt WebEngineWidgets.
* To force usage of Qt WebKit/Qt WebEngine or to disable both add `-DWEBVIEW_PROVIDER=webkit/webengine/none` to the CMake arguments.
2016-09-01 16:34:30 +02:00
BTW: I still prefer the deprecated Qt WebKit because
* I currently don't know how to allow a particular self-signed certificate in Qt WebEngine. (Currently any self-signed certificate is accepted!)
* Qt WebEngine can not be built with mingw-w64.
* Qt WebEngine is more buggy in my experience.
* security issues are not a concern because no other website than the Syncthing web UI is shown.