Home

Setup a homelab in a single command line. AI included.

🔥 QUICK START

curl -fsSL https://raw.githubusercontent.com/saul-salazar-dotcom/homelabx.net/master/install.sh | sh

🚀 FEATURES

• 😎 EASY SETUP: copy & paste one line
• 👌 EASY ACCESS: SSO & MFA enabled by default
• 🛡️ LOCAL HTTPS: SSL Certificates for localhost
• 🎁 APPLICATIONS: Over 10 apps as containers

📦 APPLICATION LIST

▶️ MEDIA

• 📺 tv Stream movies and shows by Jellyfin (netflix, disney+)
• 📺 downloads Multiple downloads manager by JDownloader
• 📺 torrents Torrents downloads manager by QBitTorrent

📄 DOCUMENTATION

• 📕 notes Write notes by memos
• 🆕 changelog Write release notes by OpenChangelog
• 📚 wiki Write documentation with realtime collaboration by Outline (confluence, notion)
• 🖍️ whiteboard Write & draw with realtime collaboration by AFFiNE (miro, nuclino, mural)

🛠️ TOOLS

• 🎨 design Build interactive prototypes by Penpot (figma, adobe xd)
• 🧐 read Save links to read later by Readeck
• 📅 schedule Create scheduling polls by Rallly
• 📋 plan Project Management (kanban,list,gantt) by vikunja
• 📋 ai AI Chatbot by ollama (chatGPT)

🏗️ INFRASTRUCTURE

• 🔀 proxy Reverse Proxy by Traefik and mkcert
• 🔐 auth Single Sign On and Multi Factor Authentication by Authelia
• ✉️ smtp Catches and displays email by mailcatcher

🎯 ROADMAP

• 📈 uptime Uptime monitoring tool by Uptime Kuma
• 🔔 ntfy Push notifications by ntfy
• 🌎 vpn Network Security (VPN) by Firezone
• 📰 rss News aggregator by FreshRSS
• 📊 grafana Monitoring dashboards by Grafana
• 🐋 docker Docker Management GUI by Portainer
• 💬 forum Discuss/debate topics by Misago
• 🔀 workflow Data pipelines automation Windmill
• 🍽️ recipes cooking recipes by Mealie
• 🛰️ remote Remote Device Management by MeshCentral
• 💻 support Remote Device Control by RustDesk (teamviewer)
• 📈 tickets support/ticketing solution by Zammad (jira)
• 🖵 pgadmin Postgres management tool by PgAdmin
• 🛠️ pocketbase Backend with DB, auth and file storage by PocketBase (firebase, supabase)

🧐 LEARN MORE

You should read the Docker Compose specification to know how this works.

• Why use Compose?
• Compose Application Model

⭐ KEY CONCEPTS

• We follow the KISS principle (Keep it simple, stupid!)
• Each application consists of minimum 3 things:
  1. Folder with an Useful Name
  2. docker-compose.yml file
  3. README.md file.
• An Useful Name has:
  • - hyphens instead of whitespaces
  • keyword (s) to describe the app (for example jellyfin app has the tv folder)
• If possible we skip the .env files.
• No version declaration at the beginning of the compose file, as the practice was deprecated.
• For persistent storage bind mount ./data_whatever is used. Only relative path next to the compose file.

🐋 REQUIREMENTS

The only requirement is Docker, which has multiple installation methods depending on your platform:

• First the Official Guides.
• Linux and Mac (ref):

curl -fsSL https://get.docker.com | sh

• Windows needs the Docker Desktop application and WSL enabled (Windows Subsystem for Linux) because the Docker Engine doesnt have Windows Support.