+ action

.gitea/workflows/deploy.yml

@@ -0,0 +1,33 @@
+name: Deploy to DigitalOcean Droplet
+
+on:
+  push:
+    branches:
+      - digital-ocean
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to DigitalOcean Droplet
+        uses: appleboy/ssh-action@v1.0.3
+        with:
+          host: ${{ secrets.SSH_HOST }}
+          username: ${{ secrets.SSH_USERNAME }}
+          key: ${{ secrets.SSH_PRIVATE_KEY }}
+          port: ${{ secrets.SSH_PORT }}
+          script: |
+
+            git clone ${{ secrets.REPO_URL }} ~/ts-homepage
+            cd ~/ts-homepage
+
+            # Update repo to latest main branch
+            git fetch origin
+            git reset --hard origin/digital-ocean
+
+            # Pull public images and deploy
+            docker compose -f docker-compose.yml pull
+            docker compose -f docker-compose.yml up -d
+
+            # Clean up unused images
+            docker system prune -f

.gitignore

@@ -1,14 +0,0 @@
-.env
-.env.*
-*.key
-tskey-*
-authkey*
-tailscale/tailscale-data/
-homepage/images/
-homepage/config/logs/
-homepage/config/custom.css
-homepage/config/custom.js
-homepage/config/docker.yaml
-homepage/config/kubernetes.yaml
-homepage/config/proxmox.yaml
-

README.md

@@ -1,109 +1,111 @@
 # Homepage with Tailscale Integration
 
-![Homepage with Tailscale](https://raw.githubusercontent.com/gethomepage/homepage/main/docs/assets/logo.png "Homepage")
+![Homepage with Tailscale](https://gethomepage.dev/assets/banner_light@2x.webp "Homepage with Tailscale Integration")
 
-This project sets up a [Homepage](https://gethomepage.dev/) dashboard instance with Tailscale VPN integration using Docker Compose.
+This project sets up a Homepage instance with Tailscale VPN integration using Docker Compose. It creates a secure, private network connection for your homepage dashboard using Tailscale, while running the Homepage application from gethomepage.dev.
 
-Homepage is a self-hosted dashboard that links to all your self-hosted services — perfect for giving you a single URL that shows the state of your homelab.
+## Prerequisites
 
-## Quick Start (Tailscale)
+- Docker and Docker Compose installed on your system
+- A Tailscale account and auth key (get one from https://login.tailscale.com/admin/authkeys)
+- Basic understanding of Docker and networking concepts
 
-1. Copy the example environment file and fill in your values:
+## Project Structure
+```
+ts-homepage/
+├── docker-compose.yml
+├── tailscale/
+│   ├── tailscale-data/  # Persistent Tailscale state
+│   └── config/         # Tailscale configuration files
+└── homepage/
+    └── config/         # Homepage configuration files
+```
+
+## Setup Instructions
+
+1. **Clone the Repository**
    ```bash
-   cp .env.example .env
+   git clone https://gitea.damconsulting.llc/DAM/ts-homepage.git
+   cd ts-homepage
    ```
-2. Edit `.env` and set:
+2. Create Required Directories
-   - `TS_AUTHKEY` — your Tailscale auth key
+    ```bash
-   - `TZ` — your local timezone (e.g., `America/New_York`)
+    mkdir -p tailscale/tailscale-data tailscale/config homepage/config
-3. Start the stack:
+    ```
+3. Configure Tailscale
+    - Replace `{{YOUR_TAILSCALE_AUTHKEY}}` in the docker-compose.yml with your actual Tailscale auth key
+    - Optionally, update the file in `tailscale/config/serve.json` if you need specific Tailscale serve configurations
+        - CAUTION: Changing `"${TS_CERT_DOMAIN}:443": false` to `true` will expose the service to the internet
+
+4. Configure Homepage
+    - Add your Homepage configuration files to homepage/config/
+    - See https://gethomepage.dev/configs/ for configuration options
+    - The default setup allows all hosts (HOMEPAGE_ALLOWED_HOSTS: "*")
+
+5. Start the Services
     ```bash
     docker compose up -d
     ```
-4. Customize the dashboard by editing `homepage/config/` files (see [Configuration](#configuration) below)
-5. Access Homepage at `http://homepage.<your-tailnet>.ts.net`
 
-## Headscale
+## Services
 
-If you're using Headscale instead of Tailscale:
+### homepage-ts (Tailscale)
 
-1. Copy the example environment file:
+- Runs Tailscale VPN client
+- Image: tailscale/tailscale:latest
+- Container name: homepage-ts
+- Hostname: homepage
+- Requires NET_ADMIN and SYS_MODULE capabilities
+- Persists state in ./tailscale/tailscale-data
+- Uses configuration from ./tailscale/config
+
+### homepage
+
+- Runs Homepage dashboard
+- Image: ghcr.io/gethomepage/homepage:latest
+- Container name: homepage
+- Configuration stored in ./homepage/config
+- Uses Tailscale's network stack (no direct port mapping)
+- Depends on homepage-ts service
+
+## Usage
+
+- After starting the services your service should be available via tailnet at `https://homepage.{{YOUR_TAILNET_DOMAIN}}.ts.net` ie `https://homepage.tail12345.ts.net/`
+- To manually get the Tailscale IP/hostname of your container:
     ```bash
-   cp .env.example .env
+    docker logs homepage-ts
     ```
-2. Edit `.env` and set:
+    Look for the Tailscale IP address in the logs.
-   - `TS_AUTHKEY` — your Headscale auth key
+
-   - `TS_LOGIN_SERVER` — your Headscale server URL
+## Optional Features
-3. Switch to the Headscale serve config:
+
-   ```bash
+- Uncomment the Docker socket volume mapping in the Homepage service to enable Docker integrations:
-   cp tailscale/config/serve.headscale.json tailscale/config/serve.json
+    ```yaml
+    - /var/run/docker.sock:/var/run/docker.sock
     ```
-4. Edit `serve.json` to use your actual domain. The default in this file uses `homepage.damconsulting.net` (Kevin's Headscale base domain) — replace it with your own if your setup differs.
+- Uncomment and adjust the ports mapping if you need direct access (without Tailscale):
-5. Start the stack:
+    ```yaml
-   ```bash
+    ports:
-   docker compose up -d
-   ```
-6. Access Homepage at `http://homepage.yourdomain.com`
-
-## Configuration
-
-### Switching Serve Configs
-
-| Environment       | File to use                          | Notes |
-|-------------------|--------------------------------------|-------|
-| Tailscale (default) | `tailscale/config/serve.json`       | Supports HTTP + HTTPS with certs |
-| Headscale         | `tailscale/config/serve.headscale.json` | HTTP only |
-
-After changing the serve config, restart the sidecar:
-```bash
-docker compose restart homepage-ts
-```
-
-When the sidecar restarts, restart the homepage container too so it re-joins the new network namespace:
-```bash
-docker compose restart homepage
-```
-
-### Dashboard Configuration
-
-Homepage reads its dashboard layout from YAML files in `./homepage/config/`:
-
-- `settings.yaml` — global theme, layout, colors
-- `services.yaml` — the services shown on the dashboard
-- `bookmarks.yaml` — link groups
-- `widgets.yaml` — info widgets (search bar, weather, time, etc.)
-- `docker.yaml` — Docker container monitoring (if you mount the docker socket)
-
-The repo includes a starter `services.yaml` with placeholder entries. Edit the files to match the services you actually run on your tailnet (e.g., point entries to your other `ts-*` services at `http://<service>.<your-tailnet>`, etc.).
-
-See https://gethomepage.dev/configs/ for the full reference.
-
-After editing config files, no restart is needed — Homepage hot-reloads.
-
-### Optional: Direct Host Access
-
-Uncomment the ports section in `docker-compose.yml` if you need direct access without Tailscale:
-```yaml
-ports:
     - 3000:3000
-```
+    ```
-
+- Stopping the Services
-### Optional: Docker Socket Mount
+    ```bash
-
+    docker compose down
-To let Homepage show running containers as widgets, uncomment this volume mount in `docker-compose.yml`:
+    ```
-```yaml
-volumes:
-  - /var/run/docker.sock:/var/run/docker.sock:ro
-```
-
-**Security note:** This gives the container read access to your Docker daemon. Only enable this on a trusted tailnet.
 
+## Troubleshooting
+- Check container logs:
+    ```bash
+    docker logs homepage-ts
+    docker logs homepage
+    ```
+- Ensure your Tailscale auth key is valid and not expired
+- Verify the configuration files have proper permissions
+- Make sure required directories exist before starting
 ## Notes
-
+- The Homepage service uses the Tailscale service's network stack via network_mode: service:homepage-ts
-- `HOMEPAGE_ALLOWED_HOSTS: "*"` is set in the compose file because the Tailscale sidecar handles auth. If you expose Homepage outside the tailnet, restrict this to your actual hostnames.
+- Direct port mapping is disabled by default as Tailscale handles the networking
-- First-run shows the default "Welcome to Homepage" layout. Edit `services.yaml` to replace placeholders with your real services.
+- Services restart automatically unless explicitly stopped
-
+- For more information:
-## Links
+    - Tailscale documentation: https://tailscale.com/kb/
-
+    - Homepage documentation: https://gethomepage.dev/
-- Official site: https://gethomepage.dev/
-- Git repository: https://github.com/gethomepage/homepage
-- Docker image: https://github.com/gethomepage/homepage/pkgs/container/homepage

SECURITY.md

@@ -1,39 +0,0 @@
-# Security Notes for ts-homepage
-
-This repository contains the configuration for deploying Homepage behind a Tailscale sidecar.
-
-## What's committed
-
-- `docker-compose.yml` — service definitions, image versions, env var references
-- `.env.example` — template showing required env vars (no real secrets)
-- `tailscale/config/serve.json` — Tailscale serve config (committed generic form)
-- `tailscale/config/serve.headscale.json` — Headscale variant for testing
-- `homepage/config/` — dashboard layout files (services, bookmarks, widgets)
-- `README.md` — setup instructions
-
-## What is NOT committed
-
-- `.env` — contains real authkeys
-- `tailscale/tailscale-data/` — Tailscale node identity state
-- `homepage/images/` — uploaded images
-- Any volume data
-
-The `.gitignore` at the repo root blocks accidental commits of these.
-
-## Rotation
-
-- If a `TS_AUTHKEY` was ever leaked, revoke it at https://login.tailscale.com/admin/authkeys (or your Headscale equivalent) and generate a new one.
-
-## Threat model
-
-This deployment assumes:
-- The Mac mini is reachable only via Tailscale/Headscale
-- All access to Homepage goes through the Tailscale sidecar (no exposed ports)
-- The Tailnet itself is trusted
-- If you mount the Docker socket, the Homepage container has read access to your Docker daemon — only enable this on a trusted tailnet
-
-If your threat model differs (e.g., you need to expose Homepage to the public internet), review the `AllowFunnel` setting in `tailscale/config/serve.json` and the Tailscale ACL controls carefully before proceeding.
-
-## Reporting
-
-If you find a security issue with this deployment pattern, contact kevin.riordan@damconsulting.llc.

docker-compose.yml

@@ -1,39 +1,31 @@
-# ==========================================
-# REQUIRED: Tailscale sidecar (all ts-* services)
-# ==========================================
 services:
   homepage-ts:
     image: tailscale/tailscale:latest
     hostname: homepage
     container_name: homepage-ts
     environment:
-      - TS_AUTHKEY=${TS_AUTHKEY}
+      - TS_AUTHKEY={{YOUR_TAILSCALE_AUTHKEY}}
-      - TS_LOGIN_SERVER=${TS_LOGIN_SERVER}
       - TS_STATE_DIR=/var/lib/tailscale
       - TS_SERVE_CONFIG=/config/serve.json
-      - TS_EXTRA_ARGS=--login-server=${TS_LOGIN_SERVER}
     volumes:
       - ./tailscale/tailscale-data:/var/lib/tailscale
       - ./tailscale/config:/config
       - /dev/net/tun:/dev/net/tun
     cap_add:
       - net_admin
+      - sys_module
     restart: unless-stopped
-
-  # ==========================================
-  # REQUIRED: Homepage (single container, no DB)
-  # ==========================================
   homepage:
     image: ghcr.io/gethomepage/homepage:latest
-    environment:
+    container_name: homepage
-      # Required: comma-separated list of allowed hostnames / IPs.
+    # ports:
-      # Use "*" to allow any (fine behind Tailscale, since Tailscale handles auth).
+    #   - 3000:3000
-      HOMEPAGE_ALLOWED_HOSTS: "*"
-      TZ: ${TZ:-UTC}
     volumes:
-      - ./homepage/config:/app/config
+      - ./homepage/config:/app/config # Make sure your local config directory exists
+      # - /var/run/docker.sock:/var/run/docker.sock # (optional) For docker integrations
+    environment:
+      # HOMEPAGE_ALLOWED_HOSTS: gethomepage.dev # required, may need port. See gethomepage.dev/installation/#homepage_allowed_hosts
+      HOMEPAGE_ALLOWED_HOSTS: "*" # required, may need port. See gethomepage.dev/installation/#homepage_allowed_hosts
+    network_mode: service:homepage-ts
     depends_on: 
       - homepage-ts
-    network_mode: service:homepage-ts
-    restart: unless-stopped
-

homepage/config/bookmarks.yaml

@@ -1,10 +0,0 @@
----
-# Homepage bookmarks: https://gethomepage.dev/configs/bookmarks/
-# Link groups shown in the bookmarks section.
-
-- Documentation:
-    - Homepage Docs:
-        - href: https://gethomepage.dev/
-    - Tailscale Docs:
-        - href: https://tailscale.com/kb/
-

homepage/config/services.yaml

@@ -1,35 +0,0 @@
----
-# Homepage services: https://gethomepage.dev/configs/services/
-# Edit to add your actual ts-* services running on the tailnet.
-# Each service is a link on the dashboard. Point entries to actual tailnet URLs.
-
-- DAM Services:
-    - Vikunja:
-        href: http://{{service}}.yourdomain.com
-        description: Task management
-        icon: vikunja
-    - BookStack:
-        href: http://{{service}}.yourdomain.com
-        description: Documentation wiki
-        icon: bookstack
-    - Uptime Kuma:
-        href: http://{{service}}.yourdomain.com
-        description: Service monitoring
-        icon: uptime-kuma
-    - Focalboard:
-        href: http://{{service}}.yourdomain.com
-        description: Kanban boards
-        icon: focalboard
-    - Shiori:
-        href: http://{{service}}.yourdomain.com
-        description: Bookmark manager
-        icon: shiori
-    - FreshRSS:
-        href: http://{{service}}.yourdomain.com
-        description: RSS reader
-        icon: freshrss
-    - Stirling PDF:
-        href: http://{{service}}.yourdomain.com
-        description: PDF tools
-        icon: stirling-pdf
-

homepage/config/settings.yaml

@@ -1,14 +0,0 @@
----
-# Homepage settings: https://gethomepage.dev/configs/settings/
-# Background, theme, layout, color scheme
-
-title: DAM Homelab
-background:
-  opacity: 50
-  blur: sm
-  saturation: 100
-theme: dark
-color: slate
-headerStyle: underlined
-favicon: https://gethomepage.dev/icon.png
-

homepage/config/widgets.yaml

@@ -1,18 +0,0 @@
----
-# Homepage widgets: https://gethomepage.dev/configs/widgets/
-# Info widgets shown at the top of the dashboard.
-
-- search:
-    provider: custom
-    url: https://www.google.com/search
-
-- resources:
-    cpu: true
-    memory: true
-    disk: /
-
-- datetime:
-    format:
-      timeStyle: short
-      dateStyle: medium
-

homepage/config/workspace/services.yaml

@@ -0,0 +1,18 @@
+---
+# For configuration options and examples, please see:
+# https://gethomepage.dev/configs/services/
+
+- My First Group:
+    - My First Service:
+        href: http://localhost/
+        description: Homepage is awesome
+
+- My Second Group:
+    - My Second Service:
+        href: http://localhost/
+        description: Homepage is the best
+
+- My Third Group:
+    - My Third Service:
+        href: http://localhost/
+        description: Homepage is 😎

tailscale/config/serve.headscale.json

@@ -1,17 +0,0 @@
-{
-  "TCP": {
-    "80": {
-      "HTTP": true
-    }
-  },
-  "Web": {
-    "homepage.damconsulting.net:80": {
-      "Handlers": {
-        "/": {
-          "Proxy": "http://127.0.0.1:3000"
-        }
-      }
-    }
-  }
-}
-

tailscale/config/serve.json

@@ -1,20 +1,10 @@
 {
     "TCP": {
-    "80": {
-      "HTTP": true
-    },
       "443": {
         "HTTPS": true
       }
     },
     "Web": {
-    "${TS_CERT_DOMAIN}:80": {
-      "Handlers": {
-        "/": {
-          "Proxy": "http://127.0.0.1:3000"
-        }
-      }
-    },
       "${TS_CERT_DOMAIN}:443": {
         "Handlers": {
           "/": {
@@ -26,4 +16,4 @@
     "AllowFunnel": {
       "${TS_CERT_DOMAIN}:443": false
     }
-}
+  }