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.md

Browse Source
This commit is contained in:
Erreur32 2024-07-10 14:17:48 +02:00 committed by GitHub
parent d204c6a1aa
commit ce5d8d65e4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 36 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
README.md
View File

@ -1,42 +1,40 @@
###############################################################################
# Nginx Proxy Manager CLI Script by Erreur32
#
# This script allows you to manage Nginx Proxy Manager via the API. It provides
# functionalities such as creating proxy hosts, managing users, and displaying
# configurations.
#
# Usage:
# ./nginx_proxy_manager_cli.sh [OPTIONS]
#
# Options:
# -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
#
# 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
# ./nginx_proxy_manager_cli.sh --list-hosts
#
###############################################################################
This script allows you to manage Nginx Proxy Manager via the API. It provides functionalities such as creating proxy hosts, managing users, and displaying configurations.
**Installation**: Simply copy nginx_proxy_manager_cli.sh where you want.
## Usage:
```bash
./nginx_proxy_manager_cli.sh [OPTIONS]
```
## 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
```
## 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
```