home-hosted 0.6.0 → 0.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -25,17 +25,48 @@ care what your UI looks like.
25
25
  $HHOSTED_HOME/.ui/ ← where your build lives
26
26
  index.html ← required, at the root
27
27
  assets/…
28
- ui.json ← optional: { "name": "my-panel", "version": "2.1.0" }
28
+ ui.json ← optional, but see below
29
29
  ```
30
30
 
31
31
  **Settings → Interface** → pick a `.zip` → *Install UI* (refresh to see it). Or drop the files into
32
32
  `$HHOSTED_HOME/.ui` yourself. The zip may hold the files at its root or inside one wrapper directory
33
- (`zip -r ui.zip dist` works too). `ui.json` is optional; it is what the settings page shows as
34
- installed.
33
+ (`zip -r ui.zip dist` works too).
35
34
 
36
35
  Without the settings page, `home-hosted ui-switch` installs one from a GitHub release asset (its
37
36
  default), from a local `.zip` (`--file ./ui.zip`), or from a URL (`--file https://…/ui.zip`).
38
37
 
38
+ ### `ui.json`
39
+
40
+ Optional, and everything in it is optional — but it is what lets the panel tell you what is
41
+ installed, and what lets it offer you the next version:
42
+
43
+ ```json
44
+ {
45
+ "name": "my-panel",
46
+ "version": "2.1.0",
47
+ "repo": "you/my-panel",
48
+ "tag": "v2.1.0",
49
+ "asset": "my-panel.zip",
50
+ "unix": 1790366625
51
+ }
52
+ ```
53
+
54
+ | field | |
55
+ | --- | --- |
56
+ | `name`, `version` | what Settings shows as installed |
57
+ | `repo` | `owner/name` the releases come from — the one field `ui-update` needs |
58
+ | `tag` | the release this build came from, so an update can tell newer from older |
59
+ | `asset` | the release asset name, when a release carries more than one UI |
60
+ | `unix` | when the build was made, in epoch seconds |
61
+
62
+ With those set, `home-hosted ui-update` lists the releases carrying your `asset` and installs the one
63
+ you pick; `--old` lists older ones. A version bump in your own repo is enough — nothing about the
64
+ panel is involved.
65
+
66
+ > **Official UIs** (`repo: NamesMT/home-hosted`) are paired with the panel instead: the panel knows
67
+ > its own release, so `home-hosted ui-update` installs the matching tag without asking, and
68
+ > upgrading the panel re-pairs the UI on the next `up`.
69
+
39
70
  Nothing is built on the server side: whatever you upload is served as-is, so ship plain
40
71
  HTML/JS/CSS or the output of your own Vite/Next/Astro build with relative asset paths.
41
72
 
@@ -204,4 +235,4 @@ the panel on 3999 and a Vite dev server on 3998 with `/api` proxied — point yo
204
235
  - [ ] deep links render (the server falls back to `index.html`)
205
236
  - [ ] assets self-hosted, no CDN
206
237
  - [ ] works over plain http on a LAN
207
- - [ ] `ui.json` with a name and version, so Settings can tell you what is installed
238
+ - [ ] `ui.json` with a name and version, so Settings can tell you what is installed — plus `repo`/`tag`/`asset` if you want `ui-update` to follow your releases
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "home-hosted",
3
3
  "type": "module",
4
- "version": "0.6.0",
4
+ "version": "0.6.2",
5
5
  "packageManager": "pnpm@12.5.1",
6
6
  "description": "A self-hosted control panel that keeps your home server processes alive - with a UI you can replace.",
7
7
  "author": "NamesMT <dangquoctrung123@gmail.com>",