Warning
The --restore command is disabled (a fix is in progress).
V2.6.0 introduced some issues. A fix has been tested and pushed, but user feedback is required to ensure everything works as expected with V2.7.0.
π οΈ This BASH script enables the management of 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 ! La fonction RESTORE n'est pas encore terminΓ©e.
We have performed a force push (git push --force) on this repository to remove sensitive data from the history. As a result, the commit history has been rewritten, and your local copy may be out of sync.
To avoid any issues, please follow these steps to update your local repository:
git fetch --all git reset --hard origin/main # Replace 'main' with your branch name if differentIf you have local changes that you don't want to lose, consider making a backup before running these commands.
This action was necessary to remove sensitive data from the repository's history and ensure better security.
If you encounter any issues or have questions, feel free to open an issue or contact the repository maintainers. Thank you for your understanding! π
π Stay secure & happy coding!
Required basic dependencies.
The script will automatically check if they are installed and will download them if necessary:
curljq
wget https://raw.githubusercontent.com/Erreur32/nginx-proxy-manager-Bash-API/main/npm-api.sh chmod +x npm-api.sh # Run the script. ./npm-api.shNote
With the new V2.0.0, some command arguments have been changed to be simpler, and need to set BASE_DIR variable to store Tokens and Backups.
Important
(Optional) You can create a configuration file named npm-api.conf with these 4 required variables.
To ensure the script is functional, edit these 4 variables (mandatory).
# npm-api.conf ## Nginx proxy IP address (your Nginx IP) NGINX_IP="127.0.0.1" ## Existing user (user and password) on NPM API_USER="admin@example.com" API_PASS="changeme" # Optional (only if you want in other placer than script directory) # DATA_DIR="/path/nginx_backup/dir" # Optional (for checking NPM docker) # NGINX_PATH_DOCKER="/home/docker/nginx_proxy/nginx"./npm-api.sh [OPTIONS] ./npm-api.sh --help ./npm-api.sh --show-default Note
New in version 2.6.0:
- π New dashboard (by default)
- π Improved token management
- π Enhanced command display and options
- π¨ More user-friendly interface with icons and colors
π NGINX - Proxy Manager - Dashboard π§ βββββββββββββββββββββββββββββββββββββββ π Proxy Hosts: β’ Total: 42 β’ Enabled: 38 β’ Disabled: 4 π Redirections: β’ Total: 5 π Stream Hosts: β’ Total: 3 π SSL Certificates: β’ Total: 15 β’ Valid: 12 β’ Expired: 3 π₯ Users: β’ Total: 4 π Server Status: β’ Uptime: 15 days β’ Version: 2.4.0 βββββββββββββββββββββββββββββββββββββββ π‘ Use --help to see available commands π Host proxy creation: -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) -l CUSTOM_LOCATIONS Custom locations (JSON array of location objects) -a ADVANCED_CONFIG Advanced configuration (block of configuration settings) -y Automatic yes prompts, yes sir! π¦ Backup and Restore: --backup Backup all configurations to a file --backup-host id Backup a single host configuration and its certificate (if exists) π§ Miscellaneous: --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 --host-delete id Delete a proxy host by ID --host-show id Show full details for a specific host by ID --show-default Show default settings for creating hosts --host-list List the names of all proxy hosts --host-list-full List all proxy hosts with full details --list-users List all users --host-search hostname Search for a proxy host by domain name --host-enable id Enable a proxy host by ID --host-disable id Disable a proxy host by ID --host-ssl-enable id Enable SSL, HTTP/2, and HSTS for a proxy host --host-ssl-disable id Disable SSL, HTTP/2, and HSTS for a proxy host --list-ssl-cert List All SSL certificates availables (JSON) --generate-cert domain email Generate certificate for the given domain and email --delete-cert domain Delete certificate for the given domain --list-access List all available access lists (ID and name) --host-acl-enable id,access_list_id Enable ACL for a proxy host by ID with an access list ID --host-acl-disable id Disable ACL for a proxy host by ID --update-host id field=value Modify any field on existing entry host --help Display this help π¦ Backup First ! ./npm-api.sh --backup π Host Creation: ./npm-api.sh -d example.com -i 192.168.1.10 -p 8080 (check default values below) ./npm-api.sh --info ./npm-api.sh --show-default ./npm-api.sh --create-user newuser password123 user@example.com ./npm-api.sh --delete-user 'username' ./npm-api.sh --host-list ./npm-api.sh --host-ssl-enable 10 π€ Automatic operations (no prompts): ./npm-api.sh -d example.com -i 192.168.1.10 -p 8080 -y ./npm-api.sh --host-delete 42 -y ./npm-api.sh --host-ssl-enable 10 -y π Information and Status: ./npm-api.sh --info # Show script configuration and status ./npm-api.sh --check-token # Verify token validity ./npm-api.sh --host-search domain.com # Search for a specific domain π Host Management: # Enable/Disable hosts ./npm-api.sh --host-enable 42 ./npm-api.sh --host-disable 42 π‘οΈ Access Control Lists: ./npm-api.sh --list-access # List all access lists ./npm-api.sh --host-acl-enable 42,5 # Enable ACL ID 5 for host 42 ./npm-api.sh --host-acl-disable 42 # Disable ACL for host 42 π SSL Management: ./npm-api.sh --list-ssl-cert # List all SSL certificates ./npm-api.sh --delete-cert domain.com # Delete certificate for domain π Update Specific Fields: # Update individual fields without recreating the entire host ./npm-api.sh --update-host 42 forward_scheme=https ./npm-api.sh --update-host 42 forward_port=8443 ./npm-api.sh --update-host 42 block_exploits=true ./npm-api.sh --update-host 42 allow_websocket_upgrade=true π§ Advanced Example: ./npm-api.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;' π‘οΈ Custom Certificate: ./npm-api.sh --generate-cert example.com user@example.com # Note: This will generate a Let's Encrypt certificate only π‘οΈ Custom locations: ./npm-api.sh -d example.com -i 192.168.1.10 -p 8080 -l '[{"path":"/api","forward_host":"192.168.1.11","forward_port":8081}]' π Full options: ./npm-api.sh -d example.com -i 192.168.1.10 -p 8080 -f https -c true -b true -w true -a 'proxy_set_header X-Real-IP $remote_addr;' -l '[{"path":"/api","forward_host":"192.168.1.11","forward_port":8081}]'./npm-api.sh --backupπ data/ # Root directory βββ π backups/ # Backup directories β βββ π [IP]_[PORT]/ # NPM Instance (IP:PORT) β βββ π .access_lists/ # Access Lists configurations β βββ π .Proxy_Hosts/ # Host configurations β β βββ π [DOMAIN]/ # Directory for each domain β β β βββ π proxy_config.json # Proxy configuration β β β βββ π nginx.conf # Nginx configuration β β βββ π all_hosts_[DATE].json # List of all hosts β β βββ π all_hosts_latest.json # Symlink to latest backup β βββ π .settings/ # NPM settings β βββ π .ssl/ # SSL certificates β β βββ π certificate.pem # Certificate β β βββ π chain.pem # Chain of certificates β β βββ π private.key # Private key β β βββ π certificate_meta.json # Certificate metadata β βββ π .user/ # User configurations β βββ π full_config_[DATE].json # Full backup β βββ π full_config_latest.json # Symlink to latest backup βββ π token/ # Token directory βββ π token_[IP].txt # Authentication token βββ π expiry_[IP].txt # Token expiry date # Full backup of all configurations ./npm-api.sh --backup # This will create a backup in the following structure: data/ βββ backups/ βββ [IP]_[PORT]/ βββ .access_lists/ # Access list configurations βββ .Proxy_Hosts/ # All proxy host configurations βββ .settings/ # NPM settings βββ .ssl/ # SSL certificates βββ .user/ # User configurations βββ full_config.json # Complete backup file βββ π token/ βββ π token.txt # Authentication token βββ π expiry.txt # Token expiry date -
Proxy Hosts (
/.Proxy_Hosts/)- Individual host configurations
- Nginx configurations
- Complete host list with timestamps
-
SSL Certificates (
/.ssl/)- Certificates and private keys
- Certificate metadata
- Chain certificates
-
Access Lists (
/.access_lists/)- Access list configurations
- Client authorizations
- Access rules
-
Users (
/.user/)- User accounts
- Permissions
- Authentication settings
-
Settings (
/.settings/)- Global NPM settings
- System configurations
- Default parameters
The token/ directory contains:
- Authentication tokens
- Token expiry information
- One file per NPM instance
The --host-update command allows you to update specific fields of an existing proxy host in Nginx Proxy Manager without recreating it.
Simply specify the proxy host ID and the field you want to update, like this:
./npm-api.sh --update-host 42 forward_host=new.backend.local| Field Name | Type | Description |
|---|---|---|
domain_names | array | List of domains handled by this proxy. |
forward_host | string | The destination (backend) hostname or IP. |
forward_port | integer | The destination port (e.g., 8000, 443). |
forward_scheme | string | The scheme: http or https. |
enabled | boolean | Whether the proxy is enabled (true or false). |
ssl_forced | boolean | Redirect all HTTP requests to HTTPS. |
certificate_id | integer | The ID of the SSL certificate to use. |
meta.letsencrypt_agree | boolean | Agree to Let's Encrypt TOS (true or false). |
meta.dns_challenge | boolean | Use DNS challenge for SSL cert (true or false). |
allow_websocket_upgrade | boolean | Enable WebSocket support (true or false). |
http2_support | boolean | Enable HTTP/2 (true or false). |
caching_enabled | boolean | Enable caching (true or false). |
block_exploits | boolean | Block known exploits (true or false). |
advanced_config | string | Custom Nginx directives (multiline string). |
locations | array | Custom location blocks (advanced use). |
Some info of settings in the script with ./npm-api.sh --info
./npm-api.sh --info Script Info: 2.3.5 Script Variables Information: BASE_URL http://127.0.0.1:81/api NGINX_IP 127.0.0.1 API_USER admin@example.com BASE_DIR /path/to/nginx_proxy BACKUP_DIR /path/to/nginx_proxy/backups BACKUP HOST 40 Token NPM /path/to/nginx_proxy/token/token_127.0.0.1.txt By following these steps, you can enable SSL for your proxy host for the first time using Let's Encrypt.
List all Host in one command and show Β΄idΒ΄ , Β΄statusΒ΄ and Β΄SSLΒ΄ status:
./npm-api.sh --host-list π List of proxy hosts (simple) ID Domain Status SSL 1 toto.fun enabled β 2 titi.fun disable β
3 tutu.fun enabled β
Assuming the host ID is 1, you would enable SSL for the host as follows:
./npm-api.sh --host-ssl-enable 1 SSl is enable successfully, check again with --host-list
./npm-api.sh --host-list π List of proxy hosts (simple) ID Domain Status SSL 1 toto.fun enabled β
2 titi.fun disable β
3 tutu.fun enabled β
Host proxy info command --host-show id
./npm-api.sh --host-show 1 π 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 } - 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
- Add automatic confirmation with -y parameter
- Clean/minimize output when using -y parameter for better script integration
- Creation of ACCESS list through CLI
- Restore Function not working properly, need to find FIX
Special thanks to:
- @ichbinder for implementing the
-yparameter for automatic confirmations
MIT License - see the LICENSE.md file for details