History

Jakob Borg 5788ad2529 Reassign copyright to the Syncthing Authors		2021-02-10 13:58:51 +01:00
..
e2e	Move all into newgui/	2021-02-10 13:58:08 +01:00
src	Move all into newgui/	2021-02-10 13:58:08 +01:00
.editorconfig	Move all into newgui/	2021-02-10 13:58:08 +01:00
.gitignore	Move all into newgui/	2021-02-10 13:58:08 +01:00
LICENSE	Move all into newgui/	2021-02-10 13:58:08 +01:00
README.md	Reassign copyright to the Syncthing Authors	2021-02-10 13:58:51 +01:00
angular.json	Move all into newgui/	2021-02-10 13:58:08 +01:00
browserslist	Move all into newgui/	2021-02-10 13:58:08 +01:00
karma.conf.js	Move all into newgui/	2021-02-10 13:58:08 +01:00
package-lock.json	Move all into newgui/	2021-02-10 13:58:08 +01:00
package.json	Move all into newgui/	2021-02-10 13:58:08 +01:00
screenshot.png	Move all into newgui/	2021-02-10 13:58:08 +01:00
tsconfig.app.json	Move all into newgui/	2021-02-10 13:58:08 +01:00
tsconfig.json	Move all into newgui/	2021-02-10 13:58:08 +01:00
tsconfig.spec.json	Move all into newgui/	2021-02-10 13:58:08 +01:00
tslint.json	Move all into newgui/	2021-02-10 13:58:08 +01:00

README.md

Syncthing Tech UI

Usage

This is a very bare bones read-only GUI for viewing the status of large setups. Download a release zip and unpack it into the GUI override directory (assuming default Linux setup):

$ cd ~/.config/syncthing
$ mkdir -p gui/default
$ cd gui/default
$ unzip ~/tech-ui-v1.0.0.zip

Then load the GUI via http://localhost:8384/tech-ui/ or similar. You should see something like this:

Development server

Run npm run serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Production server

In production we serve the UI through Syncthing itself. The easiest way to do that is to simply put the built assets in the gui subdirectory of Syncthing's config directory.

$ npm run build -- --prod
$ rsync -va --delete dist/tech-ui/ ~/.config/syncthing/gui/default/tech-ui/

Adjust for your actual Syncthing config dir if different. Navigate to http://localhost:8384/tech-ui/.

Another option is to start Syncthing with the STGUIASSETS environment variable pointing to the distribution directory.

$ npm run build -- --prod
$ ln -sf . dist/default
$ export STGUIASSETS=$(pwd)/dist
$ syncthing

The magic is symlink is because Syncthing will look for the GUI in the default subdirectory. Navigate to http://localhost:8384/tech-ui/.

Code scaffolding

License

MPLv2