nginx-proxy-manager-Bash-API/README.md

Nginx Proxy Manager CLI Script

Table of Contents

1. Description
2. Reference API
3. Prerequisites
4. Installation
5. Settings
6. Usage
7. Options
8. Examples
9. Screens
10. TODO

Description

🛠️ This BASH script enables the management of Nginx Proxy Manager through its API.

🔑 Automatically generates and manages tokens, ensuring their validity, so you don't have to worry about token expiration.

⚙️ Provides functionalities such as creating and deleting proxy hosts, managing users, displaying configurations, creating BACKUPs, and more.

Ce script permet de gérer Nginx Proxy Manager via l'API. Il fournit des fonctionnalités telles que la création de hosts proxy, la gestion des utilisateurs, et l'affichage des configurations avec creation de BACKUP !

Reference

Prerequisites

And of course the excellent NPM ()

and simple dependencies:

• curl
• jq

sudo apt-get install jq curl

Installation

wget https://raw.githubusercontent.com/Erreur32/nginx-proxy-manager-API/main/nginx_proxy_manager_cli.sh
chmod +x nginx_proxy_manager_cli.sh

Settings

Only edit these 3 variables:

## Nginx proxy IP address (your Nginx IP)
NGINX_IP="127.0.0.1"
## Existing user (user and password) on NPM
API_USER="existingUser@mail.com"
API_PASS="password"

Usage

./nginx_proxy_manager_cli.sh [OPTIONS]

Options

   -d DOMAIN_NAMES                 Domain name (required for creating/updating hosts)
   -i FORWARD_HOST                 IP address or domain name of the target server (required for creating/updating hosts)
   -p FORWARD_PORT                 Port of the target server (required for creating/updating hosts)
   -f FORWARD_SCHEME               Scheme for forwarding (http/https, default: http)
   -c CACHING_ENABLED              Enable caching (true/false, default: false)
   -b BLOCK_EXPLOITS               Block exploits (true/false, default: true)
   -w ALLOW_WEBSOCKET_UPGRADE      Allow WebSocket upgrade (true/false, default: true)
   -a ADVANCED_CONFIG              Advanced configuration (block of configuration settings)
   --backup                        Backup all configurations to a file
   --check-token                   Check if the current token is valid
   --create-user user pass email   Create a user with a username, password and email
   --delete-user username          Delete a user by username
   --delete-host id                Delete a proxy host by ID
   --show-host id                  Show full details for a specific host by ID
   --show-default                  Show default settings for creating hosts
   --list-hosts                    List the names of all proxy hosts
   --list-hosts-full               List all proxy hosts with full details
   --list-ssl-certificates         List all SSL certificates
   --list-users                    List all users
   --search-host hostname          Search for a proxy host by domain name
   --enable-host id                Enable a proxy host by ID
   --disable-host id               Disable a proxy host by ID
   --ssl-host-enable id            Enable SSL, HTTP/2, and HSTS for a proxy host (will generate let's encrypt certif auto)
   --ssl-host-disable id           Disable SSL, HTTP/2, and HSTS for a proxy host
   --help                          Display this help

Examples

   Backup First !
   ./nginx_proxy_manager_cli.sh --backup

   ./nginx_proxy_manager_cli.sh -d example.com -i 192.168.1.10 -p 8080 (check default values below)
   ./nginx_proxy_manager_cli.sh --show-default
   ./nginx_proxy_manager_cli.sh --create-user newuser password123 user@example.com
   ./nginx_proxy_manager_cli.sh --delete-user 'username'
   ./nginx_proxy_manager_cli.sh --list-hosts

   ./nginx_proxy_manager_cli.sh --ssl-host-enable 10
   ./nginx_proxy_manager_cli.sh --generate-cert example.com user@example.com --custom (not finish)

 Advanced proxy tab example:
   ./nginx_proxy_manager_cli.sh -d example.com -i 192.168.1.10 -p 8080 -a 'proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;'

Enable SSL for the Host:

Assuming the host ID is 10, you would enable SSL for the host as follows:

./nginx_proxy_manager_cli.sh --ssl-host-enable 10

Verifying the Configuration

After running the above commands, you can verify the SSL configuration by checking the details of the proxy host.

./nginx_proxy_manager_cli.sh --show-host 10

This command will show the full details of the proxy host with ID 10, including whether SSL is enabled.

By following these steps, you can enable SSL for your proxy host for the first time using Let's Encrypt.

You should now see the parameters activated:

• "ssl_forced": 1,
• "letsencrypt_agree": true,
• "http2_support": 1

 ./nginx_proxy_manager_cli_.sh --show-host 10

 ✅ Nginx url: http://127.0.0.1:81/api
 ✅ The token is valid. Expiry: 2025-07-12T08:14:58.521Z

 👉 Full details for proxy host ID: 59...

{
  "id": 10,
  "created_on": "2024-07-11 13:16:34",
  "modified_on": "2024-07-13 09:42:40",
  "owner_user_id": 1,
  "domain_names": [
    "test.domain.com"
  ],
  "forward_host": "127.0.0.1",
  "forward_port": 80,
  "access_list_id": 0,
  "certificate_id": 81,
  "ssl_forced": 1,
  "caching_enabled": 0,
  "block_exploits": 1,
  "advanced_config": "",
  "meta": {
    "letsencrypt_agree": true,
    "letsencrypt_email": "",
    "nginx_online": true,
    "nginx_err": null
  },
  "allow_websocket_upgrade": 1,
  "http2_support": 1,
  "forward_scheme": "http",
  "enabled": 1,
  "locations": [],
  "hsts_enabled": 1,
  "hsts_subdomains": 0
}

Screens:

# ./nginx_proxy_manager_cli.sh --backup

 ✅ Nginx url: http://192.168.1.200:81/api
 ✅ The token is valid. Expiry: 2025-07-12T08:14:58.521Z
 ✅ Full backup completed successfully in 📂 './backups'

TODO:

• add setting for ADVANCED configuration in npm location / { ... }
• Add documentation on certain functions
• ADD: a configuration function for Custom Locations
• Backup all settings from NPM
• Export all settings from NPM
• Domain TLS check validity
• Better Error Messages