Skip to content

Commit b45590f

Browse files
authored
Update README.md
1 parent a67a39f commit b45590f

File tree

1 file changed

+32
-31
lines changed

1 file changed

+32
-31
lines changed

README.md

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,8 @@ BASE_DIR="/path/nginx_proxy_script/data"
128128
# --delete-cert domain Delete certificate for the given domain
129129
# --list-access List all available access lists (ID and name)
130130
# --host-acl-enable id,access_list_id Enable ACL for a proxy host by ID with an access list ID
131-
# --host-acl-disable id Disable ACL for a proxy host by ID
131+
# --host-acl-disable id Disable ACL for a proxy host by ID
132+
# --update-host id field=value Modify any filed on existing entry host
132133
# --help Display this help
133134
134135
```
@@ -162,6 +163,36 @@ BASE_DIR="/path/nginx_proxy_script/data"
162163

163164
```
164165

166+
#### update
167+
##### update specific fields of an existing proxy host
168+
169+
The `--update-host` command allows you to **update specific fields** of an existing proxy host in Nginx Proxy Manager **without recreating it**.
170+
171+
Simply specify the **proxy host ID** and the **field you want to update**, like this:
172+
173+
```bash
174+
./nginx_proxy_manager_cli.sh --update-host 42 forward_host=new.backend.local
175+
```
176+
177+
| Field Name | Type | Description |
178+
|--------------------------|-----------|-----------------------------------------------------------------------------|
179+
| `domain_names` | `array` | List of domains handled by this proxy. |
180+
| `forward_host` | `string` | The destination (backend) hostname or IP. |
181+
| `forward_port` | `integer` | The destination port (e.g., `8000`, `443`). |
182+
| `forward_scheme` | `string` | The scheme: `http` or `https`. |
183+
| `enabled` | `boolean` | Whether the proxy is enabled (`true` or `false`). |
184+
| `ssl_forced` | `boolean` | Redirect all HTTP requests to HTTPS. |
185+
| `certificate_id` | `integer` | The ID of the SSL certificate to use. |
186+
| `meta.letsencrypt_agree` | `boolean` | Agree to Let's Encrypt TOS (`true` or `false`). |
187+
| `meta.dns_challenge` | `boolean` | Use DNS challenge for SSL cert (`true` or `false`). |
188+
| `allow_websocket_upgrade`| `boolean` | Enable WebSocket support (`true` or `false`). |
189+
| `http2_support` | `boolean` | Enable HTTP/2 (`true` or `false`). |
190+
| `caching_enabled` | `boolean` | Enable caching (`true` or `false`). |
191+
| `block_exploits` | `boolean` | Block known exploits (`true` or `false`). |
192+
| `advanced_config` | `string` | Custom Nginx directives (multiline string). |
193+
| `locations` | `array` | Custom location blocks (advanced use). |
194+
195+
165196

166197
#### Verifying the Configuration
167198

@@ -218,36 +249,6 @@ By following these steps, you can enable SSL for your proxy host for the first t
218249
2 titi.fun disable ✅
219250
3 tutu.fun enabled ✅
220251

221-
#### update
222-
##### update specific fields of an existing proxy host
223-
224-
The `--update-host` command allows you to **update specific fields** of an existing proxy host in Nginx Proxy Manager **without recreating it**.
225-
226-
Simply specify the **proxy host ID** and the **field you want to update**, like this:
227-
228-
```bash
229-
./nginx_proxy_manager_cli.sh --update-host 42 forward_host=new.backend.local
230-
```
231-
232-
| Field Name | Type | Description |
233-
|--------------------------|-----------|-----------------------------------------------------------------------------|
234-
| `domain_names` | `array` | List of domains handled by this proxy. |
235-
| `forward_host` | `string` | The destination (backend) hostname or IP. |
236-
| `forward_port` | `integer` | The destination port (e.g., `8000`, `443`). |
237-
| `forward_scheme` | `string` | The scheme: `http` or `https`. |
238-
| `enabled` | `boolean` | Whether the proxy is enabled (`true` or `false`). |
239-
| `ssl_forced` | `boolean` | Redirect all HTTP requests to HTTPS. |
240-
| `certificate_id` | `integer` | The ID of the SSL certificate to use. |
241-
| `meta.letsencrypt_agree` | `boolean` | Agree to Let's Encrypt TOS (`true` or `false`). |
242-
| `meta.dns_challenge` | `boolean` | Use DNS challenge for SSL cert (`true` or `false`). |
243-
| `allow_websocket_upgrade`| `boolean` | Enable WebSocket support (`true` or `false`). |
244-
| `http2_support` | `boolean` | Enable HTTP/2 (`true` or `false`). |
245-
| `caching_enabled` | `boolean` | Enable caching (`true` or `false`). |
246-
| `block_exploits` | `boolean` | Block known exploits (`true` or `false`). |
247-
| `advanced_config` | `string` | Custom Nginx directives (multiline string). |
248-
| `locations` | `array` | Custom location blocks (advanced use). |
249-
250-
251252

252253
##### **Other Exemple command:**
253254

0 commit comments

Comments
 (0)