refactor: rename yml to yaml, standardize pkg templates, add Base category

Author: ahze

.github/workflows/docs.yml .github/workflows/docs.yaml.github/workflows/docs.yml renamed to .github/workflows/docs.yaml

@@ -0,0 +1,60 @@
+(function() {
+    let moved = false;
+
+    function moveTable() {
+        if (moved) return;
+
+        const tableDiv = document.querySelector(".auto-input-table");
+        if (!tableDiv) return;
+
+        // Find target header
+        const targetHeader = document.querySelector("h3#interactive-configuration");
+        
+        if (targetHeader) {
+            console.log("UX Settings: Moving table AFTER", targetHeader);
+            
+            // Move Table
+            if (targetHeader.nextSibling) {
+                targetHeader.parentNode.insertBefore(tableDiv, targetHeader.nextSibling);
+            } else {
+                targetHeader.parentNode.appendChild(tableDiv);
+            }
+            
+            // Ensure Visible
+            tableDiv.style.display = "block";
+            tableDiv.style.marginTop = "1rem";
+            tableDiv.style.marginBottom = "1rem";
+            
+            // Find Reset Button logic
+            // The plugin often puts it in .placeholder-settings-panel (sibling) OR inside tableDiv
+            const settingsPanel = document.querySelector(".placeholder-settings-panel");
+            
+            if (settingsPanel) {
+                // Move it AFTER table
+                if (tableDiv.nextSibling) {
+                    tableDiv.parentNode.insertBefore(settingsPanel, tableDiv.nextSibling);
+                } else {
+                    tableDiv.parentNode.appendChild(settingsPanel);
+                }
+                settingsPanel.style.display = "block";
+                settingsPanel.style.marginBottom = "2rem";
+            }
+            
+            moved = true;
+        }
+    }
+
+    const observer = new MutationObserver((mutations) => {
+        if (moved) {
+            observer.disconnect();
+            return;
+        }
+        if (document.querySelector(".auto-input-table")) {
+            moveTable();
+        }
+    });
+
+    observer.observe(document.body, { childList: true, subtree: true });
+    window.addEventListener("DOMContentLoaded", moveTable);
+    window.addEventListener("load", moveTable);
+})();

docs/assets/javascripts/ux-settings-v2.js

@@ -0,0 +1,78 @@
+(function() {
+    // Flag to ensure we only move it once
+    let moved = false;
+
+    function moveTable() {
+        if (moved) return;
+
+        const tableDiv = document.querySelector(".auto-input-table");
+        if (!tableDiv) return;
+
+        // Find the target: H2 with ID "parameters"
+        const headers = document.querySelectorAll("h2");
+        let targetHeader = null;
+        
+        for (let h of headers) {
+            if (h.id === "parameters" || h.innerText.includes("Parameters")) {
+                targetHeader = h;
+                break;
+            }
+        }
+
+        if (targetHeader) {
+            console.log("UX Settings: Moving table before", targetHeader);
+            targetHeader.parentNode.insertBefore(tableDiv, targetHeader);
+            tableDiv.style.marginBottom = "3rem";
+            tableDiv.style.marginTop = "2rem";
+            tableDiv.style.display = "block"; // Ensure visible
+            moved = true;
+            
+            // --- Reset Button Logic: Just Style/Enhance, don't move ---
+            const buttons = tableDiv.querySelectorAll("button");
+            for (let btn of buttons) {
+                if (btn.innerText.includes("Reset")) {
+                    // Ensure it is visible and has our custom event just in case
+                    btn.style.visibility = "visible";
+                    btn.style.display = "block"; // Make it a block element at bottom of card
+                    btn.style.height = "auto";
+                    btn.style.width = "auto";
+                    
+                    // Attach Robust Reset Logic (Nuclear option)
+                    // We attach it without removing old listeners, so both might fire (fine)
+                    btn.addEventListener("click", function(e) {
+                        console.log("Reset Clicked - Executing Nuclear Reset");
+                        const prefix = window.location.pathname;
+                        const keysToRemove = [];
+                        for (let i = 0; i < localStorage.length; i++) {
+                            const key = localStorage.key(i);
+                            if (key && key.startsWith(prefix)) {
+                                keysToRemove.push(key);
+                            }
+                        }
+                        keysToRemove.forEach(k => localStorage.removeItem(k));
+                        setTimeout(() => window.location.reload(), 100);
+                    });
+                }
+            }
+        }
+    }
+
+    // Observer to watch for the table appearing
+    const observer = new MutationObserver((mutations) => {
+        if (moved) {
+            observer.disconnect();
+            return;
+        }
+        
+        if (document.querySelector(".auto-input-table")) {
+            moveTable();
+        }
+    });
+
+    // Start observing the body
+    observer.observe(document.body, { childList: true, subtree: true });
+
+    // Also try immediately and on load
+    window.addEventListener("DOMContentLoaded", moveTable);
+    window.addEventListener("load", moveTable);
+})();

