Skip to main content

Frontend File Specification

Applicable to WebUI applications (both internal and external open).

Frontend source code may be placed in the project source directory:

webui/
├── index.html
├── app.js
└── styles.css

It must be compressed into webui.bz2 for packaging, with the installation path:

/usr/local/<app_id>/webui.bz2

Requirements:

  1. After decompression, webui.bz2 must contain a properly openable .html file.
  2. At least index.html, app.js, styles.css are recommended.
  3. The frontend page should initialize to an empty state each time it is opened, and should not reuse temporary input state from the previous session.
  4. Frontend resource references should include version parameters to avoid loading stale caches after application upgrades.
<link rel="stylesheet" href="./styles.css?v=<version>">
<script src="./app.js?v=<version>"></script>