mirror of
https://github.com/Erreur32/nginx-proxy-manager-Bash-API.git
synced 2024-12-22 13:32:11 +01:00
295 lines
10 KiB
Markdown
Executable file
295 lines
10 KiB
Markdown
Executable file
# Nginx Proxy Manager CLI Script
|
||
|
||
## Table of Contents
|
||
|
||
1. [Description](#description)
|
||
2. [Reference API](#reference)
|
||
3. [Prerequisites](#prerequisites)
|
||
4. [Installation](#installation)
|
||
5. [Settings](#settings)
|
||
6. [Usage](#usage)
|
||
7. [Options](#options)
|
||
8. [Examples](#examples)
|
||
- [Info script](#info)
|
||
- [List HOST](#list)
|
||
- [Enable SSL](#ssl)
|
||
12. [Screens](#screens)
|
||
13. [TODO](#todo)
|
||
|
||
> [!WARNING]
|
||
> The --restore command is disabled (a fix is in progress).
|
||
>
|
||
|
||
|
||
## Description
|
||
|
||
🛠️ This BASH script enables the management of  through its **API**.
|
||
|
||
🔑 **Automatically generates** and **manages tokens**, ensuring their validity, so you don't have to worry about token expiration.
|
||
|
||
⚙️ Provides functionalities such as creating and deleting proxy hosts, managing users, displaying configurations, creating **BACKUPS**, and more.
|
||
|
||
|
||
|
||
### French description:
|
||
Ce script permet de gérer Nginx Proxy Manager via l'API. Il fournit des fonctionnalités telles que la création de hosts proxy, la gestion des utilisateurs, et l'affichage des configurations avec creation de BACKUP !
|
||
La fonction RESTORE n'est pas encore terminée.
|
||
|
||
## Reference
|
||
|
||
|
||
## Prerequisites
|
||
|
||
And of course the excellent NPM ()
|
||
|
||
Required basic dependencies.
|
||
> The script will automatically check if they are installed and will download them if necessary:
|
||
|
||
- `curl`
|
||
- `jq`
|
||
|
||
|
||
## Installation
|
||
```
|
||
wget https://raw.githubusercontent.com/Erreur32/nginx-proxy-manager-API/main/nginx_proxy_manager_cli.sh
|
||
chmod +x nginx_proxy_manager_cli.sh
|
||
# Check script
|
||
./nginx_proxy_manager_cli.sh --info
|
||
```
|
||
|
||
|
||
> [!NOTE]
|
||
> With the new `V2.0.0`, some command arguments have been changed to be simpler, and need to set `BASE_DIR` variable to store `Tokens` and `Backups`.
|
||
|
||
|
||
## Settings
|
||
> [!IMPORTANT]
|
||
> (Optional) You can create a configuration file named `nginx_proxy_manager_cli.conf` with these 4 required variables.
|
||
|
||
To ensure the script is functional, edit these 4 variables (mandatory).
|
||
|
||
```bash
|
||
## Nginx proxy IP address (your Nginx IP)
|
||
NGINX_IP="127.0.0.1"
|
||
## Existing user (user and password) on NPM
|
||
API_USER="existingUser@mail.com"
|
||
API_PASS="password"
|
||
# Path to store .txt files and Backups
|
||
BASE_DIR="/path/nginx_proxy_script/data"
|
||
|
||
```
|
||
|
||
## Usage
|
||
```bash
|
||
./nginx_proxy_manager_cli.sh [OPTIONS]
|
||
./nginx_proxy_manager_cli.sh --info
|
||
./nginx_proxy_manager_cli.sh --show-default
|
||
```
|
||
|
||
## Options
|
||
```tcl
|
||
|
||
🌐 Host proxy creation:
|
||
-d DOMAIN_NAMES Domain name (required for creating/updating hosts)
|
||
-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)
|
||
-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: true)
|
||
-l CUSTOM_LOCATIONS Custom locations (JSON array of location objects)
|
||
-a ADVANCED_CONFIG Advanced configuration (block of configuration settings)
|
||
|
||
📦 Backup and Restore:
|
||
--backup Backup all configurations to a file
|
||
--backup-host id Backup a single host configuration and its certificate (if exists)
|
||
|
||
🔧 Miscellaneous:
|
||
# --check-token Check if the current token is valid
|
||
# --create-user user pass email Create a user with a username, password and email
|
||
# --delete-user username Delete a user by username
|
||
# --host-delete id Delete a proxy host by ID
|
||
# --host-show id Show full details for a specific host by ID
|
||
# --show-default Show default settings for creating hosts
|
||
# --host-list List the names of all proxy hosts
|
||
# --host-list-full List all proxy hosts with full details
|
||
# --host-list-users List all users
|
||
# --host-search hostname Search for a proxy host by domain name
|
||
# --host-enable id Enable a proxy host by ID
|
||
# --host-disable id Disable a proxy host by ID
|
||
# --host-ssl-enable id Enable SSL, HTTP/2, and HSTS for a proxy host
|
||
# --host-ssl-disable id Disable SSL, HTTP/2, and HSTS for a proxy host
|
||
# --list-ssl-certificates List All SSL certificates availables (JSON)
|
||
# --generate-cert domain email Generate certificate for the given domain and email
|
||
# --delete-cert domain Delete certificate for the given domain
|
||
# --help Display this help
|
||
|
||
```
|
||
|
||
## Examples
|
||
|
||
```bash
|
||
📦 Backup First !
|
||
./nginx_proxy_manager_cli.sh --backup
|
||
|
||
🌐 Host Creation:
|
||
./nginx_proxy_manager_cli.sh -d example.com -i 192.168.1.10 -p 8080 (check default values below)
|
||
./nginx_proxy_manager_cli.sh --info
|
||
./nginx_proxy_manager_cli.sh --show-default
|
||
./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 --host-list
|
||
./nginx_proxy_manager_cli.sh --host-ssl-enable 10
|
||
|
||
🔧 Advanced 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;'
|
||
|
||
🛡️ Custom Certificate:
|
||
./nginx_proxy_manager_cli.sh --generate-cert example.com user@example.com
|
||
|
||
🛡️ Custom locations:
|
||
./nginx_proxy_manager_cli.sh -d example.com -i 192.168.1.10 -p 8080 -l '[{"path":"/api","forward_host":"192.168.1.11","forward_port":8081}]'
|
||
|
||
🔖 Full options:
|
||
./nginx_proxy_manager_cli.sh -d 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}]'
|
||
|
||
```
|
||
|
||
|
||
##### Verifying the Configuration
|
||
|
||
###### Info
|
||
|
||
Some info of settings in the script with `./nginx_proxy_manager_cli_.sh --info`
|
||
|
||
|
||
```bash
|
||
./nginx_proxy_manager_cli_.sh --info
|
||
|
||
Script Info: 2.3.5
|
||
|
||
Script Variables Information:
|
||
BASE_URL http://127.0.0.1:81/api
|
||
NGINX_IP 127.0.0.1
|
||
API_USER user@monmail.com
|
||
BASE_DIR /path/to/nginx_proxy
|
||
BACKUP_DIR /path/to/nginx_proxy/backups
|
||
BACKUP HOST 40
|
||
Token NPM /path/to/nginx_proxy/token/token_127.0.0.1.txt
|
||
|
||
```
|
||
|
||
|
||
**How to activate SSL ?**
|
||
|
||
By following these steps, you can enable SSL for your proxy host for the first time using Let's Encrypt.
|
||
|
||
##### List
|
||
List all Host in one command and show ´id´ , ´status´ and ´SSL´ status:
|
||
|
||
./nginx_proxy_manager_cli.sh --host-list
|
||
|
||
👉 List of proxy hosts (simple)
|
||
ID Domain Status SSL
|
||
1 toto.fun enabled ✘
|
||
2 titi.fun disable ✅
|
||
3 tutu.fun enabled ✅
|
||
|
||
|
||
##### SSL
|
||
Enable SSL for the Host:
|
||
|
||
Assuming the host ID is *1*, you would enable SSL for the host as follows:
|
||
|
||
./nginx_proxy_manager_cli.sh --host-ssl-enable 1
|
||
|
||
SSl is enable successfully, check again with --host-list
|
||
|
||
./nginx_proxy_manager_cli.sh --host-list
|
||
|
||
👉 List of proxy hosts (simple)
|
||
ID Domain Status SSL
|
||
1 toto.fun enabled ✅
|
||
2 titi.fun disable ✅
|
||
3 tutu.fun enabled ✅
|
||
|
||
|
||
Et Voilà.
|
||
|
||
|
||
**Other Exemple command:**
|
||
|
||
|
||
Host proxy info command `--host-show id`
|
||
|
||
|
||
```
|
||
./nginx_proxy_manager_cli_.sh --host-show 1
|
||
|
||
✅ Nginx url: http://127.0.0.1:81/api
|
||
✅ The token is valid. Expiry: 2025-07-12T08:14:58.521Z
|
||
|
||
👉 Full details for proxy host ID: 59...
|
||
|
||
{
|
||
"id": 10,
|
||
"created_on": "2024-07-11 13:16:34",
|
||
"modified_on": "2024-07-13 09:42:40",
|
||
"owner_user_id": 1,
|
||
"domain_names": [
|
||
"test.domain.com"
|
||
],
|
||
"forward_host": "127.0.0.1",
|
||
"forward_port": 80,
|
||
"access_list_id": 0,
|
||
"certificate_id": 81,
|
||
"ssl_forced": 1,
|
||
"caching_enabled": 0,
|
||
"block_exploits": 1,
|
||
"advanced_config": "",
|
||
"meta": {
|
||
"letsencrypt_agree": true,
|
||
"letsencrypt_email": "",
|
||
"nginx_online": true,
|
||
"nginx_err": null
|
||
},
|
||
"allow_websocket_upgrade": 1,
|
||
"http2_support": 1,
|
||
"forward_scheme": "http",
|
||
"enabled": 1,
|
||
"locations": [],
|
||
"hsts_enabled": 1,
|
||
"hsts_subdomains": 0
|
||
}
|
||
|
||
```
|
||
|
||
|
||
## Screens:
|
||
```
|
||
# ./nginx_proxy_manager_cli.sh --backup
|
||
|
||
✅ Users backup completed 🆗: /path/to/nginx_proxy/backups/users_127_0_0_1_2024_07_29__14_01_23.json
|
||
✅ Settings backup completed 🆗: /path/to/nginx_proxy/backups/settings_127_0_0_1_2024_07_29__14_01_23.json
|
||
✅ Proxy host backup completed 🆗: /path/to/nginx_proxy/backups
|
||
✅ Access lists backup completed 🆗: /path/to/nginx_proxy/backups/access_lists_127_0_0_1_2024_07_29__14_01_23.json
|
||
✅ Backup 🆗
|
||
📦 Backup Summary:
|
||
- Number of users backed up: 1
|
||
- Number of proxy hosts backed up: 31
|
||
- Total number of backup files: 42
|
||
|
||
|
||
```
|
||
|
||
|
||
|
||
|
||
## TODO:
|
||
- [x] add setting for ADVANCED configuration in npm `location / { ... }`
|
||
- [x] Add documentation on certain functions
|
||
- [x] ADD: a configuration function for Custom Locations
|
||
- [x] Backup all settings from NPM
|
||
- [ ] Domain TLS check validity
|
||
- [ ] Better Error Handeling
|
||
- [ ] Restore Function need to be optimized
|