docs/assets/javascripts/ux-settings.js

@@ -58,6 +58,15 @@ The base image automatically ensures `/config` is owned by the specified PUID/PG
 
 For **additional volumes** (like `/movies` or `/downloads`), the container will not recursively change permissions to avoid slow startup on large libraries. Ensure your host user has appropriate access before starting.
 
+## File Permissions (UMASK)
+
+The default umask for all containers is `0022`.
+
+- **Directories** created by the app will be `755` (Owner: rwx, Group: r-x, Others: r-x).
+- **Files** created by the app will be `644` (Owner: rw-, Group: r--, Others: r--).
+
+This ensures files are readable by others (like Plex) but only writable by the user matching the `PUID`.
+
 ## Troubleshooting
 
 ### Permission Denied

docs/guides/permissions.md

@@ -1,110 +1,112 @@
 ---
-title: adguardhome-sync - FreeBSD OCI Container
-description: Sync AdGuardHome config to replica instances  Run this application natively on FreeBSD using Podman and the Daemonless framework. Secure, lightweight, and automated.
+title: "AdGuardHome Sync on FreeBSD: Native OCI Container using Podman & Jails"
+description: "Install AdGuardHome Sync on FreeBSD natively using Podman and Daemonless. Enjoy lightweight, secure OCI containers in FreeBSD Jails without the overhead of Linux VMs."
+placeholders:
+  ADGUARDHOME_SYNC_PORT:
+    default: "8080"
+    description: AdGuardHome Sync Host Port
 ---
 
-# adguardhome-sync
+# :simple-adguard: AdGuardHome Sync
 
