Components#
Main Process#
The Main Process is the core of the disco app, it:x
- controls the App Window
- reads from and writes to the db.json file
- provides the WebUI via HTTPS
- provides the REST API via HTTP/HTTPS
- communicates with Plugins
App Window#
The App Window displays the Current View or the Info screen. it communicates via IPC with and is controlled by the Main Process
db.json#
All data of your disco instance, like settings, GlobalParameters or Views, is stored in the db.json file. Since it is just a normal file you can copy or backup it as a normal file. You can even easily check it into a version-control system like git or similar.
The default location for the file depends on the host OS:
- Linux:
/home/<USER>/.config/disco/db.json - macOS:
/Users/<USER>/Library/Application\ Support/disco/db.json - Windows:
%APPDATA%\disco\db.json
❗ Manually editing the file instead of using the WebUI is NOT recommended.
WebUI#
The WebUI is provided by the Main Process via HTTPS. With the WebUI you can for example:
- configure your disco instance
- add, edit or delete Views
- select the Current View
- restart the app
To configure your disco instance you just need a working network connection to the app host and use any web browser.
❗ To work as intended it is strongly recommended to use a up-to-date version of Google Chrome (Version 80 or later). Other browsers may work, but there is no support.
REST API#
The REST-API is for integrating with other applications or systems. Since th WebUI also just uses the REST API nearly everything what you can do in the WebUI can be done via the REST API, but with less guidance.
ℹ️ A more detailed description of what is possible with REST API is given in the Reference.
Plugins#
Plugins are for working with both, View parameters and GlobalParameters. They can adapt the internal parameters to third-party protocols (i.e EmBER+) or systems but also connect them logically. They can even do both.
❗ Plugins are only available in the Full edition of disco.
ℹ️ If you are interested in purchasing standard plugins or even get a vustom plugin developed for your needs, please contact Treetop.