103 lines
3.5 KiB
Markdown
103 lines
3.5 KiB
Markdown
# Changelog
|
|
|
|
All notable changes to the tower-of-joy project will be documented in this file.
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
|
## [Unreleased]
|
|
|
|
### Planned
|
|
- NVIDIA Container Toolkit installation
|
|
- Portainer deployment
|
|
- Nginx Proxy Manager deployment
|
|
- Ollama ML infrastructure
|
|
- Headscale secure networking
|
|
- Monitoring stack (Uptime Kuma, Netdata, Heimdall)
|
|
|
|
## [0.1.0-planning] - 2025-11-11
|
|
|
|
### Added
|
|
- Initial project structure and documentation
|
|
- Comprehensive research document (containers/research.md)
|
|
- Evaluated 8 different home server solutions
|
|
- Identified Portainer + Docker Compose as optimal choice
|
|
- Researched SDN solutions (Headscale vs Tailscale)
|
|
- Detailed implementation plan (containers/implementation-plan.md)
|
|
- 4-phase deployment strategy
|
|
- Phase 1: Foundation (Portainer, NPM, Ollama, storage)
|
|
- Phase 2: Networking (Headscale)
|
|
- Phase 3: Monitoring (Uptime Kuma, Netdata, Heimdall)
|
|
- Phase 4: Optimization (Watchtower, backups, security)
|
|
- Application backlog (Jellyfin, Nextcloud, Samba)
|
|
- System documentation (SYSTEM.md)
|
|
- Hardware specifications
|
|
- Dual-disk storage configuration
|
|
- Software inventory
|
|
- Agent guidelines (AGENTS.md)
|
|
- Project-specific conventions
|
|
- Docker Compose standards
|
|
- GPU service requirements
|
|
- Testing procedures
|
|
- Commit message format
|
|
- Project status tracking (STATUS.md)
|
|
- Version-controlled infrastructure (stacks/ directory)
|
|
- Maintenance automation (scripts/ directory, Makefile)
|
|
|
|
### Documented
|
|
- Storage architecture: SSD (489GB) for configs, HDD (3.7TB) for content
|
|
- Port allocation strategy
|
|
- AMP game server integration approach
|
|
- GPU passthrough requirements for Jellyfin and Ollama
|
|
- Security considerations (Headscale, UFW, credentials management)
|
|
|
|
### Decisions
|
|
- **Architecture:** Portainer + Docker Compose (chosen over TrueNAS Scale, Unraid, Proxmox)
|
|
- Reason: No OS reinstall required, leverages existing Docker, minimal storage footprint
|
|
- **Reverse Proxy:** Nginx Proxy Manager on port 8000 (unified web interface)
|
|
- **SDN:** Headscale (self-hosted Tailscale control server)
|
|
- **ML Infrastructure:** Ollama with GPU support (RTX 2080 Ti)
|
|
- **Monitoring:** Uptime Kuma + Netdata + Heimdall
|
|
- **Storage Strategy:** Dual-disk approach (SSD for performance, HDD for capacity)
|
|
|
|
---
|
|
|
|
## Changelog Guidelines
|
|
|
|
### Categories
|
|
Use these categories for changes:
|
|
- **Added** - New features, services, or capabilities
|
|
- **Changed** - Changes to existing functionality
|
|
- **Deprecated** - Soon-to-be-removed features
|
|
- **Removed** - Removed features
|
|
- **Fixed** - Bug fixes
|
|
- **Security** - Security improvements
|
|
|
|
### Version Numbering
|
|
- **Major (X.0.0)**: Breaking changes, major architecture changes
|
|
- **Minor (0.X.0)**: New features, service additions, phase completions
|
|
- **Patch (0.0.X)**: Bug fixes, configuration tweaks, documentation updates
|
|
- **Suffix**: `-planning`, `-alpha`, `-beta` for pre-release stages
|
|
|
|
### Example Entry Template
|
|
```markdown
|
|
## [X.Y.Z] - YYYY-MM-DD
|
|
|
|
### Added
|
|
- feat(stack): deployed nginx proxy manager for unified web interface
|
|
- feat(ollama): configured GPU passthrough for ML model inference
|
|
|
|
### Changed
|
|
- config(amp): moved from port 8080 to 8081 to avoid conflicts
|
|
|
|
### Fixed
|
|
- fix(storage): corrected permissions on media drive mount
|
|
|
|
### Security
|
|
- chore(firewall): configured UFW rules for service isolation
|
|
```
|
|
|
|
---
|
|
|
|
*This changelog will be updated as phases are completed*
|