From e24b232fdf919b4afc8a6ee1cbc9056eb3ef1e50 Mon Sep 17 00:00:00 2001 From: Erreur32 Date: Fri, 12 Jul 2024 13:23:51 +0200 Subject: [PATCH] Update Readme --- README.md | 64 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 41 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index b817c75..419de9d 100644 --- a/README.md +++ b/README.md @@ -45,33 +45,51 @@ API_PASS="password" ## Options ```tcl - -d DOMAIN_NAMES Domain name (required) - -i FORWARD_HOST IP address or domain name of the target server (required) - -p FORWARD_PORT Port of the target server (required) - -s SSL_FORCED Force SSL (true/false, default: false) - -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: false) - -h HTTP2_SUPPORT Support HTTP/2 (true/false, default: true) - -a ADVANCED_CONFIG Advanced configuration (string) - -e LETS_ENCRYPT_AGREE Accept Let's Encrypt (true/false, default: false) - -n DNS_CHALLENGE DNS challenge (true/false, default: false) - --create-user username password Create a user with a username and password - --delete-user username Delete a user by username - --delete-host id Delete a proxy host by ID - --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 - --help Display this help + 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) + -s SSL_FORCED Force SSL (true/false, default: false) + -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) + -h HTTP2_SUPPORT Support HTTP/2 (true/false, default: true) + -a ADVANCED_CONFIG Advanced configuration (block of configuration settings) + -e LETS_ENCRYPT_AGREE Accept Let's Encrypt (true/false, default: false) + -m LETS_ENCRYPT_EMAIL Email for Let's Encrypt (required if LETS_ENCRYPT_AGREE is true) + -n DNS_CHALLENGE DNS challenge (true/false, default: false) + -t TOKEN_EXPIRY Token expiry duration (default: 1y) + --create-user user pass Create a user with a username and password + --delete-user username Delete a user by username + --delete-host id Delete a proxy host by ID + --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 + --check-token Check if the current token is valid + --backup Backup all configurations to a file + --help Display this help ``` ## Examples ```bash -./nginx_proxy_manager_cli.sh -d example.com -i 192.168.1.10 -p 8080 -s true -./nginx_proxy_manager_cli.sh --create-user newuser password123 -./nginx_proxy_manager_cli.sh --list-hosts + Usage: + ./nginx_proxy_manager_cli.sh [OPTIONS] + + Examples: + ./nginx_proxy_manager_cli.sh -d example.com -i 192.168.1.10 -p 8080 -s true + ./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 --backup + + 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;" + ``` ![https://github.com/Erreur32/nginx-proxy-manager-API/blob/main/screen-nginx-proxy-script.png](https://github.com/Erreur32/nginx-proxy-manager-API/blob/main/screen-nginx-proxy-script.png)