BREAKING CHANGES - Migration Required
This release completely overhauls the Docker setup to provide a much simpler and more reliable experience. The old Docker volume structure is no longer supported.
What's Fixed
- Critical Preview Generation Bug: Fixed corrupted 14-byte asset files affecting GitHub Docker images
- Complex Setup Process: Eliminated need for external
fonts.zip
andimages.zip
downloads - File Permission Issues: Added PUID/PGID support for proper host system permissions
What's New
Simplified Docker Setup
- 3 volume mounts instead of 8+ individual file mounts
- One-command deployment: Just
docker-compose up -d
- Auto-configuration: Default config files created automatically
- Built-in assets: All fonts and images included in Docker image
Better Permission Handling
- PUID/PGID support: Set to match your host user
- Automatic user management: Container handles all user/group setup
- No more permission errors: Works out of the box
Migration Required
Before (v1.x)
volumes:
- ./settings.yaml:/app/settings.yaml:rw
- ./badge_settings_audio.yml:/app/badge_settings_audio.yml:rw
- ./fonts:/app/fonts:ro
- ./images:/app/images:ro
# ... 6+ more mounts
After (v2.x)
volumes:
- ./config:/app/config:rw
- ./posters:/app/posters:rw
- ./data:/app/data:rw
environment:
- PUID=${PUID:-1000}
- PGID=${PGID:-1000}
Quick Migration Steps
- Backup configs:
mkdir -p ./config && cp settings.yaml badge_settings_*.yml ./config/
- Update docker-compose.yml to new format (see above)
- Set PUID/PGID to match your user:
id $(whoami)
- Restart:
docker-compose up -d
Why This Breaking Change?
The old setup had critical issues:
- Preview generation completely broken in GitHub Docker images
- Complex 15+ minute setup process with multiple downloads
- Frequent file permission problems
- Unreliable asset mounting causing corrupted files
The new setup provides:
- One-minute setup from start to finish
- 100% reliable preview generation
- Zero permission issues with PUID/PGID
- No external downloads required
Compatibility
- ✅ All existing configuration file formats still work
- ✅ All API endpoints and functionality unchanged
- ✅ CLI usage remains the same
- ❌ Docker volume mount structure requires migration