Update README.md

This commit is contained in:
Erreur32 2024-07-11 18:27:04 +02:00 committed by GitHub
parent e23b31be83
commit f49ee38c87
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -27,7 +27,7 @@ wget https://raw.githubusercontent.com/Erreur32/nginx-proxy-manager-API/main/ngi
chmod +x nginx_proxy_manager_cli.sh chmod +x nginx_proxy_manager_cli.sh
``` ```
## Settings: ## Settings
Only edit these 3 variables: Only edit these 3 variables:
``` ```
@ -38,12 +38,12 @@ API_USER="existingUser@mail.com"
API_PASS="password" API_PASS="password"
``` ```
## Usage: ## Usage
```bash ```bash
./nginx_proxy_manager_cli.sh [OPTIONS] ./nginx_proxy_manager_cli.sh [OPTIONS]
``` ```
## Options: ## Options
```tcl ```tcl
-d DOMAIN_NAMES Domain name (required) -d DOMAIN_NAMES Domain name (required)
-i FORWARD_HOST IP address or domain name of the target server (required) -i FORWARD_HOST IP address or domain name of the target server (required)
@ -67,7 +67,7 @@ API_PASS="password"
--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 ./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 --create-user newuser password123
@ -77,5 +77,6 @@ API_PASS="password"
![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)
## TODO: ## TODO:
- add setting for ADVANCED configuration in `location / { ... }` - [x] add setting for ADVANCED configuration in `location / { ... }`
- [ ] Need some documentation
- [ ] SSL check