NexByteSystems/hblink3-docker-install
1
0
Fork 0
mirror of https://github.com/ShaYmez/hblink3-docker-install.git synced 2025-12-22 13:39:50 +13:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for modern Python virtual environment approach

Browse Source 
Co-authored-by: ShaYmez <76499782+ShaYmez@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot] 2025-12-13 22:08:26 +00:00
parent 36c5e38e35
commit 2860bda260
2 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CHANGELOG.md
View File

@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased] ## [Unreleased]
### Changed ### Changed
- **BREAKING CHANGE - Modern Python Package Management**: For Debian 12+ (Bookworm/Trixie), HBMonv2 now uses a Python virtual environment instead of system-wide package installation
- HBMonv2 Python dependencies installed in isolated virtual environment at `/opt/HBMonv2/venv` for Debian 12+
- pip_install helper function now uses virtual environment for Debian 12+ (PEP 668 compliant)
- systemd service file automatically configured to use virtual environment Python interpreter for Debian 12+
- Added python3-venv to system dependencies for Debian 12+
- Enhanced pip_install helper function with comprehensive error handling and user feedback - Enhanced pip_install helper function with comprehensive error handling and user feedback
- Added proper error checking after all pip package installations - Added proper error checking after all pip package installations
- Improved error messages to help users diagnose installation failures - Improved error messages to help users diagnose installation failures
@ -14,10 +19,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Changed deprecated --force flag to --force-reinstall for attrs package installation - Changed deprecated --force flag to --force-reinstall for attrs package installation
### Fixed ### Fixed
- **Resolved externally-managed-environment errors on Debian 12/13** by using virtual environments instead of --break-system-packages flag
- **Resolved package conflicts with system-installed cryptography** by isolating Python packages in virtual environment
- Silent pip installation failures now properly reported to users - Silent pip installation failures now properly reported to users
- Missing requirements.txt file now handled gracefully with warning instead of silent failure - Missing requirements.txt file now handled gracefully with warning instead of silent failure
- pip installation errors now cause the installer to exit with proper error messages - pip installation errors now cause the installer to exit with proper error messages
### Technical Details
- Debian 10-11: Continues to use standard system-wide pip installation (backward compatible)
- Debian 12+: Uses modern virtual environment approach following PEP 668 standards
- Virtual environment is automatically activated during installation
- pip is upgraded within the virtual environment for latest features
## [1.5.0] - 2024-12-13 ## [1.5.0] - 2024-12-13
### Verified ### Verified

14
README.md
View File

@ -3,7 +3,7 @@
======= =======
This is a multi-arch docker installer for HBlink3 and HBmonV2 combined for Debian 10, 11, 12, and 13 (Trixie). This is a multi-arch docker installer for HBlink3 and HBmonV2 combined for Debian 10, 11, 12, and 13 (Trixie).
**Note:** Debian 12 (Bookworm) and 13 (Trixie) support has been added with proper handling of pip installation restrictions and docker-compose compatibility. See [CHANGELOG.md](CHANGELOG.md) for version history and updates. **Note:** Debian 12 (Bookworm) and 13 (Trixie) support has been added with proper PEP 668 compliant Python package management using virtual environments, and docker-compose compatibility. HBMonv2 now runs in an isolated Python virtual environment on Debian 12+. See [CHANGELOG.md](CHANGELOG.md) for version history and updates.
![HBlink](img/HBLINK_logoV1.png "HBlink") ![HBlink](img/HBLINK_logoV1.png "HBlink")
@ -140,6 +140,18 @@ Within this installation includes the new HBMonv2 by Weldek SP2ONG
* Includes lastheard database with auto cron installed * Includes lastheard database with auto cron installed
* Includes talkgroup html editable page * Includes talkgroup html editable page
### Technical Details - Python Package Management
**Debian 12+ (Bookworm/Trixie):** The installer uses modern Python package management following PEP 668 standards:
- HBMonv2 runs in an isolated Python virtual environment at `/opt/HBMonv2/venv`
- All Python dependencies are installed within this virtual environment, avoiding system-wide package conflicts
- The systemd service automatically uses the virtual environment's Python interpreter
- This approach eliminates "externally-managed-environment" errors and conflicts with system packages
**Debian 10-11:** Standard pip installation to system Python is used for backward compatibility.
This ensures clean, maintainable installations that follow modern Python best practices while maintaining compatibility with older Debian versions.
## Easy Installation And Upgrade ## Easy Installation And Upgrade
The installation can be upgraded either by the use of a future scripts or by manually backing up your configuration and re-running the install script. Also the ability and really cool feature of docker-compose is that its easy to update the container with fresh images! Run by a simple command. Make sure you are in the /etc/hblink3 dir. The installation can be upgraded either by the use of a future scripts or by manually backing up your configuration and re-running the install script. Also the ability and really cool feature of docker-compose is that its easy to update the container with fresh images! Run by a simple command. Make sure you are in the /etc/hblink3 dir.
```sh ```sh