Add ZimaOS install and container icon metadata

CHANGELOG.md

@@ -9,6 +9,8 @@
 - Added automatic pre-migration database backups for upgrades from the fixed model list.
 - Added responsive, light, and dark theme styling for model management.
 - Added API and migration regression coverage.
+- Added a ZimaOS-specific Compose definition with project metadata, persistent storage defaults, and dashboard icon.
+- Added the canonical container icon URL to the ZimaOS and Unraid templates and installation documentation.
 
 ## 3.0.2
 

README.md

@@ -89,12 +89,14 @@ The host path mounted at `/data` is essential. Removing the container is safe wh
 
 ## Docker Compose
 
-The included `docker-compose.yml` stores data in `./data` alongside the Compose file:
+The included `docker-compose.yml` has the explicit project name `vboxstock` and stores data in `./data` alongside the Compose file:
 
 ```sh
 docker compose up -d
 ```
 
+The `docker run` example above is a terminal command. Do not paste it into a Compose or YAML editor; use the Compose file instead.
+
 To update later:
 
 ```sh
@@ -102,6 +104,36 @@ docker compose pull
 docker compose up -d
 ```
 
+## ZimaOS
+
+Use [`docker-compose.zimaos.yml`](docker-compose.zimaos.yml) with ZimaOS's custom app/Compose installer. It includes the required `vboxstock` project name, ZimaOS dashboard metadata, the application icon, and a persistent data mapping to `/DATA/AppData/vboxstock`.
+
+If entering the configuration manually, replace any ZimaOS-generated `<your project name>` placeholder with `vboxstock`. The angle brackets and placeholder text must not remain in the saved YAML. Do not paste the `docker run` command into the YAML editor.
+
+ZimaOS settings:
+
+| Setting | Value |
+| --- | --- |
+| Project name | `vboxstock` |
+| Image | `ghcr.io/mfwadejr/vboxstock:latest` |
+| WebUI port | `3000` |
+| Container data path | `/data` |
+| ZimaOS host path | `/DATA/AppData/vboxstock` |
+| PUID | `1000` |
+| PGID | `1000` |
+
+After installation, open `http://YOUR-ZIMAOS-IP:3000`. The ZimaOS-specific Compose file supplies the icon automatically through its `x-casaos` metadata.
+
+## Container icon
+
+Use this direct PNG URL in ZimaOS, Unraid, Portainer, or another container dashboard that accepts a custom icon:
+
+```text
+https://raw.githubusercontent.com/mfwadejr/vboxstock/main/public/assets/vboxstock-icon-512.png
+```
+
+The included ZimaOS Compose file and Unraid XML template already contain this URL.
+
 ## Unraid
 
 Use the included `vboxstock-unraid.xml` template or create a container with these settings:

docker-compose.yml

@@ -1,3 +1,5 @@
+name: vboxstock
+
 services:
   vboxstock:
     image: ghcr.io/mfwadejr/vboxstock:latest

docker-compose.zimaos.yml

@@ -0,0 +1,42 @@
+name: vboxstock
+
+services:
+  vboxstock:
+    image: ghcr.io/mfwadejr/vboxstock:latest
+    container_name: vboxstock
+    restart: unless-stopped
+    ports:
+      - target: 3000
+        published: "3000"
+        protocol: tcp
+    volumes:
+      - type: bind
+        source: /DATA/AppData/vboxstock
+        target: /data
+    environment:
+      TZ: America/New_York
+      PUID: "1000"
+      PGID: "1000"
+
+x-casaos:
+  id: com.mfwadejr.vboxstock
+  main: vboxstock
+  index: /
+  port_map: "3000"
+  scheme: http
+  icon: https://raw.githubusercontent.com/mfwadejr/vboxstock/main/public/assets/vboxstock-icon-512.png
+  title:
+    en_US: vBoxStock
+  tagline:
+    en_US: Self-hosted vSeeBox inventory and sales tracking
+  description:
+    en_US: Track individually identifiable vSeeBox inventory from receipt through sale, including customers, payments, shipping, notes, users, and backups.
+  author: mfwadejr
+  developer: mfwadejr
+  category: Productivity
+  architectures:
+    - amd64
+  version: "3.1.0"
+  update_at: "2026-08-30"
+  release_notes:
+    en_US: Added administrator-managed product models with archival and historical preservation.

vboxstock-unraid.xml

@@ -2,8 +2,8 @@
 <Container version="2">
   <Name>vBoxStock</Name><Repository>ghcr.io/mfwadejr/vboxstock:latest</Repository><Registry>https://github.com/mfwadejr/vboxstock/pkgs/container/vboxstock</Registry>
   <Network>bridge</Network><Shell>sh</Shell><Privileged>false</Privileged>
-  <Support></Support><Project></Project><Overview>Self-contained vSeeBox inventory and sales tracker with an embedded SQLite database.</Overview>
+  <Support>https://github.com/mfwadejr/vboxstock/issues</Support><Project>https://github.com/mfwadejr/vboxstock</Project><Overview>Self-contained vSeeBox inventory and sales tracker with an embedded SQLite database.</Overview>
-  <Category>Tools:</Category><WebUI>http://[IP]:[PORT:3000]/</WebUI><TemplateURL></TemplateURL><Icon></Icon>
+  <Category>Tools:</Category><WebUI>http://[IP]:[PORT:3000]/</WebUI><TemplateURL>https://raw.githubusercontent.com/mfwadejr/vboxstock/main/vboxstock-unraid.xml</TemplateURL><Icon>https://raw.githubusercontent.com/mfwadejr/vboxstock/main/public/assets/vboxstock-icon-512.png</Icon>
   <Config Name="Web UI Port" Target="3000" Default="3000" Mode="tcp" Description="vBoxStock web interface" Type="Port" Display="always" Required="true" Mask="false">3000</Config>
   <Config Name="App Data" Target="/data" Default="/mnt/user/appdata/vboxstock" Mode="rw" Description="SQLite database and durable application data" Type="Path" Display="always" Required="true" Mask="false">/mnt/user/appdata/vboxstock</Config>
   <Config Name="User ID" Target="PUID" Default="99" Mode="" Description="Host user ID used to own and write application data. Unraid default is 99 (nobody)." Type="Variable" Display="advanced" Required="true" Mask="false">99</Config>