Erreur32/nginx-proxy-manager-Bash-API
1
0
Fork 0
mirror of https://github.com/Erreur32/nginx-proxy-manager-Bash-API.git synced 2024-10-18 09:20:13 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update Readme

Browse Source
This commit is contained in:
Erreur32 2024-07-12 13:23:51 +02:00
parent 1e167071f2
commit e24b232fdf
1 changed files with 41 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -45,18 +45,22 @@ API_PASS="password"
## Options ## Options
```tcl ```tcl
-d DOMAIN_NAMES Domain name (required) Options:
-i FORWARD_HOST IP address or domain name of the target server (required) -d DOMAIN_NAMES Domain name (required for creating/updating hosts)
-p FORWARD_PORT Port of the target server (required) -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) -s SSL_FORCED Force SSL (true/false, default: false)
-c CACHING_ENABLED Enable caching (true/false, default: false) -c CACHING_ENABLED Enable caching (true/false, default: false)
-b BLOCK_EXPLOITS Block exploits (true/false, default: true) -b BLOCK_EXPLOITS Block exploits (true/false, default: true)
-w ALLOW_WEBSOCKET_UPGRADE Allow WebSocket upgrade (true/false, default: false) -w ALLOW_WEBSOCKET_UPGRADE Allow WebSocket upgrade (true/false, default: true)
-h HTTP2_SUPPORT Support HTTP/2 (true/false, default: true) -h HTTP2_SUPPORT Support HTTP/2 (true/false, default: true)
-a ADVANCED_CONFIG Advanced configuration (string) -a ADVANCED_CONFIG Advanced configuration (block of configuration settings)
-e LETS_ENCRYPT_AGREE Accept Let's Encrypt (true/false, default: false) -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) -n DNS_CHALLENGE DNS challenge (true/false, default: false)
--create-user username password Create a user with a username and password -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-user username Delete a user by username
--delete-host id Delete a proxy host by ID --delete-host id Delete a proxy host by ID
--list-hosts List the names of all proxy hosts --list-hosts List the names of all proxy hosts
@ -64,14 +68,28 @@ API_PASS="password"
--list-ssl-certificates List all SSL certificates --list-ssl-certificates List all SSL certificates
--list-users List all users --list-users List all users
--search-host hostname Search for a proxy host by domain name --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 --help Display this help
``` ```
## Examples ## Examples
```bash ```bash
./nginx_proxy_manager_cli.sh -d example.com -i 192.168.1.10 -p 8080 -s true Usage:
./nginx_proxy_manager_cli.sh --create-user newuser password123 ./nginx_proxy_manager_cli.sh [OPTIONS]
./nginx_proxy_manager_cli.sh --list-hosts
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) ![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)