Skip to content

Releases: 1mb-dev/pi-gateway

Pi Gateway v1.4.0

01 Mar 14:46

Choose a tag to compare

Pi Gateway Release v1.4.0

🚀 Features

  • Complete Raspberry Pi homelab bootstrap system
  • Automated SSH hardening and VPN configuration
  • WireGuard VPN server setup with client management
  • System security hardening and monitoring setup
  • Remote access configuration (SSH, VNC, DDNS)

🧪 Testing Infrastructure

  • Comprehensive dry-run mode for safe development
  • 40 unit tests with 100% pass rate
  • QEMU Raspberry Pi emulation for hardware testing
  • Docker integration testing (simple + systemd modes)
  • Multi-platform compatibility

📋 Installation

  1. Download pi-gateway-v1.4.0.tar.gz
  2. Extract: tar -xzf pi-gateway-v1.4.0.tar.gz
  3. Run: make check to validate requirements
  4. Install: make setup on target Raspberry Pi

✅ System Requirements

  • Raspberry Pi 4 (recommended) or compatible ARM64 device
  • Raspberry Pi OS (Debian-based)
  • 8GB+ storage, 2GB+ RAM
  • Internet connectivity for package installation

Full Documentation: See included README and docs/ directory

Pi Gateway v1.3.1

15 Feb 04:46

Choose a tag to compare

Pi Gateway Release v1.3.1

🚀 Features

  • Complete Raspberry Pi homelab bootstrap system
  • Automated SSH hardening and VPN configuration
  • WireGuard VPN server setup with client management
  • System security hardening and monitoring setup
  • Remote access configuration (SSH, VNC, DDNS)

🧪 Testing Infrastructure

  • Comprehensive dry-run mode for safe development
  • 40 unit tests with 100% pass rate
  • QEMU Raspberry Pi emulation for hardware testing
  • Docker integration testing (simple + systemd modes)
  • Multi-platform compatibility

📋 Installation

  1. Download pi-gateway-v1.3.1.tar.gz
  2. Extract: tar -xzf pi-gateway-v1.3.1.tar.gz
  3. Run: make check to validate requirements
  4. Install: make setup on target Raspberry Pi

✅ System Requirements

  • Raspberry Pi 4 (recommended) or compatible ARM64 device
  • Raspberry Pi OS (Debian-based)
  • 8GB+ storage, 2GB+ RAM
  • Internet connectivity for package installation

Full Documentation: See included README and docs/ directory

v1.3.0 - Major Simplification

31 Oct 12:11

Choose a tag to compare

BREAKING CHANGES

Major Simplification Release - Pi Gateway refocused on core mission: secure remote access gateway.

Removed from Core

  • Container orchestration (moved to extensions/containers/)
  • Web status dashboard (moved to extensions/dashboard/)
  • Cloud backup integration (moved to extensions/backup/)
  • Network optimizer (moved to extensions/network/)
  • Auto-maintenance system (moved to extensions/maintenance/)
  • Monitoring system (moved to extensions/monitoring/)

UI Changes

  • Removed all emojis and colors from output (plain text only)
  • Removed progress bars and ASCII art
  • Simplified setup menu (3 choices instead of complex nested menus)
  • Reduced setup.sh from 748 to 352 lines (53% reduction)

Core Focus

Pi Gateway now focuses exclusively on:

  • SSH hardening and secure access
  • WireGuard VPN server setup
  • Firewall configuration
  • System security hardening
  • Optional: Remote desktop (VNC) and Dynamic DNS

Added

  • Extensions system for optional advanced features
  • Plain text output for better scriptability
  • Simplified setup experience
  • Extensions documentation

Changed

  • Refocused project scope on secure remote access
  • Moved advanced features to optional extensions
  • Simplified common.sh (removed colors, emojis)
  • Updated README to reflect new mission

Fixed

  • Version inconsistency between VERSION file and common.sh

Migration Guide

If you used advanced features:

  1. Advanced features still available in extensions/ directory
  2. Run extension scripts manually: sudo extensions/containers/container-support.sh
  3. Extensions are standalone and optional

Core users (SSH + VPN only):

  • No changes needed, setup process is simpler and faster

Full Changelog: https://github.com/vnykmshr/pi-gateway/blob/main/CHANGELOG.md

Pi Gateway v1.2.0 - Enhanced Testing & Quality

21 Sep 01:12

Choose a tag to compare

Enhanced Testing & Quality 🧪