-Sync AdGuardHome configuration from an origin instance to replica instances, running natively on FreeBSD.
+[![Build Status](https://img.shields.io/github/actions/workflow/status/daemonless/adguardhome-sync/build.yml?style=flat-square&label=Build&color=green)](https://github.com/daemonless/adguardhome-sync/actions)
+[![Last Commit](https://img.shields.io/github/last-commit/daemonless/adguardhome-sync?style=flat-square&label=Last+Commit&color=blue)](https://github.com/daemonless/adguardhome-sync/commits)
 
-| | |
-|---|---|
-| **Port** | 8080 |
-| **Registry** | `ghcr.io/daemonless/adguardhome-sync` |
-| **Tags** | `:latest` |
-| **Source** | [github.com/daemonless/adguardhome-sync](https://github.com/daemonless/adguardhome-sync) |
+Sync AdGuardHome configuration to replica instances.
 
-## Quick Start
+## Version Tags
 
-=== "Podman CLI"
+| Tag | Description | Best For |
+| :--- | :--- | :--- |
+| `latest` | **Upstream Binary**. Downloads the official release. | Most users. Matches Linux Docker behavior. |
+
+## Prerequisites
+
+Before deploying, ensure your host environment is ready. See the [Quick Start Guide](../quick-start.md) for host setup instructions.
+
+## Deployment
+
+=== ":material-docker: Podman Compose"
 
-    ### Podman
-    
-    ```bash
-    podman run --name adguardhome-sync\
-        --restart unless-stopped\
-        -v /my/own/config:/config\
-        -p 8080:8080/tcp\
-        -d ghcr.io/daemonless/adguardhome-sync
-    ```
-    
-    ### Compose
-    
     ```yaml
     services:
       adguardhome-sync:
         image: ghcr.io/daemonless/adguardhome-sync:latest
         container_name: adguardhome-sync
-        restart: unless-stopped
+        environment:
+          - PUID=@PUID@
+          - PGID=@PGID@
+          - TZ=@TZ@
         volumes:
-          - /my/own/config:/config
+          - @CONTAINER_CONFIG_ROOT@/@ADGUARDHOME_SYNC_CONFIG_PATH@:/config
         ports:
-          - "8080:8080/tcp"
+          - @ADGUARDHOME_SYNC_PORT@:8080
+        restart: unless-stopped
     ```
 
-## Configuration
+=== ":material-console: Podman CLI"
 
-Create `/config/adguardhome-sync.yaml`:
+    ```bash
+    podman run -d --name adguardhome-sync \
+      -p @ADGUARDHOME_SYNC_PORT@:8080 \
+      -e PUID=@PUID@ \
+      -e PGID=@PGID@ \
+      -e TZ=@TZ@ \
+      -v @CONTAINER_CONFIG_ROOT@/@ADGUARDHOME_SYNC_CONFIG_PATH@:/config \ 
+      ghcr.io/daemonless/adguardhome-sync:latest
+    ```
 
-```yaml
-# cron expression for sync schedule
-cron: "*/5 * * * *"
+=== ":simple-ansible: Ansible"
 
-# run sync on startup
-runOnStart: true
+    ```yaml
+    - name: Deploy adguardhome-sync
+      containers.podman.podman_container:
+        name: adguardhome-sync
+        image: ghcr.io/daemonless/adguardhome-sync:latest
+        state: started
+        restart_policy: always
+        env:
+          PUID: "@PUID@"
+          PGID: "@PGID@"
+          TZ: "@TZ@"
+        ports:
+          - "@ADGUARDHOME_SYNC_PORT@:8080"
+        volumes:
+          - "@CONTAINER_CONFIG_ROOT@/@ADGUARDHOME_SYNC_CONFIG_PATH@:/config"
+    ```
 
-    # Primary instance
-    url: http://<primary-ip>:3000
-    username: admin
-    password: password
-    # Secondary instances to sync to
-    replica:
-      - url: http://<replica-ip>:3000
-        username: admin
+Access the Web UI at: `http://localhost:@ADGUARDHOME_SYNC_PORT@`
 
-# API server
-api:
-  port: 8080
-```
+### Interactive Configuration
 
-## Environment Variables
+<div class="placeholder-settings-panel"></div>
 
-| Variable | Description | Default |
-|----------|-------------|---------|
-| `PUID` | User ID | `1000` |
-| `PGID` | Group ID | `1000` |
-| `TZ` | Timezone | `UTC` |
+## Parameters
 
-## What Gets Synced
+### Environment Variables
 
-- General settings
-- DNS configuration (rewrites, access lists, server config)
-- Filters
-- Client settings
-- DHCP settings (optional)
-- Services
-- Query log config
-- Statistics config
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `PUID` | `1000` | User ID for the application process |
+| `PGID` | `1000` | Group ID for the application process |
+| `TZ` | `UTC` | Timezone for the container |
 
-## Volumes
+### Volumes
 
 | Path | Description |
 |------|-------------|
 | `/config` | Configuration directory |
 
-## Ports
+### Ports
 
 | Port | Protocol | Description |
 |------|----------|-------------|
-| 8080 | TCP | Web API / metrics |
-
-## Tags
+| `8080` | TCP | Metrics/API |
 
-| Tag | Source | Description |
-|-----|--------|-------------|
-| `:latest` | [Upstream Releases](https://github.com/bakito/adguardhome-sync/releases) | Latest upstream release |
+!!! info "Implementation Details"
 
-## Links
+    - **User:** `bsd` (UID/GID set via [PUID/PGID](../guides/permissions.md)). Defaults to `1000:1000`.
+    - **Base:** Built on `ghcr.io/daemonless/base` (FreeBSD 15.0).
 
-- [Upstream Repository](https://github.com/bakito/adguardhome-sync)
-- [Configuration Reference](https://github.com/bakito/adguardhome-sync#config-file)
+[Website](https://github.com/bakito/adguardhome-sync){ .md-button .md-button--primary }
+[Source Code](https://github.com/bakito/adguardhome-sync){ .md-button }