kelin/EZ-Homelab
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation for v0.1.0 release

Browse Source
This commit is contained in:
kelinfoxy
2026-01-27 13:42:06 -05:00
parent 552f0240b5
commit 4adaeae7ce
6 changed files with 183 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/automated-setup.md
View File

@@ -91,4 +91,10 @@ The `ez-homelab.sh` script is a comprehensive guided setup and deployment tool:
- Timeout handling (60s for Docker operations)
- Comprehensive error messages with troubleshooting hints
- Safe to re-run (idempotent operations)
- Confirmation prompts for destructive actions
- Confirmation prompts for destructive actions
## Release-Specific Notes
- **Version**: Based on v0.1.0—ensure you're using the latest scripts.
- **Stacks**: Core, Infrastructure, and Dashboards deploy automatically. Others are inactive by default.
- **Dashboards**: Homepage is preconfigured at `homepage.yoursubdomain.duckdns.org`.
- **Known Limitations**: Options 1 & 2 require additional testing; use Option 3 for production.

8
docs/getting-started.md
View File

@@ -2,6 +2,14 @@
Welcome to your AI-powered homelab! This guide will walk you through setting up your production-ready infrastructure with Dockge, Traefik, Authelia, and [50+ services](services-overview.md).
## Release v0.1.0 Highlights
This is the first official release of EZ-Homelab, thoroughly tested on Debian 12. Key features include:
- Automated SSL via DuckDNS and Let's Encrypt.
- Authelia SSO enabled by default for security.
- Sablier lazy loading to save resources.
- 50+ preconfigured services across 10 stacks.
- See [Release Notes](../release-notes-v0.1.0.md) for full details.
## Getting Started Checklist
- [ ] Clone this repository to your home folder
- [ ] Configure `.env` file with your domain and tokens ([see prerequisites](env-configuration.md))

5
docs/manual-setup.md
View File

@@ -260,6 +260,11 @@ docker network create network-name
- You need custom configurations
- You're troubleshooting deployment issues
## Post-Setup Notes
- **Lazy Loading**: Services use Sablier for resource efficiency. Expect short delays on first access—refresh if you see timeouts.
- **Security**: SSO is enabled by default; bypass only for media apps like Plex/Jellyfin.
- **Testing**: This release has been thoroughly tested, but manual setup may need tweaks—report issues on GitHub.
## Switching to Automated
If manual setup works, you can switch to the unified automated script for future updates: