Debian Repository Manager for multi-distribution package management
Project description
Debian Repository Manager (debrepomanager)
A system for managing multiple Debian-like repositories with support for multiple distributions, architectures, and package collections, featuring atomic updates and GitHub Actions integration.
Features
- 🚀 Atomic updates via aptly snapshots
- 🔄 Multi-codename: bookworm, noble, trixie, jammy, etc.
- 🏗️ Multi-architecture: amd64, arm64, riscv64
- 📦 Multi-component: various package collections
- 🔐 GPG signing for all repositories
- 🧹 Retention policies: automatic cleanup of old versions
- 🤖 GitHub Actions: CI/CD pipeline integration
- 🔍 Verification: repository consistency checks
- 🔀 Dual format: old and new APT URL formats support
Architecture
Built on top of aptly with:
- Multi-root isolation (separate aptly root per codename)
- Snapshots for atomic operations
- Python CLI for easy management
- GitHub Actions for automation
See ARCHITECTURE.md for detailed description.
Requirements
Server
- aptly >= 1.5.0
- gpg (GnuPG) >= 2.2
- Python >= 3.11
- rsync (for GitHub Actions)
- SSH server (for GitHub Actions)
Development
- Python >= 3.11 (tested on 3.11, 3.12, 3.13)
- pip
- virtualenv (recommended)
- Docker (for integration tests)
Installation
From PyPI
pip install debrepomanager
From source
git clone https://github.com/jethome-iot/repomanager.git
cd repomanager
pip install -e .
For development
git clone https://github.com/jethome-iot/repomanager.git
cd repomanager
# Create virtual environment
python3 -m venv venv
source venv/bin/activate
# Install dependencies
pip install -e ".[dev]"
# Run tests
pytest
Quick Start
# Create repository
debrepomanager create-repo --codename bookworm --component jethome-tools
# Add packages
debrepomanager add --codename bookworm --component jethome-tools --package-dir /path/to/packages/
# List repositories
debrepomanager list
# List packages in repository
debrepomanager list --codename bookworm --component jethome-tools
Configuration
Auto-Detection (Recommended)
debrepomanager automatically finds configuration files:
# No --config needed! Searches standard locations:
# 1. /etc/repomanager/config.yaml
# 2. ~/.repomanager/config.yaml
# 3. ./repomanager.yaml
debrepomanager list
debrepomanager create-repo bookworm jethome-tools
Configuration Priority
Priority (low → high):
/etc/repomanager/config.yaml- System-wide~/.repomanager/config.yaml- User-level./repomanager.yaml- Local directory--config path- Explicit overrideREPOMANAGER_*env vars - Highest priority
Minimal Configuration
Create ~/.repomanager/config.yaml:
gpg:
key_id: "YOUR_GPG_KEY_ID"
aptly:
root_base: "/srv/aptly"
publish_base: "/srv/repo/public"
repositories:
architectures: [amd64, arm64, riscv64]
Note: Codenames and components are created dynamically - no need to list them!
Environment Variables
export REPOMANAGER_APTLY_ROOT_BASE=/custom/path
export REPOMANAGER_GPG_KEY_ID=TESTKEY123
debrepomanager list
See docs/CONFIG.md and config.yaml.example for all options.
Usage
Quick Upload Script (repoadd)
For simplified package uploads with stable/beta/test environment support:
# Upload to stable repository
scripts/repoadd stable bookworm armbian-bookworm
# Upload to beta repository
scripts/repoadd beta noble jethome-tools
# Upload to test repository
scripts/repoadd test bookworm ./packages/
The script automatically creates repositories if needed and handles component naming.
See REPOADD_SCRIPT.md for detailed documentation.
Create repository
debrepomanager create-repo --codename bookworm --component jethome-tools
Add packages
# Add specific packages
debrepomanager add --codename bookworm --component jethome-tools \
--packages package1.deb package2.deb
# Add all packages from directory
debrepomanager add --codename bookworm --component jethome-tools \
--package-dir /path/to/packages/
List repositories and packages
# List all repositories
debrepomanager list
# List repositories for specific codename
debrepomanager list --codename bookworm
# List packages in repository
debrepomanager list --codename bookworm --component jethome-tools
Delete repository
debrepomanager delete-repo --codename bookworm --component old-component --confirm
Client Configuration
Debian Bookworm
# Import GPG key
wget -qO - http://repo.site.com/pubkey.gpg | \
sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/jethome.gpg
# Add repository (new format)
echo "deb http://repo.site.com/bookworm jethome-tools main" | \
sudo tee /etc/apt/sources.list.d/jethome.list
# Update
sudo apt update
# Install packages
sudo apt install your-package
Ubuntu Noble
# Import GPG key
wget -qO - http://repo.site.com/pubkey.gpg | \
sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/jethome.gpg
# Add repository
echo "deb http://repo.site.com/noble jethome-tools main" | \
sudo tee /etc/apt/sources.list.d/jethome.list
# Update
sudo apt update
Dual Format Support
The system supports both old and new APT URL formats simultaneously:
Old format (backward compatibility):
deb http://repo.site.com bookworm jethome-tools
New format (recommended):
deb http://repo.site.com/bookworm jethome-tools main
Both formats work simultaneously via symlinks. See DUAL_FORMAT.md for technical details.
Repository URL Structure
Repositories are accessible via:
http://repo.site.com/{codename}/{component}
Examples:
http://repo.site.com/bookworm/jethome-tools
http://repo.site.com/noble/jethome-armbian
http://repo.site.com/trixie/jethome-bookworm
Development
Project Structure
debrepomanager/
├── debrepomanager/ # Main package
│ ├── __init__.py
│ ├── cli.py # CLI interface
│ ├── aptly.py # Aptly wrapper
│ ├── config.py # Configuration management
│ ├── gpg.py # GPG operations
│ └── utils.py # Utilities
├── tests/ # Tests
├── docs/ # Documentation
├── .github/workflows/ # GitHub Actions
└── config.yaml.example # Configuration example
Running Tests
# All tests
pytest
# With coverage
pytest --cov=debrepomanager --cov-report=html
# Specific module
pytest tests/test_config.py
# Verbose
pytest -v
Code Quality
Project uses:
- Black for formatting (spaces, not tabs)
- flake8 for linting
- mypy for type checking
# Format
black debrepomanager/
# Lint
flake8 debrepomanager/
# Type check
mypy debrepomanager/
Documentation
For Users
- Quick Start - 5-minute getting started guide
- Deployment Guide - Complete deployment instructions
- APT Configuration - Client setup for all systems
- repoadd Script - Simplified upload script for stable/beta/test
For Administrators
- Configuration Reference - Detailed config options
For Developers
- Architecture - Architecture decisions
- Development Guide - Developer workflow
- Changelog - Version history
Troubleshooting
GPG signing fails
# Check key availability
gpg --list-secret-keys
# Check gpg-agent
gpg-connect-agent 'keyinfo --list' /bye
# Restart gpg-agent
gpgconf --kill gpg-agent
gpg-connect-agent /bye
Aptly errors
# Check repository status
debrepomanager list
# Check snapshots (via aptly directly)
aptly -config /srv/aptly/bookworm/aptly.conf snapshot list
# Check published repositories
aptly -config /srv/aptly/bookworm/aptly.conf publish list
Permission issues
# Check permissions
ls -la /srv/aptly/
ls -la /srv/repo/public/
# Fix permissions
chown -R repomanager:repomanager /srv/aptly/
chown -R www-data:repomanager /srv/repo/public/
chmod -R g+w /srv/aptly/ /srv/repo/public/
GitHub Actions Integration
For CI/CD workflows, configure GitHub Secrets:
SSH_PRIVATE_KEY: SSH key for server accessSSH_HOST: Server address (e.g., repo.site.com)SSH_USER: SSH user (e.g., repomanager)GPG_PRIVATE_KEY: GPG private key (base64 encoded)GPG_PASSPHRASE: GPG key passwordGPG_KEY_ID: GPG key ID
See Quick Start Guide for GitHub Actions examples.
License
MIT License - see LICENSE
Authors
JetHome Team
Contributing
Pull requests are welcome! Please make sure to:
- Add tests for new functionality
- Update documentation
- Follow code style (black, flake8)
- Ensure all tests pass
Links
- Documentation: docs/
- PyPI: https://pypi.org/project/debrepomanager/
- Issues: https://github.com/jethome-iot/repomanager/issues
- Discussions: https://github.com/jethome-iot/repomanager/discussions
Project Status
- Version: 0.1.2
- Status: Production Ready (95% MVP)
- Tests: 194 tests, 93% coverage
- Python: 3.11, 3.12, 3.13 supported
Made with ❤️ by JetHome Team
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file debrepomanager-0.2.0.tar.gz.
File metadata
- Download URL: debrepomanager-0.2.0.tar.gz
- Upload date:
- Size: 161.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a2cc6b651f9f3fe5298f410b4004196e6cfb4993c1856b5c12ec589ab77665a1
|
|
| MD5 |
8bf839a5872c992cb36eb30425490b99
|
|
| BLAKE2b-256 |
149dd189a7471fcac4e88e9f5ba1cc3c74fe3fa8f405c3c4d04aa4994d6ba5ab
|
File details
Details for the file debrepomanager-0.2.0-py3-none-any.whl.
File metadata
- Download URL: debrepomanager-0.2.0-py3-none-any.whl
- Upload date:
- Size: 31.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7cdcd8899d7e28bf3908b8cd62ddd39790fe9080c223b44e49f1508e121eefc6
|
|
| MD5 |
71024567f772916a318ab46797e286f2
|
|
| BLAKE2b-256 |
4c10e02e3c818429aac79d54227e4768311331ba50dc0fad3087d7569797259c
|