✨ New Features

  • QEMU Pi Emulation Testing: Complete Raspberry Pi environment simulation
  • Enhanced Development Tools: Optimized shellcheck configuration and CI/CD improvements
  • Improved Code Quality: Streamlined lint configuration and better error handling

🧪 QEMU Testing Environment

  • Full hardware emulation with kernel & device tree binaries
  • SSH integration for remote testing capabilities
  • Quick test mode for fast development validation

🔧 Technical Improvements

  • Version consistency across all test files and documentation
  • Enhanced BATS test permissions and CI reliability
  • Cleaner gitignore patterns and reduced redundancy
  • Improved mock system capabilities

📋 Installation

Same as previous versions with enhanced testing:

# Quick install
curl -sSL https://raw.githubusercontent.com/vnykmshr/pi-gateway/main/scripts/quick-install.sh | bash

# QEMU testing (new)
make setup-qemu
make test-integration

🔄 Upgrade from v1.1.0

cd pi-gateway
git pull
# Automatically updated to v1.2.0

Full changelog: https://github.com/vnykmshr/pi-gateway/blob/main/CHANGELOG.md

Pi Gateway v1.1.0 - Production Validated with Comprehensive E2E Testing

17 Sep 00:05

Choose a tag to compare

Pi Gateway v1.1.0 - Production Validated 🎯

Complete homelab automation system with comprehensive end-to-end testing validation and production deployment approval.

🚀 What's New in v1.1.0

🧪 Comprehensive End-to-End Testing Framework

  • Docker-based Pi Simulation: Realistic Raspberry Pi OS environment for safe testing
  • Production Validation Suite: Complete deployment readiness assessment
  • Multiple Testing Levels: Quick validation, comprehensive testing, specialized scenarios
  • Security Testing: Complete validation of all security hardening measures
  • Service Integration Testing: All major components (SSH, VPN, firewall) validated

Production Deployment Approved

  • 100% Unit Test Pass Rate: All 40 BATS tests passing consistently
  • Complete E2E Validation: All functionality tested in simulated Pi environment
  • Security Hardening Verified: Comprehensive security validation completed
  • User Experience Validated: Setup process confirmed reliable and user-friendly
  • Error Handling Robust: All error scenarios handled gracefully

🔧 Enhanced Development Infrastructure

  • CI/CD Pipeline Improved: Fixed shellcheck, security scanning, and test issues
  • Code Quality Enhanced: All linting warnings resolved, formatting standardized
  • Test Automation: Automated testing workflows for continuous validation
  • Documentation Complete: Comprehensive testing documentation and results

🎯 Testing & Validation Results

Test Coverage Metrics

  • 40/40 Unit Tests: 100% pass rate with comprehensive coverage
  • 8 E2E Test Scripts: Complete end-to-end validation framework
  • All Major Components: SSH, VPN, firewall, monitoring, backup systems tested
  • Security Validation: Complete hardening verification with realistic scenarios
  • Performance Testing: Installation time and resource usage validated

Production Readiness Assessment

  • System Requirements: Hardware detection and validation working
  • Package Installation: All dependencies install correctly with error handling
  • Security Hardening: SSH, firewall, system hardening complete
  • Network Services: VPN, SSH, firewall all functional and secured
  • Service Management: All services configure and start properly
  • User Experience: Setup process smooth and well-documented

🏗️ New Testing Framework

Quick Testing

# Fast validation of core functionality
./tests/docker/test-pi-setup.sh

# Quick Pi Gateway validation  
./tests/docker/quick-e2e-test.sh

Comprehensive Testing

# Full Docker-based Pi simulation
./tests/docker/e2e-test.sh --keep-container

# Complete validation with metrics
./tests/docker/comprehensive-test.sh

Existing Testing (Enhanced)

# Unit tests (40 tests, 100% pass rate)
make test-unit

# Dry-run validation (safe, no changes)
make test-dry-run

# Docker integration testing
make test-docker

🔒 Security Validation

Comprehensive Security Testing

  • SSH Hardening: Key-based authentication, password auth disabled, custom port
  • Firewall Configuration: UFW properly configured with secure defaults
  • VPN Security: WireGuard server with proper key management
  • System Hardening: Kernel parameters optimized for security
  • Service Isolation: All services run with minimal required privileges
  • No Security Issues: Trivy scanning shows no vulnerabilities

🚀 Installation (Unchanged)

One-Command Installation

curl -sSL https://raw.githubusercontent.com/vnykmshr/pi-gateway/main/scripts/quick-install.sh | bash

Interactive Setup

