From 32e12df22dc3ea558a02fb4e9cf6b3299302c4a2 Mon Sep 17 00:00:00 2001 From: mfwadejr <125498560+mfwadejr@users.noreply.github.com> Date: Sun, 30 Aug 2026 09:06:45 -0400 Subject: [PATCH] Add ZimaOS install and container icon metadata --- CHANGELOG.md | 2 ++ README.md | 34 ++++++++++++++++++++++++++++++- docker-compose.yml | 2 ++ docker-compose.zimaos.yml | 42 +++++++++++++++++++++++++++++++++++++++ vboxstock-unraid.xml | 4 ++-- 5 files changed, 81 insertions(+), 3 deletions(-) create mode 100644 docker-compose.zimaos.yml diff --git a/CHANGELOG.md b/CHANGELOG.md index aa9bee4..e5efc18 100644 --- a/CHANGELOG.md +++ b/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 diff --git a/README.md b/README.md index 00a1379..f6f36c0 100644 --- a/README.md +++ b/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 `` 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: diff --git a/docker-compose.yml b/docker-compose.yml index 6509dc0..766bdc1 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,3 +1,5 @@ +name: vboxstock + services: vboxstock: image: ghcr.io/mfwadejr/vboxstock:latest diff --git a/docker-compose.zimaos.yml b/docker-compose.zimaos.yml new file mode 100644 index 0000000..f330718 --- /dev/null +++ b/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. diff --git a/vboxstock-unraid.xml b/vboxstock-unraid.xml index 837cbd2..a9245b4 100644 --- a/vboxstock-unraid.xml +++ b/vboxstock-unraid.xml @@ -2,8 +2,8 @@ vBoxStockghcr.io/mfwadejr/vboxstock:latesthttps://github.com/mfwadejr/vboxstock/pkgs/container/vboxstock bridgeshfalse - Self-contained vSeeBox inventory and sales tracker with an embedded SQLite database. - Tools:http://[IP]:[PORT:3000]/ + https://github.com/mfwadejr/vboxstock/issueshttps://github.com/mfwadejr/vboxstockSelf-contained vSeeBox inventory and sales tracker with an embedded SQLite database. + Tools:http://[IP]:[PORT:3000]/https://raw.githubusercontent.com/mfwadejr/vboxstock/main/vboxstock-unraid.xmlhttps://raw.githubusercontent.com/mfwadejr/vboxstock/main/public/assets/vboxstock-icon-512.png 3000 /mnt/user/appdata/vboxstock 99