chore(v5): rename PiOSK to XiOSK (#149)

parthsidpara · web-flow · commit ba0075938c00 · 2025-12-19T23:35:24.000+05:30
* rename system services

* refactor(scripts): rename PiOSK to XiOSK

* refactor(dashboard): rename PiOSK to XiOSK in dashboard files

* refactor(workflow): rename binary and package in the build and release workflow

* refactor(services): rename paths in services to XiOSK

* rename: update root level files- readme, gitignore
diff --git a/.github/workflows/build-release.yml b/.github/workflows/build-release.yml
@@ -1,4 +1,4 @@
-name: Build and Release PiOSK Package
+name: Build and Release XiOSK Package
 
 on:
   push:
@@ -35,7 +35,7 @@ jobs:
             --allow-run \
             --allow-env \
             --target ${{ matrix.arch }}-unknown-linux-gnu \
-            --output piosk \
+            --output xiosk \
             dashboard/index.ts
 
       - name: Assemble Release Package
@@ -47,17 +47,17 @@ jobs:
           cp -r dashboard/ scripts/ services/ config.json.sample staging/
 
           # 3. Move the compiled binary into the 'dashboard' subdirectory inside staging.
-          mv piosk staging/dashboard/
+          mv xiosk staging/dashboard/
 
           # 4. Create the final tarball from the contents of the staging directory.
           #    The -C flag ensures the paths inside the tarball are clean (no leading 'staging/').
-          tar -czf piosk-linux-${{ matrix.arch }}.tar.gz -C staging .
+          tar -czf xiosk-linux-${{ matrix.arch }}.tar.gz -C staging .
 
       - name: Upload Package as Artifact
         uses: actions/upload-artifact@v4
         with:
-          name: piosk-package-${{ matrix.arch }}
-          path: piosk-linux-${{ matrix.arch }}.tar.gz
+          name: xiosk-package-${{ matrix.arch }}
+          path: xiosk-linux-${{ matrix.arch }}.tar.gz
           if-no-files-found: error # Fail if the package wasn't created
 
   release:
diff --git a/.gitignore b/.gitignore
@@ -3,9 +3,9 @@ node_modules/
 package-lock.json
 
 # Deno compiled binaries
-piosk
-piosk.exe
-piosk-*
+xiosk
+xiosk.exe
+xiosk-*
 
 # Test files
 test.sh
diff --git a/README.md b/README.md
@@ -1,20 +1,20 @@
-![PiOSK Banner](www/src/assets/banner.png)
-**PiOSK - One-shot set up Raspberry Pi in kiosk mode as a webpage shuffler, with a web interface for management.**
+![XiOSK Banner](www/src/assets/banner.png)
+**XiOSK - One-shot set up Raspberry Pi in kiosk mode as a webpage shuffler, with a web interface for management.**
 
 ### Links
-- [Docs](https://code.debs.io/piosk/docs/)
-- [GitHub](https://github.com/debloper/piosk/)
-- [Discussion](https://github.com/debloper/piosk/discussions)
+- [Docs](https://code.debs.io/xiosk/docs/)
+- [GitHub](https://github.com/debloper/xiosk/)
+- [Discussion](https://github.com/debloper/xiosk/discussions)
 
 ### Installation
 ```bash
-curl -sSL https://raw.githubusercontent.com/debloper/piosk/v4.0.1/scripts/setup.sh | sudo bash -
+curl -sSL https://raw.githubusercontent.com/debloper/xiosk/v4.0.1/scripts/setup.sh | sudo bash -
 ```
-> **Note:** For a detailed installation guide, refer to the official PiOSK [documentation](https://code.debs.io/piosk/docs/).
+> **Note:** For a detailed installation guide, refer to the official XiOSK [documentation](https://code.debs.io/xiosk/docs/).
 
 ### Developer
 ```bash
-git clone https://github.com/debloper/piosk.git
-cd piosk
+git clone https://github.com/debloper/xiosk.git
+cd xiosk
 ```
 
diff --git a/dashboard/deno.json b/dashboard/deno.json
@@ -3,7 +3,7 @@
   "exports": "./index.ts",
   "tasks": {
     "start": "deno run --allow-net --allow-read --allow-write --allow-run --allow-env index.ts",
-    "compile": "deno compile --allow-net --allow-read --allow-write --allow-run --allow-env --output piosk index.ts"
+    "compile": "deno compile --allow-net --allow-read --allow-write --allow-run --allow-env --output xiosk index.ts"
   },
   "compilerOptions": {
     "strict": true,
diff --git a/dashboard/index.html b/dashboard/index.html
@@ -6,14 +6,14 @@
 
     <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH" crossorigin="anonymous">
     <link rel="stylesheet" href="style.css">
-    <title>PiOSK</title>
+    <title>XiOSK</title>
   </head>
   <body>
     <nav id="navs" class="navbar bg-body-tertiary py-3">
       <div class="container-md">
         <div class="row w-100 align-items-center gy-2 mx-0">      
           <div class="col-12 col-md-auto text-center text-md-start px-0">
-            <h1 class="my-0">Pi<span class="bg-danger mx-1 px-1 rounded">OSK</span></h1>
+            <h1 class="my-0">Χi<span class="bg-danger mx-1 px-1 rounded">OSK</span></h1>
           </div>
           <div class="col-12 col-md px-md-4">
             <div class="input-group">
@@ -34,7 +34,7 @@ <h1 class="my-0">Pi<span class="bg-danger mx-1 px-1 rounded">OSK</span></h1>
     </div>
 
     <footer id="colophon" class="container-md text-center fs-4 my-5">
-      <kbd><a class="text-decoration-none" href="https://github.com/debloper/piosk" target="_blank">{}</a></kbd>
+      <kbd><a class="text-decoration-none" href="https://github.com/debloper/xiosk" target="_blank">{}</a></kbd>
       w/
       <kbd><a class="text-decoration-none" href="https://youtube.com/@BreakerSpace" target="_blank"><3</a></kbd>
       by
diff --git a/dashboard/index.ts b/dashboard/index.ts
@@ -17,11 +17,11 @@ async function writeConfig(configData: string): Promise<void> {
 }
 
 async function getServiceStatus(): Promise<boolean> {
-  if(Deno.env.get("PIOSK_TEST_MODE") === "true") return true;
+  if(Deno.env.get("XIOSK_TEST_MODE") === "true") return true;
 
   try {
     const command = new Deno.Command("systemctl", {
-      args: ["is-active", "piosk-runner.service"]
+      args: ["is-active", "xiosk-runner.service"]
     });
 
     const { code } = await command.output();
@@ -33,9 +33,9 @@ async function getServiceStatus(): Promise<boolean> {
 }
 
 async function invokeService(action: "start" | "stop" | "restart"): Promise<void> {
-  const services = ["piosk-runner.service", "piosk-switcher.service"];
+  const services = ["xiosk-runner.service", "xiosk-switcher.service"];
 
-  if (Deno.env.get("PIOSK_TEST_MODE") === "true") {
+  if (Deno.env.get("XIOSK_TEST_MODE") === "true") {
     console.log(`Test mode: Would ${action.toUpperCase()} services: ${services.join(", ")}`);
     return;
   }
@@ -168,7 +168,7 @@ async function handler(req: Request): Promise<Response> {
 }
 
 const port = parseInt(Deno.env.get("PORT") || "80");
-console.log(`PiOSK Deno server starting on port ${port}...`);
+console.log(`XiOSK Deno server starting on port ${port}...`);
 
 Deno.serve({ port }, handler);
 
diff --git a/dashboard/script.js b/dashboard/script.js
@@ -1,10 +1,10 @@
-let piosk = {
+let xiosk = {
   addNewUrl() {
     let newUrl = $('#new-url').val();
     if (!newUrl) return;
 
     // Call appendUrl with just the URL, so it uses default settings (10s, 10 cycles)
-    piosk.appendUrl(newUrl); 
+    xiosk.appendUrl(newUrl); 
     $('#new-url').val('');
   },
 
@@ -30,7 +30,7 @@ let piosk = {
     if (data && data.urls) {
       $.each(data.urls, (index, item) => {
         // Pass all the data (url, duration, cycles) to the updated function
-        piosk.appendUrl(item.url, item.duration, item.cycles);
+        xiosk.appendUrl(item.url, item.duration, item.cycles);
       });
     }
   },
@@ -68,7 +68,7 @@ let piosk = {
   checkStatus() {
     $.getJSON('/services/status')
       .done((data) => {
-        piosk.updatePowerBtn(data.running);
+        xiosk.updatePowerBtn(data.running);
       })
       .fail(() => {
         if (!$('#toggle-kiosk').prop('disabled')) {
@@ -93,14 +93,14 @@ let piosk = {
 
 $(document).ready(() => {
   $.getJSON('/config')
-    .done(piosk.renderPage)
-    .fail(piosk.showStatus);
+    .done(xiosk.renderPage)
+    .fail(xiosk.showStatus);
 
-  piosk.checkStatus();
-  setInterval(piosk.checkStatus, 5000);
+  xiosk.checkStatus();
+  setInterval(xiosk.checkStatus, 5000);
 
-  $('#add-url').on('click', piosk.addNewUrl);
-  $('#new-url').on('keyup', (e) => { if (e.key === 'Enter') piosk.addNewUrl(); });
+  $('#add-url').on('click', xiosk.addNewUrl);
+  $('#new-url').on('keyup', (e) => { if (e.key === 'Enter') xiosk.addNewUrl(); });
 
   $('#urls').on('click', 'button.btn-close', (e) => {
     $(e.target).closest('li.list-group-item').remove();
@@ -109,7 +109,7 @@ $(document).ready(() => {
   // MODIFIED: The #execute handler now saves all settings correctly
   $('#execute').on('click', function(e) {
     const $btn = $(this);
-    piosk.toggleLoading($btn, true, "Applying...");
+    xiosk.toggleLoading($btn, true, "Applying...");
 
     let config = {};
     config.urls = [];
@@ -132,11 +132,11 @@ $(document).ready(() => {
       data: JSON.stringify(config),
       contentType: "application/json; charset=utf-8",
       success: (data) => {
-        piosk.showStatus({ status: 200, responseText: data });
+        xiosk.showStatus({ status: 200, responseText: data });
       },
-      error: piosk.showStatus,
+      error: xiosk.showStatus,
       complete: () => {
-          piosk.toggleLoading($btn, false);
+          xiosk.toggleLoading($btn, false);
       }
     });
   });
@@ -148,17 +148,17 @@ $(document).ready(() => {
     if(action === 'stop' && !confirm("Stop the Kiosk display?")) return;
 
     const loadText = action === 'start' ? "Starting..." : "Stopping...";
-    piosk.toggleLoading($btn, true, loadText);
+    xiosk.toggleLoading($btn, true, loadText);
 
     $.ajax({
       url: '/services/' + action, 
       type: 'POST',
       success: (data) => {
-          piosk.showStatus({ status: 200, responseText: data });
+          xiosk.showStatus({ status: 200, responseText: data });
       },
-      error: piosk.showStatus,
+      error: xiosk.showStatus,
       complete: () => {
-           setTimeout(() => { piosk.toggleLoading($btn, false); }, 500);
+           setTimeout(() => { xiosk.toggleLoading($btn, false); }, 500);
       }
     });
   });
diff --git a/scripts/runtime/runner.sh b/scripts/runtime/runner.sh
@@ -8,7 +8,7 @@ export XDG_RUNTIME_DIR=/run/user/$(id -u)
 sleep 5
 
 # check to ensure URLs are there to load
-URLS=$(jq -r '.urls | map(.url) | join(" ")' /opt/piosk/config.json)
+URLS=$(jq -r '.urls | map(.url) | join(" ")' /opt/xiosk/config.json)
 if [ -z "$URLS" ]; then
     echo "No URLs found in config.json. Exiting runner."
     exit 0
diff --git a/scripts/runtime/switcher.sh b/scripts/runtime/switcher.sh
@@ -1,7 +1,7 @@
 #!/bin/bash
 
 # Ensure the script runs from the correct directory, where config.json is located.
-cd /opt/piosk
+cd /opt/xiosk
 
 export XDG_RUNTIME_DIR=/run/user/1000
 
@@ -34,7 +34,7 @@ CURRENT_TAB_INDEX=0
 echo "Switcher waiting for browser to initialize..."
 sleep 15
 
-echo "PiOSK switcher started. Managing $URL_COUNT tabs."
+echo "XiOSK switcher started. Managing $URL_COUNT tabs."
 
 # --- Main Loop ---
 while true; do
diff --git a/scripts/setup/backup.sh b/scripts/setup/backup.sh
@@ -6,11 +6,11 @@ source "$SCRIPT_DIR/common.sh"
 
 msg "$INFO" "Starting configuration backup..."
 
-readonly backup_dir="/opt/piosk-backups"
-readonly latest_file="$backup_dir/piosk-latest.config"
+readonly backup_dir="/opt/xiosk-backups"
+readonly latest_file="$backup_dir/xiosk-latest.config"
 
-if [ ! -f "$PIOSK_CONFIG_FILE" ]; then
-    msg "$WARNING" "Configuration file not found at '$PIOSK_CONFIG_FILE'. Nothing to back up."
+if [ ! -f "$XIOSK_CONFIG_FILE" ]; then
+    msg "$WARNING" "Configuration file not found at '$XIOSK_CONFIG_FILE'. Nothing to back up."
     exit 0
 fi
 
@@ -22,7 +22,7 @@ if [ -f "$latest_file" ]; then
     mv "$latest_file" "$backup_dir/$archived_filename"
 fi
 
-cp "$PIOSK_CONFIG_FILE" "$latest_file"
+cp "$XIOSK_CONFIG_FILE" "$latest_file"
 msg "$SUCCESS" "Backup successful! Latest config saved to: $latest_file"
 
 msg "$DEBUG" "Applying retention policy (keeping last 5)..."
diff --git a/scripts/setup/cleanup.sh b/scripts/setup/cleanup.sh
@@ -4,23 +4,23 @@ set -euo pipefail
 SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 source "$SCRIPT_DIR/common.sh"
 
-msg "$INFO" "Uninstalling PiOSK..."
+msg "$INFO" "Uninstalling XiOSK..."
 msg "$INFO" "A backup of your configuration will be created before cleanup."
 bash "$SCRIPT_DIR/backup.sh"
 
 msg "$DEBUG" "Stopping and disabling systemd services..."
-systemctl stop piosk-dashboard piosk-runner piosk-switcher &>/dev/null || true
-systemctl disable piosk-dashboard piosk-runner piosk-switcher &>/dev/null || true
+systemctl stop xiosk-dashboard xiosk-runner xiosk-switcher &>/dev/null || true
+systemctl disable xiosk-dashboard xiosk-runner xiosk-switcher &>/dev/null || true
 
 msg "$DEBUG" "Removing systemd service files..."
-rm -f /etc/systemd/system/piosk-*.service
+rm -f /etc/systemd/system/xiosk-*.service
 
 msg "$DEBUG" "Reloading systemd daemon..."
 systemctl daemon-reload
 
-msg "$DEBUG" "Removing installation directory: $PIOSK_INSTALL_DIR"
-rm -rf "$PIOSK_INSTALL_DIR"
-rm -f /opt/piosk.config.bak
+msg "$DEBUG" "Removing installation directory: $XIOSK_INSTALL_DIR"
+rm -rf "$XIOSK_INSTALL_DIR"
+rm -f /opt/xiosk.config.bak
 
-msg "$SUCCESS" "PiOSK has been successfully uninstalled."
+msg "$SUCCESS" "XiOSK has been successfully uninstalled."
 
diff --git a/scripts/setup/common.sh b/scripts/setup/common.sh
@@ -7,9 +7,9 @@ if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
 fi
 
 # --- Configuration ---
-readonly PIOSK_INSTALL_DIR="/opt/piosk"
-readonly PIOSK_CONFIG_FILE="$PIOSK_INSTALL_DIR/config.json"
-readonly PIOSK_TEMP_DIR="/opt/piosk.new"
+readonly XIOSK_INSTALL_DIR="/opt/xiosk"
+readonly XIOSK_CONFIG_FILE="$XIOSK_INSTALL_DIR/config.json"
+readonly XIOSK_TEMP_DIR="/opt/xiosk.new"
 
 # --- ANSI Color Codes ---
 RESET='\033[0m'
diff --git a/scripts/setup/install.sh b/scripts/setup/install.sh
diff --git a/scripts/setup/update.sh b/scripts/setup/update.sh
diff --git a/services/xiosk-dashboard.template b/services/xiosk-dashboard.template
diff --git a/services/xiosk-runner.template b/services/xiosk-runner.template
diff --git a/services/xiosk-switcher.template b/services/xiosk-switcher.template
diff --git a/www/public/bootstrap.sh b/www/public/bootstrap.sh
