Erreur32/nginx-proxy-manager-Bash-API
1
1
Fork 0
mirror of https://github.com/Erreur32/nginx-proxy-manager-Bash-API.git synced 2025-04-04 15:11:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
nginx-proxy-manager-Bash-API/CHANGELOG.md
Erreur32 eb3b038a31 Update Date
2025-03-24 22:22:51 +01:00

7.2 KiB
Executable file
Raw Permalink Blame History

Changelog

All notable changes to the npm-api.sh script will be documented in this file.

[3.0.0] - 2025-03-24

🔄 Breaking Changes

  • Host Creation Command Simplified 
    - OLD: ./npm-api.sh -d example.com -i 192.168.1.10 -p 8080
+ NEW: ./npm-api.sh --host-create example.com -i 192.168.1.10 -p 8080
    The -d option has been removed in favor of a more intuitive positional argument after --host-create

New Commands (2.8.0)

  • --access-list: List all available access lists
  • --access-list-show <id>: Show detailed information for a specific access list
  • --access-list-create: Create a new access list
  • --access-list-update: Update an existing access list
  • --access-list-delete: Delete an access list
  • --list-cert: List certificates filtered by domain name
  • --list-cert-all: List all SSL certificates

New Long Options Format

  • Certificate Generation:

    - OLD: ./npm-api.sh --cert-generate example.com admin@example.com
+ NEW: ./npm-api.sh --cert-generate example.com --cert-email admin@example.com

  • Wildcard Certificate with DNS Challenge:

    - OLD: ./npm-api.sh --cert-generate "*.example.com" admin@example.com --dns-provider cloudflare --dns-credentials '{"dns_cloudflare_email":"your@email.com","dns_cloudflare_api_key":"your_api_key"}'
+ NEW: ./npm-api.sh --cert-generate "*.example.com" \
+      --cert-email admin@example.com \
+      --dns-provider cloudflare \
+      --dns-credentials '{"dns_cloudflare_email":"your@email.com","dns_cloudflare_api_key":"your_api_key"}'

Renamed Commands

  • --list-ssl-cert → --list-cert
  • --create-user → --user-create
  • --delete-user → --user-delete
  • --list-users → --user-list
  • --list-access → --access-list
  • --update-host → --host-update

Enhanced Commands

  • --generate-cert: Added support for wildcard certificates and DNS challenges
    • Add Wildcard support.
    • Support for multiple DNS providers (Dynu, Cloudflare, DigitalOcean, etc.)

Syntax Changes

  • Host-related commands now consistently use the --host- prefix
  • User-related commands now consistently use the --user- prefix
  • Certificate-related commands now consistently use the --cert- prefix

✨ New Features

  • Smart certificate management in SSL configuration:

    • Automatic detection of existing certificates for domains
    • Automatic selection of single existing certificates
    • Selection system for multiple certificates:
      • Auto-selects most recent with -y flag
      • Interactive selection without -y flag
    • Integration with certificate generation workflow

  • Enhanced SSL status display with detailed configuration state

  • Improved error handling and debug information

  • Configurable SSL parameters:

    • SSL Forced
    • HTTP/2 Support
    • HSTS
    • HSTS Subdomains

  • Enhanced Host Creation

    • Simplified command syntax with positional domain argument
    • Improved parameter validation
    • Better error messages with clear examples
    • Default values for optional parameters

  • Improved Error Handling

    • Clear error messages for missing parameters
    • Validation of domain name format
    • Parameter type checking (e.g., port numbers, boolean values)
    • Helpful usage examples in error messages

  • Added comprehensive dashboard with display_dashboard() showing:

    • Proxy hosts status (enabled/disabled)
    • SSL certificates (valid/expired)
    • Access lists and clients
    • System statistics

  • Enhanced SSL Certificate Management:

    • Improved wildcard certificate support
    • Enhanced domain validation
    • DNS challenge management for wildcard certificates
    • Support for multiple DNS providers (Cloudflare, DigitalOcean, etc.)

  • Enhanced Access List Management:

    • Detailed view for individual access lists
    • Colored output for better readability
    • Display of users and IP counts
    • Clear visualization of allow/deny rules
    • Authentication status indicators
    • Satisfaction mode display (Any/All)
    • Proxy host count integration
    • Improved formatting and layout
    • Better error handling for null values
    • Comprehensive legend for status indicators

🛠️ Code Optimizations

  • Removed redundant parameter validations

  • Streamlined host creation logic

  • Unified error message format

  • Better code organization

  • Enhanced Token Management:

    • Automatic validation
    • Smart renewal
    • Secure storage

  • Improved Host Management Commands:

    • Enhanced display with host_show()
    • Better error handling
    • Advanced configuration support

  • Improved access list display with:

    • Dynamic column sizing
    • Proper null value handling
    • Efficient data processing
    • Better color management
    • Enhanced table formatting

📚 Documentation

  • Updated access list command documentation:
    • Added examples for detailed view
    • Improved command descriptions
    • Better parameter explanations

🔐 Security

  • Enhanced input validation
  • Better parameter sanitization
  • Improved error handling for invalid inputs

🛠️ Fixes and Optimizations

  • Fixed SSL certificate management bugs
  • Improved user input validation
  • Optimized API requests
  • Enhanced HTTP error handling

🙏 Remerciements

Thanks to zafar-2020 for the testing and helpful issue reports during the development of this release!

[2.7.0] - 2025-03-08

Added

  • DNS Challenge Support

    • Added support for multiple DNS providers (Dynu, Cloudflare, DigitalOcean, etc.)
    • Implemented automatic DNS challenge detection for wildcard certificates
    • Added validation for DNS provider and API key parameters

  • Wildcard Certificate Support

    • Added ability to generate wildcard certificates (*.domain.com)
    • Automatic detection of wildcard certificate requirements
    • Enforced DNS challenge requirement for wildcard certificates

  • Certificate Management Enhancements

    • Added ability to specify existing certificate by ID when enabling SSL
    • Implemented automatic certificate matching for domains
    • Added support for using wildcard certificates with host SSL configuration
    • Enhanced certificate search to match wildcard patterns

Changed

  • Command Structure

    • Modified --generate-cert command to accept DNS parameters after email: 
      --generate-cert domain [email] [dns-provider provider dns-api-key key]
    • Updated --host-ssl-enable to accept optional certificate ID: 
      --host-ssl-enable ID [cert_id]

  • Help Documentation

    • Updated help section with detailed DNS challenge information
    • Added examples for wildcard certificates and different DNS providers
    • Improved documentation for SSL certificate management
    • Added clarification for supported DNS providers

Improved

  • Error Handling

    • Added validation for DNS challenge parameters
    • Enhanced error messages for certificate operations
    • Improved feedback for wildcard certificate requirements

  • User Experience

    • Added automatic certificate selection when enabling SSL
    • Improved certificate matching logic
    • Enhanced feedback during certificate operations
    • Added clear examples for all new features

[1.0.0] - Initial Release

  • Basic SSL certificate management
  • Proxy host configuration
  • User list