Initial commit of Dynacat config, assets, and rules

2026-07-06 00:19:46 -05:00
commit 8a07b9f589
7 changed files with 1834 additions and 0 deletions
@@ -0,0 +1,87 @@
+# Dynacat Proxmox Homelab Dashboard Setup
+
+This directory contains pre-configured files to deploy and customize the **Dynacat** dashboard (a real-time, self-hosted feed and service aggregator) for your homelab.
+
+## File Structure
+
+- `config/dynacat.yml`: The main configuration file, styled in a custom dark HSL theme and pre-loaded with all your 14 active homelab services.
+- `assets/news.html`: A custom, Google-News-style news portal that aggregates your RSS feeds into a visual card grid.
+- `docker-compose.yml`: A compose template for deploying Dynacat in a Docker environment (such as a Docker-enabled VM or LXC).
+
+---
+
+## How to Apply to Your Proxmox Setup
+
+Choose the installation method that matches how you deployed Dynacat:
+
+### Option A: If using Proxmox LXC (Helper Script)
+If you installed Dynacat directly as an LXC container using a Proxmox VE Helper Script (e.g. from Community Scripts / tteck):
+
+1. **Locate the Target Paths:** Inside the container, Dynacat looks for configuration and assets at:
+   - Config file: `/opt/dynacat/config/dynacat.yml`
+   - Assets folder: `/opt/dynacat/assets/news.html`
+2. **Transfer the Files:**
+   You can copy the local files to your LXC container using SCP:
+   ```bash
+   # Replace <LXC_IP> with the IP address of your Dynacat LXC (e.g. 192.168.1.146)
+   # Copy the configuration file:
+   scp config/dynacat.yml root@<LXC_IP>:/opt/dynacat/config/dynacat.yml
+
+   # Copy the news portal asset file:
+   scp assets/news.html root@<LXC_IP>:/opt/dynacat/assets/news.html
+   ```
+   *Alternatively*, you can edit the file directly inside the LXC container's terminal using `nano /opt/dynacat/config/dynacat.yml` and paste the contents of the generated `dynacat.yml`.
+3. **Apply Changes:**
+   Dynacat supports **live config reloading** and will detect updates automatically upon saving. If you need to manually restart the service, run:
+   ```bash
+   systemctl restart dynacat
+   ```
+4. **Set Up API Tokens (Inline Configuration):**
+   Instead of setting systemd environment variables, you can input your API keys directly inside the `dynacat.yml` file on your server (by replacing `"your_grocy_token_here"`, etc.):
+   * Edit the file on your server:
+     ```bash
+     nano /opt/dynacat/config/dynacat.yml
+     ```
+   * Replace the placeholder string values with your actual API keys/tokens.
+   * Save and close the file. Dynacat will automatically pick up the new configuration!
+
+---
+
+### Option B: If using Docker Compose (VM or LXC with Docker)
+If you are running Dynacat inside a VM or LXC that runs Docker:
+
+1. Copy both `docker-compose.yml` and the `config/` directory to your target folder on Proxmox.
+2. Spin up the container:
+   ```bash
+   docker compose up -d
+   ```
+3. Open your browser and navigate to `http://<YOUR_DOCKER_HOST_IP>:8080`.
+
+---
+
+## Customization Guide
+
+### 1. Weather Location
+Open `config/dynacat.yml` and locate the `weather` widget:
+```yaml
+- type: weather
+  location: "La Crosse, Wisconsin"  # Set to your location
+  units: imperial                  # Change to 'metric' for Celsius
+```
+
+### 2. Dashboard Icons
+We have pre-configured icons for your services using two libraries:
+- **Simple Icons (`si:`)**: High-quality vector icons for popular brands.
+- **Material Design Icons (`mdi:`)**: General icons (like gamepad, cloud, trash can).
+
+Example of a custom link with an icon:
+```yaml
+- title: Audiobookshelf
+  url: https://books.jonahlahona.com
+  icon: si:audiobookshelf
+```
+You can search for more icons on:
+- Simple Icons: [simpleicons.org](https://simpleicons.org/)
+- Material Design Icons: [pictogrammers.com/library/mdi/](https://pictogrammers.com/library/mdi/)
+- Selfh.st Icons: `sh:<icon_name>` (e.g., `sh:immich`)
+- Dashboard Icons: `di:<icon_name>`