update sdk to beta.26 / minor improvements

Author: remcoros

Makefile

@@ -27,10 +27,22 @@ check-init:
 ingredients: $(INGREDIENTS)
 	@echo "Re-evaluating ingredients..."
 
-${PACKAGE_ID}.s9pk: $(INGREDIENTS) | check-deps check-init
+${PACKAGE_ID}.s9pk: $(INGREDIENTS) $(shell git ls-files assets) | check-deps check-init
 	@$(MAKE) --no-print-directory ingredients
 	start-cli s9pk pack
 
+x86: $(INGREDIENTS) $(shell git ls-files assets) | check-deps check-init
+	@$(MAKE) --no-print-directory ingredients
+	BUILD=x86 start-cli s9pk pack
+	@echo " Done!"
+	@echo " Filesize:$(shell du -h $(PACKAGE_ID).s9pk) is ready"
+
+arm: $(INGREDIENTS) $(shell git ls-files assets) | check-deps check-init
+	@$(MAKE) --no-print-directory ingredients
+	BUILD=arm start-cli s9pk pack
+	@echo " Done!"
+	@echo " Filesize:$(shell du -h $(PACKAGE_ID).s9pk) is ready"
+
 javascript/index.js: $(shell git ls-files startos) tsconfig.json node_modules package.json
 	npm run build
 

README.md

