From ec7e56529d687c501f959b4a3b604d54efd94ffd Mon Sep 17 00:00:00 2001 From: rezayaghobi-dev Date: Sun, 23 Aug 2026 22:20:33 +0330 Subject: [PATCH] added a html preview --- .freebuff/preview.html | 309 +++++++++++++++++++++++++++++++++++++++++ .freebuff/run.md | 22 +++ 2 files changed, 331 insertions(+) create mode 100644 .freebuff/preview.html create mode 100644 .freebuff/run.md diff --git a/.freebuff/preview.html b/.freebuff/preview.html new file mode 100644 index 0000000..5192030 --- /dev/null +++ b/.freebuff/preview.html @@ -0,0 +1,309 @@ + + + + + + Homelab — Infrastructure Overview + + + + +

🏠 Homelab

+

A self-hosted homelab running on Docker Compose, built and maintained on Ubuntu Server.

+ +
+ Docker + Docker Compose + Ubuntu Server + Ansible + Prometheus + Grafana + K3s + GitLab + Vagrant +
+ +
+

🟢 Always-On Services

+
+
+

📊Monitoring Stack

+

Prometheus, Grafana, cAdvisor, node-exporter, Loki + Alloy for centralized logging

+ docker-compose/monitoring-grafana-promethues-cadvisor-node-exporter/ +
+
+

🛡️Pi-hole

+

Network-wide DNS-level ad and tracker blocking

+ docker-compose/pihole/ +
+
+

🐳Portainer

+

Web UI for managing and monitoring all Docker containers

+ docker-compose/portainer/ +
+
+

🔮DockScope

+

3D visual dashboard mapping containers, networks, and dependencies

+ docker-compose/dockscope/ +
+
+

⚡n8n

+

Workflow automation engine, backed by Postgres

+ docker-compose/n8n/ +
+
+

📁Samba

+

Network file sharing across LAN devices

+ docker-compose/samba/ +
+
+

📂Filebrowser

+

Web-based file manager for the server's storage

+ docker-compose/filebrowser/ +
+
+

🎬Media Stack

+

Plex, Sonarr/Radarr/Prowlarr/Whisparr, qBittorrent

+ docker-compose/mediastack/ +
+
+

⛏️Minecraft

+

Self-hosted game server

+ docker-compose/minecraft/ +
+
+

🔍Sentinel + smartctl

+

Disk health monitoring via S.M.A.R.T. data

+ docker-compose/sentinel/ +
+
+

🤖OpenHands

+

Self-hosted AI coding agent backed by Ollama

+ docker-compose/openhands/ +
+
+

🔀Nginx Proxy Manager

+

Reverse proxy with friendly .home hostnames and local HTTPS

+ docker-compose/nginx-proxy-manager/ +
+
+

🎯Semaphore

+

Self-hosted Ansible UI for running playbooks

+ docker-compose/semaphore/ +
+
+

🦊GitLab CI/CD

+

Self-hosted GitLab Omnibus + Docker-executor Runner

+ docker-compose/gitlab/ +
+
+

📦MinIO

+

S3-compatible object storage, backup target

+ docker-compose/minio/ +
+
+

☸️K3s Cluster

+

Single-node K3s alongside Docker Compose, monitored by same stack

+ kubernetes/ +
+
+
+ +
+

🧪 Learning Labs (not always-on)

+
+
+

🔎Elastic Stack (ELK)

+

Elasticsearch + Kibana, security-enabled — replaced by Loki for daily logging

+ docker-compose/ELK/ +
+
+

💻Vagrant Test VM

+

Disposable Debian 12 VM for testing provisioning before touching production

+ vagrant/ +
+
+
+ +
+

⚙️ Ansible Automation

+
+
+

🔄Update Playbooks

+

16 thin playbooks, one per stack, all delegating to the shared docker_compose_update role: pull → recreate → health-check → prune. Run through Semaphore.

+ ansible/update-playbooks/ +
+
+

🏗️Server Provisioning

+

Full server preparation: packages, sshd hardening, iptables, fail2ban, auditd, Docker CE, Nexus + Traefik. Tested against Vagrant first.

+ ansible/preparing-playbook/ +
+
+
+ +
+

🗂️ Repository Structure

+
+homelab/
+├── docker-compose/ # every service in its own folder
+│ ├── monitoring-grafana-promethues-cadvisor-node-exporter/
+│ ├── pihole/   portainer/   dockscope/   n8n/
+│ ├── samba/   filebrowser/   mediastack/   minecraft/
+│ ├── sentinel/   smartctl/   minio/
+│ ├── openhands/   nginx-proxy-manager/   semaphore/
+│ ├── gitlab/   (with ci-images-reference/ & backups/)
+│ └── ELK/
+├── ansible/
+│ ├── update-playbooks/   # day-to-day stack updates
+│ │    ├── roles/docker_compose_update/
+│ │    └── update-*.yml + ping.yml
+│ └── preparing-playbook/ # server provisioning
+│         └── reza-ansible/ (inventory, roles, vault)
+├── docs/ # detailed write-ups per topic
+├── kubernetes/ # K3s manifests & RBAC patches
+├── dashboards/ # Grafana dashboard JSON exports
+├── vagrant/ # disposable test VM
+└── scripts/ # linux_setup.sh provisioning script +
+
+ +
+

📈 Grafana Dashboards

+ + + + + + + + + + +
DashboardData SourcesType
GitLab Rails & Puma OverviewPrometheus + LokiCustom-built
GitLab Runner MetricsPrometheusCustom-built
Kubernetes / PodsPrometheusCommunity import
K3s Cluster OverviewPrometheusCommunity import
K3s Unified App DashboardPrometheus + LokiCustom-built
K3s Professional Log AnalyzerLokiCustom-built
+
+ +
+

Reza — Computer Networks student, LPIC-1  |  GitHub

+

Infrastructure-as-code for a real, running homelab — configs only, no secrets or runtime data.

+
+ + + diff --git a/.freebuff/run.md b/.freebuff/run.md new file mode 100644 index 0000000..797dbb8 --- /dev/null +++ b/.freebuff/run.md @@ -0,0 +1,22 @@ +# Preview run doc + +## Mode + +Standalone HTML file — no dev server, no dependencies. + +## How to reproduce + +1. The preview is a single static file at `.freebuff/preview.html` +2. No build step, no install — just open it in a browser or register it via `register_preview` with `htmlPath` + +## Running + +```bash +# The preview is served by Freebuff's built-in static file server. +# No manual server needed — just point register_preview at the HTML file. +``` + +To re-register: +``` +register_preview(htmlPath="D:\\files\\projects\\homelab\\docker-compose\\.freebuff\\preview.html") +```