warderhomelab/homelab-compose
1
0
Fork 0
Code Issues 3 Pull requests 5 Projects Releases Packages Wiki Activity Actions
No description
172 commits 7 branches 0 tags 1.1 MiB
  • Python 40.1%
  • Dockerfile 31.7%
  • Shell 25.1%
  • Makefile 3.1%
Find a file
Exact
pwarder 9c8a908863
All checks were successful
Markdown Link Check / links (push) Successful in 4s
Details
Secret Scan / gitleaks (push) Successful in 6s
Details
Validate Homelab Compose Repository / validate (push) Successful in 22s
Details
Merge pull request 'fix: add missing Rallly environment variables' (#33) from chore/template-audit into main 
Reviewed-on: #33
2026-06-22 01:12:21 +00:00
.forgejo ci: add local Markdown link validation 2026-06-21 00:01:56 -05:00
apps fix: add missing Rallly environment variables 2026-06-21 20:11:04 -05:00
media docs: standardize README sections for Tdarr Node and Server 2026-06-21 19:20:22 -05:00
monitoring docs: add DNS exporter metadata 2026-06-20 23:10:59 -05:00
networking docs: standardize README sections 2026-06-21 19:19:54 -05:00
scripts ci: add local Markdown link validation 2026-06-21 00:01:56 -05:00
templates Add example environment files and documentation for various applications 2026-06-18 19:28:39 -05:00
.editorconfig chore: add editor configuration 2026-06-20 22:35:02 -05:00
.gitattributes chore: normalize repository file attributes 2026-06-20 22:49:47 -05:00
.gitignore style: normalize file endings 2026-06-20 22:17:57 -05:00
.pre-commit-config.yaml ci: add local Markdown link validation 2026-06-21 00:01:56 -05:00
.yamllint.yml style: normalize file endings 2026-06-20 22:17:57 -05:00
CATALOG.md feat: add Headscale template 2026-06-21 00:38:30 -05:00
CHANGELOG.md docs: add changelog 2026-06-21 00:15:59 -05:00
CODEOWNERS chore: add code owners 2026-06-20 21:28:39 -05:00
CONTRIBUTING.md feat: add issue templates for bug reports and new stack requests, and enhance contributing guidelines 2026-06-20 20:52:48 -05:00
LICENSE style: normalize file endings 2026-06-20 22:17:57 -05:00
Makefile ci: add local Markdown link validation 2026-06-21 00:01:56 -05:00
README.md docs: add license and refresh repository readme 2026-06-20 21:22:23 -05:00
RELEASES.md docs: add release policy 2026-06-20 22:08:47 -05:00
renovate.json style: normalize file endings 2026-06-20 22:17:57 -05:00
RENOVATE_POLICY.md docs: add Renovate update policy 2026-06-20 22:47:31 -05:00
SECURITY.md docs: add security policy 2026-06-20 21:28:29 -05:00
STACK_METADATA.md docs: add stack metadata standard 2026-06-20 22:52:40 -05:00
STANDARDS.md style: normalize file endings 2026-06-20 22:17:57 -05:00

README.md

Homelab Compose

A curated collection of generic Docker Compose templates for self-hosted services.

This repository is organized by category and is intended to provide reusable starting points for applications, media services, networking tools, monitoring platforms, and supporting infrastructure.

Each stack is designed to include:

  • docker-compose.yml
  • .env.example
  • README.md
  • Optional example configuration files when needed

Real deployment values such as passwords, API keys, tokens, private keys, internal hostnames, private IP addresses, and production .env files should never be committed.

Repository Layout

  • apps/ — General self-hosted applications and administrative tools
  • media/ — Media servers, automation, processing, and related tools
  • networking/ — DNS, reverse proxy, VPN, tunneling, and network-related services
  • monitoring/ — Monitoring, status pages, observability, logs, metrics, and alerting tools
  • templates/ — Shared examples, environment templates, and reusable snippets

Getting Started

Browse the category folders and choose a stack.

Each stack README explains its purpose, configuration requirements, ports, persistent storage, networking, security considerations, backups, and upgrade guidance.

Before adapting a template for a real deployment:

  1. Copy .env.example to .env.

  2. Replace placeholder values with deployment-specific settings.

  3. Keep .env and other secret-bearing files untracked.

  4. Review the stack README before deploying.

  5. Validate the Compose configuration:

    docker compose --env-file .env.example -f docker-compose.yml config

Repository Standards

See STANDARDS.md for naming, documentation, configuration, security, and structure requirements.

Catalog

See CATALOG.md for an automatically generated index of available stacks.

Contributing

See CONTRIBUTING.md for contribution requirements, validation expectations, and template guidelines.

Security

Do not commit credentials, API keys, tokens, private certificates, private keys, webhook URLs, internal IP addresses, internal domains, or deployment-specific configuration files.

License

This repository is licensed under the Apache License 2.0. See LICENSE.