curl -sSL https://raw.githubusercontent.com/vnykmshr/pi-gateway/main/scripts/quick-install.sh | bash -s -- --interactive

Manual Installation

git clone https://github.com/vnykmshr/pi-gateway.git
cd pi-gateway
make check    # Verify requirements
make setup    # Run installation

📊 Performance & Reliability

Installation Metrics

  • Setup Time: 10-15 minutes for complete installation
  • Resource Usage: Minimal impact during installation
  • Storage Requirements: ~500MB additional storage
  • Memory Usage: Runs efficiently on 1GB+ RAM systems

Reliability Features

  • Automatic Recovery: Graceful handling of common failures
  • Configuration Backup: Automatic backup before modifications
  • Service Resilience: Services restart automatically on failure
  • Comprehensive Logging: Detailed logs for troubleshooting

📚 Enhanced Documentation

Testing Documentation

Existing Documentation

🎯 Requirements (Unchanged)

Hardware: Raspberry Pi 4/5/500, 32GB+ SD card, reliable network
Software: Raspberry Pi OS, admin router access, SSH client

🔗 What's Next

Pi Gateway v1.1.0 is production-ready with comprehensive validation. The enhanced testing framework ensures:

  • Reliable deployment on real Raspberry Pi hardware
  • Confidence in security configurations
  • Smooth user experience during setup
  • Robust error handling and recovery

Changelog: CHANGELOG.md
Testing Results: tests/docker/
License: MIT - see LICENSE

Deployment Status: ✅ PRODUCTION APPROVED

Pi Gateway v1.0.0 - Production Release

16 Sep 10:21

Choose a tag to compare

Pi Gateway v1.0.0 - Production Release 🚀

Complete homelab automation system with security hardening, VPN setup, and comprehensive testing infrastructure.

✨ What's New

🔐 Security & Hardening

  • SSH hardening with key-based authentication and fail2ban
  • System security hardening with kernel parameters and network protection
  • Advanced firewall configuration with UFW and fail2ban integration
  • User account security with service accounts and permission hardening

🌐 VPN & Remote Access

  • WireGuard VPN server with automated client management and QR codes
  • Dynamic DNS support with Cloudflare integration
  • Remote desktop access via VNC with secure configuration
  • Automated port forwarding setup

🧪 Development & Testing

  • 40+ unit tests with 100% pass rate and comprehensive coverage
  • Virtual sandbox with complete dry-run environment and hardware mocking
  • QEMU integration for full Raspberry Pi emulation
  • Cross-platform Docker testing (simple + systemd modes)

🏠 Homelab Ready

  • One-command installation: curl -sSL https://raw.githubusercontent.com/vnykmshr/pi-gateway/main/scripts/quick-install.sh | bash
  • Service discovery with mDNS and local network integration
  • Monitoring setup with system health monitoring
  • Extension support with plugin architecture for custom services

🛠️ Technical Improvements

Code Quality & Optimization

  • 30% codebase reduction (899 net lines removed, 412 added)
  • Massive deduplication: 21 scripts consolidated with centralized utilities
  • AI bloat removal: Verbose patterns replaced with idiomatic code
  • Zero shellcheck errors across all scripts

Infrastructure as Code

  • Complete version-controlled configurations
  • Comprehensive test coverage with unit, integration, and end-to-end tests
  • CI/CD pipeline with automated testing and quality checks
  • Modular architecture with reusable components

📋 Production Readiness

  • ✅ All 40 unit tests passing (100% pass rate)
  • ✅ Comprehensive security hardening with defense-in-depth
  • ✅ One-command installation tested and validated
  • ✅ Complete documentation with beginner-friendly guides
  • ✅ Clean repository structure following best practices

🚀 Quick Start

# One-command installation (recommended)
curl -sSL https://raw.githubusercontent.com/vnykmshr/pi-gateway/main/scripts/quick-install.sh | bash

# Interactive setup
curl -sSL https://raw.githubusercontent.com/vnykmshr/pi-gateway/main/scripts/quick-install.sh | bash -s -- --interactive

# Manual installation
git clone https://github.com/vnykmshr/pi-gateway.git
cd pi-gateway && make setup

📚 Documentation

🎯 Requirements

Hardware: Raspberry Pi 4/5/500, 32GB+ SD card, reliable network
Software: Raspberry Pi OS, admin router access, SSH client


Full Changelog: https://github.com/vnykmshr/pi-gateway/blob/main/CHANGELOG.md
License: MIT - see LICENSE