Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ Use the issue templates for documentation improvements, safety reviews, and sani

## Tone

Keep the writing practical and approachable. This repo should feel like a companion to a KeepItTechie video: useful, clear, and grounded in real homelab learning without exposing private operational details.
Keep the writing practical and approachable. This repo should feel like a useful KeepItTechie homelab guide: clear, grounded in real learning, and careful about private operational details.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
![License](https://img.shields.io/badge/license-CC%20BY%204.0-green)
![Homelab](https://img.shields.io/badge/homelab-linux%20%7C%20self--hosted-lightgrey)

This repo is the public-safe tour map for the KeepItTechie homelab. It shows how the lab is put together, why each layer exists, and what viewers can learn from running real Linux and open source services at home.
This repo is the public-safe tour map for the KeepItTechie homelab. It shows how the lab is put together, why each layer exists, and what readers can learn from running real Linux and open source services at home.

Think of it as a teaching repo, not a config dump. The docs explain the patterns behind pfSense, Pi-hole, Proxmox, storage, backups, monitoring, media workflows, local AI, dashboards, and automation without exposing private infrastructure details.

Expand Down Expand Up @@ -38,7 +38,7 @@ The lab is easier to understand when it is broken into roles instead of treated
| Storage and backups | [Storage and Monitoring](docs/storage-monitoring.md), [Storage and Backups](docs/storage-and-backups.md) | [Synology](services/synology/README.md), [ZFS Storage](services/zfs-storage/README.md), [Proxmox Backup Server](services/proxmox-backup-server/README.md) |
| Observability | [Storage and Monitoring](docs/storage-monitoring.md), [Service Matrix](docs/service-matrix.md) | [Monitoring](services/monitoring/README.md) |
| Media | [Apps and AI](docs/apps-and-ai.md), [Service Matrix](docs/service-matrix.md) | [Media Stack](services/media-stack/README.md) |
| Local AI | [Apps and AI](docs/apps-and-ai.md), [Content Map](docs/content-map.md) | [Local AI](services/local-ai/README.md) |
| Local AI | [Apps and AI](docs/apps-and-ai.md), [Learning Paths](docs/learning-paths.md) | [Local AI](services/local-ai/README.md) |
| Documentation and dashboard | [Apps and AI](docs/apps-and-ai.md), [Diagrams](diagrams/README.md) | [Wiki.js](services/wiki/README.md), [Glance Dashboard](services/glance/README.md) |
| Personal apps | [Apps and AI](docs/apps-and-ai.md), [Security Notes](docs/security-notes.md) | [FinanceHQ](services/financehq/README.md), [CareerFill](services/careerfill/README.md) |
| Automation | [Apps and AI](docs/apps-and-ai.md), [Maintenance Checklist](docs/maintenance-checklist.md) | [AWX / Ansible](services/automation-awx/README.md) |
Expand Down Expand Up @@ -94,7 +94,7 @@ All names and networks in public examples use sanitized values such as `home.exa
|---|---|
| A public learning resource for KeepItTechie viewers | A dump of private production configs |
| A sanitized architecture guide | A live DNS zone or firewall export |
| A companion to homelab videos | A credential store |
| A guide to safe homelab patterns | A credential store |
| A rebuild and documentation aid | A full backup of the lab |
| A place for safe examples | A place for real secrets, keys, or private data |

Expand All @@ -112,22 +112,22 @@ Short version: this repo teaches the lab design. It is not a live backup, invent

For a beginner-friendly walkthrough, use the [Viewer Guide](docs/viewer-guide.md). For deeper navigation, use the [Documentation Index](docs/docs-index.md) and [Glossary](docs/glossary.md).

## YouTube Companion Series
## Guides and Learning Paths

This repo is designed to support KeepItTechie videos. The companion plan is here:
Use these pages when you want a guided path through the repo instead of browsing every service one by one:

- [Episode Companion Pages](docs/episodes/README.md)
- [Full Homelab Tour Companion](docs/episodes/full-homelab-tour.md)
- [Homelab DNS and Pi-hole Companion](docs/episodes/dns-pihole.md)
- [Proxmox VM Layout Companion](docs/episodes/proxmox-vm-layout.md)
- [Homelab Backups and Restore Testing Companion](docs/episodes/backups-restore.md)
- [Homelab Monitoring with Grafana and Prometheus Companion](docs/episodes/monitoring-grafana.md)
- [Homelab Reverse Proxy and Internal HTTPS Companion](docs/episodes/reverse-proxy.md)
- [Local AI on Linux Companion](docs/episodes/local-ai.md)
- [YouTube Companion Series](docs/youtube-series.md)
- [Homelab Guides](docs/guides/README.md)
- [Learning Paths](docs/learning-paths.md)
- [Full Homelab Tour Guide](docs/guides/full-homelab-tour.md)
- [Homelab DNS and Pi-hole Guide](docs/guides/dns-pihole.md)
- [Proxmox VM Layout Guide](docs/guides/proxmox-vm-layout.md)
- [Homelab Backups and Restore Testing Guide](docs/guides/backups-restore.md)
- [Homelab Monitoring with Grafana and Prometheus Guide](docs/guides/monitoring-grafana.md)
- [Homelab Reverse Proxy and Internal HTTPS Guide](docs/guides/reverse-proxy.md)
- [Local AI on Linux Guide](docs/guides/local-ai.md)
- [Content Map](docs/content-map.md)

Planned topics include the full homelab tour, pfSense, Pi-hole, Proxmox, Proxmox Backup Server, Synology vs ZFS, reverse proxying, Cloudflare Tunnel, Grafana monitoring, local AI, dashboards, AWX, and local-first personal apps.
Core guide topics include the full homelab tour, pfSense, Pi-hole, Proxmox, Proxmox Backup Server, Synology vs ZFS, reverse proxying, Cloudflare Tunnel, Grafana monitoring, local AI, dashboards, AWX, and local-first personal apps.

## Security First

Expand Down
2 changes: 1 addition & 1 deletion assets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ No real screenshots or dashboard images are included yet. Any future image added
|---|---|
| `assets/diagrams/` | Exported public-safe diagrams |
| `assets/screenshots/` | Reviewed screenshots or demo screenshots |
| `assets/thumbnails/` | YouTube, GitHub, or social preview images |
| `assets/thumbnails/` | GitHub or social preview images |
| `assets/mockups/` | Recreated UI mockups and fake-data visuals |

## Rules Before Adding Images
Expand Down
6 changes: 3 additions & 3 deletions docs/apps-and-ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ This page is the beginner-friendly entry point for the application, media, dashb

These services sit on top of the core infrastructure, storage, backups, monitoring, and reverse proxy layers. They are the part viewers are most likely to recognize from daily use, but they also carry the most private data.

For a visual reference, see the [local AI flow diagram](../diagrams/local-ai-flow.md). For the episode companion, see [Local AI on Linux](episodes/local-ai.md). For unfamiliar app, endpoint, and public-safe documentation terms, use the [Glossary](glossary.md).
For a visual reference, see the [local AI flow diagram](../diagrams/local-ai-flow.md). For the guide, see [Local AI on Linux](guides/local-ai.md). For unfamiliar app, endpoint, and public-safe documentation terms, use the [Glossary](glossary.md).

## Recommended Reading Order

| Step | Topic | Link | Why Start Here |
|---|---|---|---|
| 1 | Local AI | [Local AI Stack](../services/local-ai/README.md), [Local AI Companion](episodes/local-ai.md) | Learn the GPU, endpoint, model, and Open WebUI pattern |
| 1 | Local AI | [Local AI Stack](../services/local-ai/README.md), [Local AI Guide](guides/local-ai.md) | Learn the GPU, endpoint, model, and Open WebUI pattern |
| 2 | Dashboard | [Glance / Homepage Dashboard](../services/glance/README.md) | See how services are grouped for daily use |
| 3 | Documentation | [Wiki.js](../services/wiki/README.md) | Learn public/private documentation boundaries |
| 4 | Media | [Media Stack](../services/media-stack/README.md) | Understand storage-heavy multi-app workflows |
Expand Down Expand Up @@ -65,7 +65,7 @@ Do not document:

- [Core Infrastructure](core-infrastructure.md)
- [Storage and Monitoring](storage-monitoring.md)
- [Local AI on Linux Companion](episodes/local-ai.md)
- [Local AI on Linux Guide](guides/local-ai.md)
- [Glossary](glossary.md)
- [How To Read Service Pages](how-to-read-service-pages.md)
- [Public-Safe Diagrams](../diagrams/README.md)
Expand Down
20 changes: 10 additions & 10 deletions docs/build-your-own.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Focus on:

Related docs:

- [Homelab DNS and Pi-hole Companion](episodes/dns-pihole.md)
- [Homelab DNS and Pi-hole Guide](guides/dns-pihole.md)
- [Pi-hole](../services/pihole/README.md)
- [Pi-hole DNS Example](../examples/pihole/README.md)

Expand All @@ -92,7 +92,7 @@ Service identity is the name users remember, such as `proxy.home.example.com`. M

Related docs:

- [Proxmox VM Layout Companion](episodes/proxmox-vm-layout.md)
- [Proxmox VM Layout Guide](guides/proxmox-vm-layout.md)
- [Proxmox](../services/proxmox/README.md)
- [Core Infrastructure](core-infrastructure.md)

Expand Down Expand Up @@ -133,7 +133,7 @@ A backup is only useful when the restore path works. Keep a short restore log so

Related docs:

- [Homelab Backups and Restore Testing Companion](episodes/backups-restore.md)
- [Homelab Backups and Restore Testing Guide](guides/backups-restore.md)
- [Storage and Backups](storage-and-backups.md)
- [Proxmox Backup Server](../services/proxmox-backup-server/README.md)
- [Backup Flow Diagram](../diagrams/backup-flow.md)
Expand All @@ -155,7 +155,7 @@ Monitoring is useful when it helps answer: what changed, what is unhealthy, and

Related docs:

- [Homelab Monitoring with Grafana and Prometheus Companion](episodes/monitoring-grafana.md)
- [Homelab Monitoring with Grafana and Prometheus Guide](guides/monitoring-grafana.md)
- [Monitoring](../services/monitoring/README.md)
- [Monitoring Flow Diagram](../diagrams/monitoring-flow.md)

Expand All @@ -175,7 +175,7 @@ Not every dashboard should be public. Hypervisors, backup systems, admin dashboa

Related docs:

- [Homelab Reverse Proxy and Internal HTTPS Companion](episodes/reverse-proxy.md)
- [Homelab Reverse Proxy and Internal HTTPS Guide](guides/reverse-proxy.md)
- [Reverse Proxy](../services/reverse-proxy/README.md)
- [Cloudflare Tunnel](../services/cloudflare-tunnel/README.md)
- [NGINX Example](../examples/nginx/README.md)
Expand Down Expand Up @@ -221,7 +221,7 @@ A GPU helps with many workloads, but it is not required to learn the architectur

Related docs:

- [Local AI on Linux Companion](episodes/local-ai.md)
- [Local AI on Linux Guide](guides/local-ai.md)
- [Local AI](../services/local-ai/README.md)
- [Local AI Flow Diagram](../diagrams/local-ai-flow.md)

Expand Down Expand Up @@ -266,16 +266,16 @@ Related docs:
| 4 | Virtualization | [Proxmox](../services/proxmox/README.md), [Core Infrastructure](core-infrastructure.md) |
| 5 | Storage | [Storage and Monitoring](storage-monitoring.md), [Synology NAS](../services/synology/README.md), [ZFS Storage](../services/zfs-storage/README.md) |
| 6 | Backups | [Storage and Backups](storage-and-backups.md), [Backup Flow Diagram](../diagrams/backup-flow.md) |
| 7 | Monitoring | [Monitoring](../services/monitoring/README.md), [Monitoring Companion](episodes/monitoring-grafana.md), [Monitoring Flow Diagram](../diagrams/monitoring-flow.md) |
| 8 | Reverse proxying | [Reverse Proxy](../services/reverse-proxy/README.md), [Reverse Proxy Companion](episodes/reverse-proxy.md), [NGINX Example](../examples/nginx/README.md) |
| 7 | Monitoring | [Monitoring](../services/monitoring/README.md), [Monitoring Guide](guides/monitoring-grafana.md), [Monitoring Flow Diagram](../diagrams/monitoring-flow.md) |
| 8 | Reverse proxying | [Reverse Proxy](../services/reverse-proxy/README.md), [Reverse Proxy Guide](guides/reverse-proxy.md), [NGINX Example](../examples/nginx/README.md) |
| 9 | Self-hosted apps | [Apps and AI](apps-and-ai.md), [Service Catalog](service-catalog.md) |
| 10 | Local AI | [Local AI](../services/local-ai/README.md), [Local AI Companion](episodes/local-ai.md), [Local AI Flow Diagram](../diagrams/local-ai-flow.md) |
| 10 | Local AI | [Local AI](../services/local-ai/README.md), [Local AI Guide](guides/local-ai.md), [Local AI Flow Diagram](../diagrams/local-ai-flow.md) |
| 11 | Automation | [AWX / Ansible Automation](../services/automation-awx/README.md), [Sanitized Examples](../examples/README.md) |

## Related Docs

- [Current Setup](current-setup.md)
- [Full Homelab Tour Companion](episodes/full-homelab-tour.md)
- [Full Homelab Tour Guide](guides/full-homelab-tour.md)
- [Viewer Guide](viewer-guide.md)
- [Documentation Index](docs-index.md)
- [Glossary](glossary.md)
Expand Down
123 changes: 42 additions & 81 deletions docs/content-map.md
Original file line number Diff line number Diff line change
@@ -1,86 +1,47 @@
# KeepItTechie Content Map
# Content Map

This repo can support a full KeepItTechie homelab series. Each topic should connect a real lab service to a practical lesson viewers can reuse.
This page maps the repo by learning topic. It is meant to help readers connect a homelab area to the docs, diagrams, guides, and sanitized examples that explain it.

For the more detailed episode-by-episode plan, see [YouTube Companion Series](youtube-series.md).
For guided reading paths, see [Learning Paths](learning-paths.md).

## Series Structure
## Topic Map

| Episode | Topic | Viewer Takeaway |
| Topic | Reader Takeaway | Start Here |
|---|---|---|
| 1 | Full homelab overview | How the pieces fit together without getting lost in tools |
| 2 | pfSense firewall design | Basic routing, DHCP, firewall rules, and safe exposure |
| 3 | Pi-hole DNS pair | Local DNS, redundancy, ad blocking, and service names |
| 4 | Proxmox virtualization | Why VMs make a homelab easier to test and rebuild |
| 5 | Proxmox Backup Server | Backups, retention, and restore tests that actually matter |
| 6 | Synology plus ZFS storage | Appliance NAS vs Linux storage server tradeoffs |
| 7 | NGINX reverse proxy | Clean internal URLs and service routing |
| 8 | Cloudflare Tunnel | Publishing selected services without opening everything |
| 9 | Monitoring stack | Grafana, Prometheus, logs, exporters, and uptime checks |
| 10 | Media stack | Plex, Servarr, Tautulli, and Tdarr as a real app ecosystem |
| 11 | Local AI | Running AI locally with a GPU server and Open WebUI |
| 12 | Wiki.js | Building a documentation habit for the lab |
| 13 | Glance dashboard | Creating a simple control surface for daily use |
| 14 | FinanceHQ | Local-first personal apps and privacy-minded design |
| 15 | CareerFill | Automation for job search workflows |
| 16 | AWX / Ansible | Turning repeatable admin work into automation |

## Episode Template

```text
Problem:
What pain point does this solve?

Where it fits:
What depends on it, and what does it depend on?

Build:
What are the main install or configuration steps?

Security:
What should stay private?

Demo:
What does success look like?

Failure mode:
What breaks when this service is down?

Takeaway:
What can viewers reuse in their own lab?
```

## Good Demo Angles

| Service | Demo Idea |
|---|---|
| pfSense | Show rule thinking with sanitized networks |
| Pi-hole | Add a local DNS record and resolve a service name |
| Proxmox | Clone or restore a test VM |
| PBS | Restore a VM into an isolated test network |
| Reverse proxy | Add a new internal service identity |
| Monitoring | Build a simple dashboard from node metrics |
| Loki / Promtail | Trace a service issue through logs |
| Media stack | Explain how each app has a different role |
| Local AI | Send a request to a local OpenAI-compatible endpoint |
| Wiki.js | Convert a private runbook idea into a public-safe doc |
| Glance | Build a dashboard section for core services |
| AWX | Run a safe read-only homelab check playbook |

## Public Safety For Videos

- Blur real public domains, real public IPs, tokens, and account identifiers.
- Prefer recreated examples over live admin screens.
- Avoid showing full firewall exports or full DNS record lists.
- Use `home.example.com` and `10.10.0.0/24` in slides and diagrams.
- Keep private Wiki.js admin pages out of public screen recordings.

## Repo Tie-In

Each video can point viewers to:

- The service README for the architecture.
- The sanitized inventory for naming patterns.
- The diagram notes for topology.
- The security notes for what not to publish.
- The [service matrix](service-matrix.md) for access and backup priority.
| Full homelab overview | How the major pieces fit together without getting lost in tools | [Current Setup](current-setup.md), [Full Homelab Tour Guide](guides/full-homelab-tour.md) |
| pfSense firewall design | Basic routing, DHCP, firewall policy, and safe exposure boundaries | [Network Design](network.md), [pfSense](../services/pfsense/README.md) |
| Pi-hole DNS pair | Local DNS, redundancy, filtering, and service names | [Homelab DNS and Pi-hole](guides/dns-pihole.md), [Pi-hole](../services/pihole/README.md) |
| Proxmox virtualization | Why VMs make a homelab easier to test, group, and rebuild | [Proxmox VM Layout](guides/proxmox-vm-layout.md), [Proxmox](../services/proxmox/README.md) |
| Proxmox Backup Server | Backups, retention concepts, and restore tests that actually matter | [Backups and Restore Testing](guides/backups-restore.md), [PBS](../services/proxmox-backup-server/README.md) |
| Synology and ZFS storage | Appliance NAS workflows and Linux storage learning | [Storage and Backups](storage-and-backups.md), [Storage and Monitoring](storage-monitoring.md) |
| NGINX reverse proxy | Clean internal URLs, TLS concepts, and routing to backend apps | [Reverse Proxy Guide](guides/reverse-proxy.md), [Reverse Proxy](../services/reverse-proxy/README.md) |
| Cloudflare Tunnel | Selected public access without publishing every internal service | [Cloudflare Tunnel](../services/cloudflare-tunnel/README.md), [Security Notes](security-notes.md) |
| Monitoring stack | Grafana, Prometheus, logs, exporters, and uptime checks | [Monitoring Guide](guides/monitoring-grafana.md), [Monitoring](../services/monitoring/README.md) |
| Media stack | Plex, Servarr-style automation, Tautulli, and Tdarr as a multi-app workflow | [Media Stack](../services/media-stack/README.md), [Apps and AI](apps-and-ai.md) |
| Local AI | Running AI locally with a GPU server concept, Open WebUI, and private endpoints | [Local AI Guide](guides/local-ai.md), [Local AI Stack](../services/local-ai/README.md) |
| Wiki.js | Building a documentation habit while keeping private notes private | [Wiki.js](../services/wiki/README.md), [Docs Index](docs-index.md) |
| Glance dashboard | Creating a simple daily control surface without exposing admin links | [Glance](../services/glance/README.md), [Apps and AI](apps-and-ai.md) |
| FinanceHQ | Local-first personal app patterns with demo data only | [FinanceHQ](../services/financehq/README.md), [Security Notes](security-notes.md) |
| CareerFill | Career workflow app patterns without publishing job or resume data | [CareerFill](../services/careerfill/README.md), [Security Notes](security-notes.md) |
| AWX / Ansible | Turning repeatable admin work into safe automation patterns | [AWX / Ansible](../services/automation-awx/README.md), [Sanitized Inventory](../inventory/sanitized/hosts.example.yml) |

## How to Use This Map

- Start with the topic that matches the current question.
- Open the guide first if one exists.
- Use service docs to understand purpose, placement, network behavior, backups, and security notes.
- Use diagrams to see the flow visually.
- Use sanitized examples only as templates, not production config.

## Public-Safe Boundaries

This map intentionally avoids exact host IPs, live internal domains, raw exports, credentials, screenshots, serial numbers, MAC addresses, financial data, and career data.

## Related Docs

- [Learning Paths](learning-paths.md)
- [Current Setup](current-setup.md)
- [Build Your Own Homelab](build-your-own.md)
- [Service Catalog](service-catalog.md)
- [Service Matrix](service-matrix.md)
- [Sanitized Examples](../examples/README.md)
Loading
Loading