Skip to content

Releases: n0xa/chn-quickstart

Release list

v2.2.1

v2.2.1 Latest
Latest

Choose a tag to compare

View all tags
@n0xa n0xa released this 10 Aug 08:05
v2.2.1
8088dbc

Changes since v2.2.0

  • Version bump
  • Updated CHN-Server container reference from v2.2.0 to v2.2.1 in docker-compose templates

This release updates the container references to use the latest CHN-Server v2.2.1 which includes PyMongo fixes and dashboard API improvements.

Assets 2
Loading

CHN-Quickstart v2.2.0

CHN-Quickstart v2.2.0

Choose a tag to compare

View all tags
@n0xa n0xa released this 09 Aug 00:55
v2.2.0
4fa2124

CHN-Quickstart v2.2.0 Release Notes

Release Date: August 9, 2025
Repository: https://github.com/n0xa/chn-quickstart

🎉 Stable Update Release

This release provides improvements for the CHN-Quickstart toolkit, referencing the latest modernized CHN containers

🔧 Infrastructure Modernization

Docker Compose Updates

  • Version: Upgraded from v2 → v3.8 format
  • Image Registry: Migrated from stingar/* → ax0n/* DockerHub registry
  • Version Pinning: All images pinned to stable 2.2.0 tags for production reliability
  • Service Dependencies: Improved dependency management with proper depends_on chains

Template System Overhaul

  • Registry Images: All templates updated to use production DockerHub images
  • Template Validation: Comprehensive testing of all template combinations
  • Branding Updates: Intel feed filenames updated from stingar_*.txt → chn_*.txt
  • Configuration Cleanup: Streamlined environment variable templates

Repository Transition

  • Maintainer: Updated to n0xa
  • Repository: Migrated from CommunityHoneyNetwork → n0xa fork
  • Image References: All Docker images now point to ax0n/* registry

🚀 Key Features

Deployment Automation

  • ✅ Guided Setup: Interactive guided_docker_compose.py script for easy deployment
  • ✅ Multiple Configurations: Support for standard, logging, CIF, and intel-feeds variants
  • ✅ SSL/TLS Ready: Built-in HTTPS configuration with multiple certificate strategies
  • ✅ Environment Generation: Automatic environment file generation with secure defaults

Service Integration

  • ✅ Core CHN Stack: Full integration of hpfeeds3, mnemosyne, chn-server
  • ✅ MongoDB 8.0: Modern database backend with persistent storage
  • ✅ Redis 7.4: Updated caching and session management
  • ✅ Extended Services: Optional hpfeeds-logger, intel-feeds, and CIF integration

Production Features

  • ✅ Volume Management: Persistent storage for databases, logs, and configurations
  • ✅ Network Isolation: Proper Docker networking for service communication
  • ✅ Health Monitoring: Container health checks and dependency management
  • ✅ Security Configuration: Secure defaults and SSL/TLS automation

🔐 Security Enhancements

Modern Base Images

  • Ubuntu 24.04 LTS: Latest long-term support for enhanced security
  • Alpine 3.20: Minimal attack surface for lightweight services
  • Updated Dependencies: All packages updated to latest secure versions

SSL/TLS Implementation

  • Multiple Strategies: CERTBOT (Let's Encrypt), SELFSIGNED, BYO certificate support
  • Automated Generation: Self-signed certificate generation for development/testing
  • Production Ready: Let's Encrypt integration for production deployments

🧪 Testing & Validation

Comprehensive Testing

  • ✅ Clean Environment: Tested deployment from registry images only
  • ✅ All Templates: Validated standard, logging, CIF, and intel-feeds configurations
  • ✅ SSL Strategies: Confirmed all certificate generation methods work
  • ✅ Performance Testing: Verified no regressions in deployment time or performance

Integration Validation

  • ✅ Service Communication: All inter-service communication verified
  • ✅ Data Flow: HPFeeds → Mnemosyne → MongoDB data pipeline confirmed
  • ✅ Web Interface: CHN-Server web interface fully functional
  • ✅ API Access: RESTful API endpoints operational

🔧 Critical Bug Fixes

Logic Bug Corrections (guided_docker_compose.py)

  • Fixed: 7 instances of incorrect boolean logic answer.lower() == ("y" or "yes")
  • Impact: Fixes user input validation in deployment script

Image Reference Updates

  • Updated: All 10+ Docker image references from stingar/* → ax0n/*
  • Templates: Updated all docker-compose template files
  • Branding: Intel feed filenames updated to CHN branding

📦 Deployment

Quick Start

# Clone the modernized repository
git clone https://github.com/n0xa/chn-quickstart.git
cd chn-quickstart

# Run guided setup
./guided_docker_compose.py

# Deploy the stack
docker-compose up -d

Deployment Options

  • Standard: Core CHN stack (hpfeeds3, mnemosyne, chn-server, mongodb, redis)
  • With Logging: Includes hpfeeds-logger for message logging
  • With CIF: Collective Intelligence Framework integration
  • With Intel Feeds: Threat intelligence feed generation

Modernized Image Stack

# Production-ready images
ax0n/hpfeeds3:2.2.0        # 93MB  - Message broker
ax0n/mnemosyne:2.2.0       # 615MB - Data normalization
ax0n/chn-server:2.2.0      # 1.18GB- Web interface & API
ax0n/hpfeeds-logger:2.2.0  # 500MB - Message logging (optional)
mongo:8.0                  # Database backend
redis:7.4-alpine           # Caching & sessions

⚠️ Breaking Changes

Minimal Breaking Changes

  • Image Registry: Must use ax0n/* images instead of stingar/*
  • Template Updates: Existing custom templates may need image reference updates
  • Configuration: Intel feed filenames changed from stingar_*.txt → chn_*.txt

Environment Variable Compatibility

All existing environment variables remain compatible:

  • MONGODB_HOST, MONGODB_PORT - Database configuration
  • HPFEEDS_HOST, HPFEEDS_PORT - Message broker settings
  • REDIS_HOST, REDIS_PORT - Cache configuration
  • SUPERUSER_EMAIL, SUPERUSER_PASSWORD - Admin credentials

🐛 Known Issues

  • CIF Services: chn-intel-feeds and hpfeeds-cif deferred due to Python 3.12 compatibility
  • Container Registry: Requires DockerHub access for image pulls
  • Build Dependencies: Local builds no longer supported (registry-only deployment)

📈 Performance Improvements

Deployment Performance

  • Faster Startup: Registry images eliminate build time (~10 minutes saved)
  • Reduced Disk Usage: No local build artifacts (saves ~20GB disk space)
  • Network Efficiency: Optimized image layers for faster pulls

Runtime Performance

  • Memory Usage: Total stack ~330MB runtime memory
  • Response Times: HTTP 0.9-1.4ms, HTTPS 10-12ms average
  • CPU Usage: All services <1% CPU under normal load

🎯 Advanced Configuration

SSL/TLS Options

# Let's Encrypt (production)
CERTIFICATE_STRATEGY=CERTBOT
CERTBOT_ENABLED=y

# Self-signed (development)  
CERTIFICATE_STRATEGY=SELFSIGNED

# Bring your own (custom)
CERTIFICATE_STRATEGY=BYO

Service Scaling

  • Horizontal Scaling: Multiple mnemosyne instances for high-volume environments
  • Load Balancing: nginx configuration for multi-instance deployments
  • Resource Limits: Docker resource constraints for production environments

🙏 Acknowledgments

  • Community Honey Network and Modern Honey Network contributors
  • Docker and Docker Compose communities
  • Ubuntu, Alpine, MongoDB, and Redis teams for robust platform components

For support: Report issues at https://github.com/n0xa/chn-quickstart/issues
Documentation: https://communityhoneynetwork.readthedocs.io
Quick Deploy: ./guided_docker_compose.py && docker-compose up -d

Loading

CHN-Quickstart v2.1.0 - Complete Stack Modernization Release

CHN-Quickstart v2.1.0 - Complete Stack Modernization Release

Choose a tag to compare

View all tags
@n0xa n0xa released this 05 Aug 02:09
v2.1.0
6bf0060
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

CHN-Quickstart v2.1.0 Release Notes

Release Date: August 5, 2025
Repository: https://github.com/n0xa/chn-quickstart

🎉 Complete Stack Modernization Release

This release brings the CHN-Quickstart deployment toolkit up to modern standards, providing seamless deployment of the fully modernized Community Honey Network stack.

🔧 Infrastructure Modernization

Docker Compose Updates

  • Version: Upgraded from v2 → v3.8 format
  • Image Registry: Migrated from stingar/* → ax0n/* DockerHub registry
  • Version Pinning: All images pinned to stable 2.1.0 tags for production reliability
  • Service Dependencies: Improved dependency management with proper depends_on chains

Template System Overhaul

  • Registry Images: All templates updated to use production DockerHub images
  • Template Validation: Comprehensive testing of all template combinations
  • Branding Updates: Intel feed filenames updated from stingar_*.txt → chn_*.txt
  • Configuration Cleanup: Streamlined environment variable templates

Repository Transition

  • Maintainer: Updated to n0xa
  • Repository: Migrated from CommunityHoneyNetwork → n0xa fork
  • Image References: All Docker images now point to ax0n/* registry

🚀 Key Features

Deployment Automation

  • ✅ Guided Setup: Interactive guided_docker_compose.py script for easy deployment
  • ✅ Multiple Configurations: Support for standard, logging, CIF, and intel-feeds variants
  • ✅ SSL/TLS Ready: Built-in HTTPS configuration with multiple certificate strategies
  • ✅ Environment Generation: Automatic environment file generation with secure defaults

Service Integration

  • ✅ Core CHN Stack: Full integration of hpfeeds3, mnemosyne, chn-server
  • ✅ MongoDB 8.0: Modern database backend with persistent storage
  • ✅ Redis 7.4: Updated caching and session management
  • ✅ Extended Services: Optional hpfeeds-logger, intel-feeds, and CIF integration

Production Features

  • ✅ Volume Management: Persistent storage for databases, logs, and configurations
  • ✅ Network Isolation: Proper Docker networking for service communication
  • ✅ Health Monitoring: Container health checks and dependency management
  • ✅ Security Configuration: Secure defaults and SSL/TLS automation

🔐 Security Enhancements

Modern Base Images

  • Ubuntu 24.04 LTS: Latest long-term support for enhanced security
  • Alpine 3.20: Minimal attack surface for lightweight services
  • Updated Dependencies: All packages updated to latest secure versions

SSL/TLS Implementation

  • Multiple Strategies: CERTBOT (Let's Encrypt), SELFSIGNED, BYO certificate support
  • Automated Generation: Self-signed certificate generation for development/testing
  • Production Ready: Let's Encrypt integration for production deployments

🧪 Testing & Validation

Comprehensive Testing

  • ✅ Clean Environment: Tested deployment from registry images only
  • ✅ All Templates: Validated standard, logging, CIF, and intel-feeds configurations
  • ✅ SSL Strategies: Confirmed all certificate generation methods work
  • ✅ Performance Testing: Verified no regressions in deployment time or performance

Integration Validation

  • ✅ Service Communication: All inter-service communication verified
  • ✅ Data Flow: HPFeeds → Mnemosyne → MongoDB data pipeline confirmed
  • ✅ Web Interface: CHN-Server web interface fully functional
  • ✅ API Access: RESTful API endpoints operational

🔧 Critical Bug Fixes

Logic Bug Corrections (guided_docker_compose.py)

  • Fixed: 7 instances of incorrect boolean logic answer.lower() == ("y" or "yes")
  • Impact: Fixes user input validation in deployment script

Image Reference Updates

  • Updated: All 10+ Docker image references from stingar/* → ax0n/*
  • Templates: Updated all docker-compose template files
  • Branding: Intel feed filenames updated to CHN branding

📦 Deployment

Quick Start

# Clone the modernized repository
git clone https://github.com/n0xa/chn-quickstart.git
cd chn-quickstart

# Run guided setup
./guided_docker_compose.py

# Deploy the stack
docker-compose up -d

Deployment Options

  • Standard: Core CHN stack (hpfeeds3, mnemosyne, chn-server, mongodb, redis)
  • With Logging: Includes hpfeeds-logger for message logging
  • With CIF: Collective Intelligence Framework integration
  • With Intel Feeds: Threat intelligence feed generation

Modernized Image Stack

# Production-ready images
ax0n/hpfeeds3:2.1.0        # 93MB  - Message broker
ax0n/mnemosyne:2.1.0       # 615MB - Data normalization
ax0n/chn-server:2.1.0      # 1.18GB- Web interface & API
ax0n/hpfeeds-logger:2.1.0  # 500MB - Message logging (optional)
mongo:8.0                  # Database backend
redis:7.4-alpine           # Caching & sessions

⚠️ Breaking Changes

Minimal Breaking Changes

  • Image Registry: Must use ax0n/* images instead of stingar/*
  • Template Updates: Existing custom templates may need image reference updates
  • Configuration: Intel feed filenames changed from stingar_*.txt → chn_*.txt

🔧 Migration Guide

From Legacy Versions (1.9.x)

1. Update Repository

# Backup existing configuration
cp docker-compose.yml docker-compose.yml.backup

# Clone modernized version
git clone https://github.com/n0xa/chn-quickstart.git chn-quickstart-2.1.0
cd chn-quickstart-2.1.0

2. Regenerate Configuration

# Run guided setup with new images
./guided_docker_compose.py

# Review generated configuration
cat docker-compose.yml

3. Data Migration

# Stop old stack
docker-compose -f ../docker-compose.yml.backup down

# Copy persistent data
cp -r ../storage ./

# Start modernized stack
docker-compose up -d

Environment Variable Compatibility

All existing environment variables remain compatible:

  • MONGODB_HOST, MONGODB_PORT - Database configuration
  • HPFEEDS_HOST, HPFEEDS_PORT - Message broker settings
  • REDIS_HOST, REDIS_PORT - Cache configuration
  • SUPERUSER_EMAIL, SUPERUSER_PASSWORD - Admin credentials

🐛 Known Issues

  • CIF Services: chn-intel-feeds and hpfeeds-cif deferred due to Python 3.12 compatibility
  • Container Registry: Requires DockerHub access for image pulls
  • Build Dependencies: Local builds no longer supported (registry-only deployment)

📈 Performance Improvements

Deployment Performance

  • Faster Startup: Registry images eliminate build time (~10 minutes saved)
  • Reduced Disk Usage: No local build artifacts (saves ~20GB disk space)
  • Network Efficiency: Optimized image layers for faster pulls

Runtime Performance

  • Memory Usage: Total stack ~330MB runtime memory
  • Response Times: HTTP 0.9-1.4ms, HTTPS 10-12ms average
  • CPU Usage: All services <1% CPU under normal load

🎯 Advanced Configuration

SSL/TLS Options

# Let's Encrypt (production)
CERTIFICATE_STRATEGY=CERTBOT
CERTBOT_ENABLED=y

# Self-signed (development)  
CERTIFICATE_STRATEGY=SELFSIGNED

# Bring your own (custom)
CERTIFICATE_STRATEGY=BYO

Service Scaling

  • Horizontal Scaling: Multiple mnemosyne instances for high-volume environments
  • Load Balancing: nginx configuration for multi-instance deployments
  • Resource Limits: Docker resource constraints for production environments

🙏 Acknowledgments

  • Community Honey Network and Modern Honey Network contributors
  • Docker and Docker Compose communities
  • Ubuntu, Alpine, MongoDB, and Redis teams for robust platform components

For support: Report issues at https://github.com/n0xa/chn-quickstart/issues
Documentation: https://communityhoneynetwork.readthedocs.io
Quick Deploy: ./guided_docker_compose.py && docker-compose up -d

Loading