Skip to content

Commit 95cdb4d

Browse files
Erreur32Erreur32
authored
Update README.md
1 parent 4b3b057 commit 95cdb4d

File tree

1 file changed

+74
-44
lines changed

1 file changed

+74
-44
lines changed

‎README.md‎

Lines changed: 74 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -143,50 +143,80 @@ API_PASS="changeme"
143143
## Options
144144
```tcl
145145
146-
🌐 Host proxy creation:
147-
-d DOMAIN_NAMES Domain name (required for creating/updating hosts)
148-
-i FORWARD_HOST IP address or domain name of the target server (required for creating/updating hosts)
149-
-p FORWARD_PORT Port of the target server (required for creating/updating hosts)
150-
-f FORWARD_SCHEME Scheme for forwarding (http/https, default: http)
151-
-c CACHING_ENABLED Enable caching (true/false, default: false)
152-
-b BLOCK_EXPLOITS Block exploits (true/false, default: true)
153-
-w ALLOW_WEBSOCKET_UPGRADE Allow WebSocket upgrade (true/false, default: true)
154-
-h HTTP2_SUPPORT Enable HTTP/2 support (true/false, default: true)
155-
-l CUSTOM_LOCATIONS Custom locations (JSON array of location objects)
156-
-a ADVANCED_CONFIG Advanced configuration (block of configuration settings)
157-
-y Automatic yes prompts, yes sir!
158-
159-
📦 Backup and Restore:
160-
--backup Backup all configurations to a file
161-
--backup-host id Backup a single host configuration and its certificate (if exists)
162-
163-
🔧 Miscellaneous:
164-
--check-token Check if the current token is valid
165-
--create-user user pass email Create a user with a username, password and email
166-
--delete-user username Delete a user by username
167-
--host-delete id Delete a proxy host by ID
168-
--host-show id Show full details for a specific host by ID
169-
--show-default Show default settings for creating hosts
170-
--host-list List the names of all proxy hosts
171-
--host-list-full List all proxy hosts with full details
172-
--list-users List all users
173-
174-
--host-search hostname Search for a proxy host by domain name
175-
--host-enable id Enable a proxy host by ID
176-
--host-disable id Disable a proxy host by ID
177-
--host-ssl-enable id Enable SSL, HTTP/2, and HSTS for a proxy host
178-
--host-ssl-disable id Disable SSL, HTTP/2, and HSTS for a proxy host
179-
--list-ssl-cert List All SSL certificates availables (JSON)
180-
--cert-generate domain [email] [dns_provider] [dns_credentials] [-y] Generate certificate for the given domain and email
181-
--delete-cert domain Delete certificate for the given domain
182-
--list-access List all available access lists (ID and name)
183-
--host-acl-enable id,access_list_id Enable ACL for a proxy host by ID with an access list ID
184-
--host-acl-disable id Disable ACL for a proxy host by ID
185-
--access-list-create Create a new access list with name and rules
186-
--access-list-update id Update an existing access list by ID
187-
--access-list-delete id Delete an access list by ID (requires confirmation unless -y is used)
188-
--update-host id field=value Modify any field on existing entry host
189-
--help Display this help
146+
Options available:
147+
(see --examples for more details)
148+
-y Automatic yes prompts!
149+
--info Display Script Variables Information
150+
--show-default Show Default settings for host creation
151+
--check-token Check Check current token info
152+
--backup 💾 Backup All configurations to a different files in $DATA_DIR
153+
154+
Proxy Host Management:
155+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
156+
--host-search domain Search Proxy host by domain name
157+
--host-list List All Proxy hosts (to find ID)
158+
--host-show 🆔 Show Full details for a specific host by ID
159+
160+
--host-create domain -i forward_host -p forward_port [options]
161+
162+
Required:
163+
domain Domain name (required)
164+
-i forward-host IP address or domain name of the target server (required)
165+
-p forward-port Port of the target server (required)
166+
167+
optional: (Check default settings,no argument needed if already set!)
168+
-f FORWARD_SCHEME Scheme for forwarding (http/https, default: http)
169+
-c CACHING_ENABLED Enable caching (true/false, default: false)
170+
-b BLOCK_EXPLOITS Block exploits (true/false, default: true)
171+
-w ALLOW_WEBSOCKET_UPGRADE Allow WebSocket upgrade (true/false, default: true)
172+
-l CUSTOM_LOCATIONS Custom locations (JSON array of location objects)
173+
-a ADVANCED_CONFIG Advanced configuration (string)
174+
175+
--host-enable 🆔 Enable Proxy host by ID
176+
--host-disable 🆔 Disable Proxy host by ID
177+
--host-delete 🆔 Delete Proxy host by ID
178+
--host-update 🆔 [field]=value Update One specific field of an existing proxy host by ID
179+
(eg., --host-update 42 forward_host=foobar.local)
180+
181+
--host-acl-enable 🆔 access_list_id Enable ACL for Proxy host by ID with Access List ID
182+
--host-acl-disable 🆔 Disable ACL for Proxy host by ID
183+
--host-ssl-enable 🆔 [cert_id] Enable SSL for host ID optionally using specific certificate ID
184+
--host-ssl-disable 🆔 Disable SSL, HTTP/2, and HSTS for a proxy host
185+
186+
--cert-list List ALL SSL certificates
187+
--cert-show domain Or 🆔 List SSL certificates filtered by [domain name] (JSON)
188+
--cert-delete domain Or 🆔 Delete Certificate for the given 'domain'
189+
--cert-generate domain [email] Generate Let's Encrypt Certificate or others Providers.
190+
• Standard domains: example.com, sub.example.com
191+
• Wildcard domains: *.example.com (requires DNS challenge)
192+
• DNS Challenge: Required for wildcard certificates
193+
- Format: dns-provider PROVIDER dns-api-key KEY
194+
- Providers: dynu, cloudflare, digitalocean, godaddy, namecheap, route53, ovh, gcloud, ...
195+
196+
--user-list List All Users
197+
--user-create username password email Create User with a username, password and email
198+
--user-delete 🆔 Delete User by username
199+
200+
--access-list List All available Access Lists (ID and Name)
201+
--access-list-show 🆔 Show detailed information for specific access list
202+
--access-list-create Create Access Lists with options:
203+
• --satisfy [any|all] Set access list satisfaction mode
204+
• --pass-auth [true|false] Enable/disable password authentication
205+
• --users "user1,user2" List of users (comma-separated)
206+
• --allow "ip1,ip2" List of allowed IPs/ranges
207+
• --deny "ip1,ip2" List of denied IPs/ranges
208+
--access-list-delete 🆔 Delete Access List by access ID
209+
--access-list-update 🆔 Update Access List by access ID with options:
210+
• --name "new_name" New name for the access list
211+
• --satisfy [any|all] Update satisfaction mode
212+
• --pass-auth [true|false] Update password authentication
213+
• --users "user1,user2" Update list of users
214+
• --allow "ip1,ip2" Update allowed IPs/ranges
215+
• --deny "ip1,ip2" Update denied IPs/ranges
216+
217+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
218+
--examples 🔖 Examples commands, more explicits
219+
--help 👉 It's me
190220
191221
```
192222

0 commit comments

Comments
 (0)