Skip to content

Commit 70f6ba7

Browse files
committed
Update: README.md
1 parent 6fc3c7a commit 70f6ba7

File tree

1 file changed

+7
-21
lines changed

1 file changed

+7
-21
lines changed

README.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
> [!WARNING]
3131
> The --restore command is disabled (a fix is in progress).
3232
>
33-
> V2.6.0 introduced some issues. A fix has been tested and pushed, but user feedback is required to ensure everything works as expected with V2.7.0.
33+
3434

3535
## Description
3636
🛠️ This script allows you to efficiently manage [Nginx Proxy Manager](https://github.com/NginxProxyManager/nginx-proxy-manager?utm_source=nginx-proxy-manager) via its **API**. It provides advanced features such as proxy host creation, user management, and configuration display, while also integrating a backup system (BACKUP) with a user-friendly interface.
@@ -105,13 +105,6 @@ API_PASS="changeme"
105105
./npm-api.sh --show-default
106106
```
107107

108-
> [!NOTE]
109-
> **New in version 2.6.0:**
110-
> - 📊 New dashboard (by default)
111-
> - 🔐 Improved token management
112-
> - 📋 Enhanced command display and options
113-
> - 🎨 More user-friendly interface with icons and colors
114-
115108
## NEW dashboard
116109

117110
```bash
@@ -248,25 +241,19 @@ API_PASS="changeme"
248241
./npm-api.sh --host-create example.com -i 192.168.1.10 -p 8080 \
249242
-a 'proxy_set_header X-Real-IP $remote_addr;'
250243

251-
# Custom locations
244+
🛡️ Custom locations:
252245
./npm-api.sh --host-create example.com -i 192.168.1.10 -p 8080 \
253246
-l '[{"path":"/api","forward_host":"192.168.1.11","forward_port":8081}]'
254247

255248
# Update specific fields
256249
./npm-api.sh --update-host 42 forward_scheme=https
257250
./npm-api.sh --update-host 42 forward_port=8443
258251

259-
🔧 Advanced Example:
260-
./npm-api.sh --host-create 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;'
261-
262252
🛡️ Custom Certificate:
263253
./npm-api.sh --generate-cert example.com user@example.com
264254
# Note: This will generate a Let's Encrypt certificate only
265255

266-
🛡️ Custom locations:
267-
./npm-api.sh --host-create example.com -i 192.168.1.10 -p 8080 -l '[{"path":"/api","forward_host":"192.168.1.11","forward_port":8081}]'
268-
269-
🔖 Full options:
256+
🔖 Full options:
270257
./npm-api.sh --host-create example.com -i 192.168.1.10 -p 8080 -f https -c true -b true -w true -a 'proxy_set_header X-Real-IP $remote_addr;' -l '[{"path":"/api","forward_host":"192.168.1.11","forward_port":8081}]'
271258
```
272259

@@ -510,8 +497,8 @@ Host proxy info command `--host-show id`
510497

511498
We have performed a **force push (`git push --force`)** on this repository to remove sensitive data from the history. As a result, the commit history has been rewritten, and your local copy may be out of sync.
512499

513-
### 🛠️ What You Need to Do?
514-
To avoid any issues, please follow these steps to update your local repository:
500+
🛠️ What You Need to Do?
501+
To avoid any issues, please follow these steps to update your local repository:
515502

516503
```bash
517504
git fetch --all
@@ -520,9 +507,8 @@ git reset --hard origin/main # Replace 'main' with your branch name if differen
520507
If you have local changes that you **don't want to lose**, consider making a backup before running these commands.
521508

522509
❓ Why Was This Done?
523-
This action was necessary to **remove sensitive data** from the repository's history and ensure better security.
524-
525-
510+
This action was necessary to **remove sensitive data** from the repository's history and ensure better security.
511+
526512
## TODO:
527513
- [x] add setting for ADVANCED configuration in npm `location / { ... }`
528514
- [x] Add documentation on certain functions

0 commit comments

Comments
 (0)