@@ -9,16 +9,18 @@ It includes a preconfigured dashboard for monitoring your Bitaxes. This package
 
 This repository creates the `s9pk` package that is installed to run AxeOS Monitor on [StartOS](https://github.com/Start9Labs/start-os/). Learn more about service packaging in the [Developer Docs](https://start9.com/latest/developer-docs/).
 
+<p align="center">
+  <img src="axeos-monitor-preview.png" alt="Project Logo" width="100%">
+</p>
+
 ## Dependencies
 
 Install the system dependencies below to build this project by following the instructions in the provided links. You can also find detailed steps to setup your environment in the service packaging [documentation](https://docs.start9.com/latest/developer-docs/packaging#development-environment).
 
 - [docker](https://docs.docker.com/get-docker)
 - [docker-buildx](https://docs.docker.com/buildx/working-with-buildx/)
-- [yq](https://mikefarah.gitbook.io/yq)
-- [deno](https://deno.land/)
 - [make](https://www.gnu.org/software/make/)
-- [start-sdk](https://github.com/Start9Labs/start-os/tree/sdk)
+- [start-cli](https://github.com/Start9Labs/start-os/)
 
 ## Cloning
 
@@ -37,21 +39,9 @@ To build the service as a universal package, run the following command:
 make
 ```
 
-Alternatively the package can be built for individual architectures by specifying the architecture as follows:
-
-```
-make x86
-```
-
-or
-
-```
-make arm
-```
-
 ## Installing (on StartOS)
 
-Before installation, define `host: https://server-name.local` in your `~/.embassy/config.yaml` config file then run the following commands to determine successful install:
+Before installation, define `host: https://server-name.local` in your `~/.startos/config.yaml` config file then run the following commands to determine successful install:
 
 > Change server-name.local to your Start9 server address
 
@@ -61,7 +51,7 @@ start-cli auth login
 make install
 ```
 
-**Tip:** You can also install the axeos-monitor-aio-startos.s9pk by sideloading it under the **StartOS > System > Sideload a Service** section.
+**Tip:** You can also install the axeos-monitor-aio.s9pk by sideloading it under the **StartOS > System > Sideload a Service** section.
 
 ## Verify Install
 

assets/grafana/dashboards/axeos.json

@@ -7,7 +7,7 @@
           "type": "grafana",
           "uid": "-- Grafana --"
         },
-        "enable": false,
+        "enable": true,
         "hide": true,
         "iconColor": "rgba(0, 211, 255, 1)",
         "name": "Annotations & Alerts",
@@ -3030,7 +3030,7 @@
     ]
   },
   "time": {
-    "from": "now-5m",
+    "from": "now-1h",
     "to": "now"
   },
   "timepicker": {},

assets/grafana/provisioning/dashboards/dashboards.yml

@@ -14,7 +14,7 @@ providers:
     # <bool> disable dashboard deletion
     disableDeletion: false
     # <int> how often Grafana will scan for changed dashboards
-    updateIntervalSeconds: 10
+    updateIntervalSeconds: 600
     # <bool> allow updating provisioned dashboards from the UI
     allowUiUpdates: false
     options:

axeos-monitor-preview.png

@@ -2,3 +2,15 @@
 
 The default username/password is 'admin/admin'. You will be asked to change this password when you first login.
 **Save this password in your password manager, you will not be able to recover it.**
+
+# Customize the default Dashboard
+
+AxeOS Monitor comes with a default dashboard that already has some useful widgets. You can customize this dashboard by adding or removing widgets, or by creating your own custom widgets.
+
+Note that the default dashboard cannot be saved and serves as a template for creating your own dashboards. This default dashboard will be reset and overwritten when you upgrade or reinstall AxeOS Monitor.
+
+If you want to customize the default dashboard, you should save it as a new dashboard. To do this, click on the "Edit" button in the top right corner of the dashboard, then "Save as copy". You will be prompted to enter a name for your new dashboard. Once you have saved your new dashboard, you can customize it as you like.
+
+# Set your home dashboard
+
+To set your newly copied dashboard as your default home dashboard, go to your profile (click the icon in the top right of the screen). Here you can select your new dashboard from the "Home Dashboard" dropdown menu. This will set your new dashboard as the default dashboard that is displayed when you log in.

instructions.md

@@ -6,7 +6,7 @@
     "check": "tsc --noEmit"
   },
   "dependencies": {
-    "@start9labs/start-sdk": "^0.4.0-beta.25"
+    "@start9labs/start-sdk": "^0.4.0-beta.26"
   },
   "devDependencies": {
     "@types/node": "^22.1.0",

package-lock.json

@@ -78,6 +78,7 @@ export const main = sdk.setupMain(async ({ effects, started }) => {
   )
 
   // Fix file permissions
+  exec(`chown -R 472:0 ${grafanaSubcontainer.rootfs}/assets`)
   exec(`chown -R 472:0 ${grafanaSubcontainer.rootfs}/var/lib/grafana`)
   exec(`chown -R 472:0 ${grafanaSubcontainer.rootfs}/etc/grafana`)
 
@@ -89,21 +90,9 @@ export const main = sdk.setupMain(async ({ effects, started }) => {
   exec(`chmod g+w ${jsonExporterSubcontainer.rootfs}/config`)
 
   // grafana provisioning
-  await ensureFileExists(
-    grafanaSubcontainer,
-    '/assets/provisioning/datasources/prometheus.yml',
-    '/etc/grafana/provisioning/datasources/prometheus.yml',
-  )
-  // await ensureFileExists(
-  //   grafanaSubcontainer,
-  //   '/assets/provisioning/dashboards/dashboards.yml',
-  //   '/etc/grafana/provisioning/dashboards/dashboards.yml',
-  // )
-
-  // add/update default axeos dashboard
-  const src = grafanaSubcontainer.rootfs + '/assets/dashboards/axeos.json'
-  const dst = grafanaSubcontainer.rootfs + '/etc/grafana/dashboards/axeos.json'
-  exec(`cp ${src} ${dst} && chown 472:0 ${dst}`)
+  exec(`cp ${grafanaSubcontainer.rootfs}/assets/provisioning/datasources/prometheus.yml ${grafanaSubcontainer.rootfs}/etc/grafana/provisioning/datasources/prometheus.yml`)
+  exec(`cp ${grafanaSubcontainer.rootfs}/assets/provisioning/dashboards/dashboards.yml ${grafanaSubcontainer.rootfs}/etc/grafana/provisioning/dashboards/dashboards.yml`)
+  exec(`cp ${grafanaSubcontainer.rootfs}/assets/dashboards/axeos.json ${grafanaSubcontainer.rootfs}/etc/grafana/dashboards/axeos.json`)
 
   const healthReceipts: T.HealthCheck[] = []
 

package.json

@@ -1,4 +1,15 @@
 import { setupManifest } from '@start9labs/start-sdk'
+import { SDKImageInputSpec } from '@start9labs/start-sdk/base/lib/types/ManifestTypes'
+
+// the following allows us to build the service for x86 or arm64 specifically
+// use: 'make x86' or 'make arm' ('make' will build both)
+const BUILD = process.env.BUILD || ''
+const arch =
+  BUILD === 'x86'
+    ? ['x86_64']
+    : BUILD === 'arm'
+      ? ['aarch64']
+      : ['x86_64', 'aarch64']
 
 export const manifest = setupManifest({
   id: 'axeos-monitor-aio',
@@ -16,23 +27,23 @@ export const manifest = setupManifest({
   volumes: ['grafana', 'prometheus'],
   images: {
     grafana: {
-      arch: ['x86_64'],
+      arch: arch,
       source: {
         dockerTag: 'grafana/grafana-oss:12.0.1',
       },
-    },
+    } as SDKImageInputSpec,
     prometheus: {
-      arch: ['x86_64'],
+      arch: arch,
       source: {
         dockerTag: 'prom/prometheus:v3.4.1',
       },
-    },
+    } as SDKImageInputSpec,
     'json-exporter': {
-      arch: ['x86_64'],
+      arch: arch,
       source: {
         dockerTag: 'prometheuscommunity/json-exporter:v0.7.0',
       },
-    },
+    } as SDKImageInputSpec,
   },
   hardwareRequirements: {},
   alerts: {