Update README.md

Added new start flags into README
This commit is contained in:
Toby Chui 2025-02-09 13:44:55 +08:00 committed by GitHub
parent e47a7a8357
commit 27695584ab
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -101,12 +101,20 @@ Usage of zoraxy:
ACME auto TLS/SSL certificate renew check interval (seconds) (default 86400) ACME auto TLS/SSL certificate renew check interval (seconds) (default 86400)
-cfgupgrade -cfgupgrade
Enable auto config upgrade if breaking change is detected (default true) Enable auto config upgrade if breaking change is detected (default true)
-db string
Database backend to use (leveldb, boltdb, auto) Note that fsdb will be used on unsupported platforms like RISCV (default "auto")
-default_inbound_enabled
If web server is enabled by default (default true)
-default_inbound_port int
Default web server listening port (default 443)
-docker -docker
Run Zoraxy in docker compatibility mode Run Zoraxy in docker compatibility mode
-earlyrenew int -earlyrenew int
Number of days to early renew a soon expiring certificate (days) (default 30) Number of days to early renew a soon expiring certificate (days) (default 30)
-fastgeoip -fastgeoip
Enable high speed geoip lookup, require 1GB extra memory (Not recommend for low end devices) Enable high speed geoip lookup, require 1GB extra memory (Not recommend for low end devices)
-log string
Log folder path (default "./log")
-mdns -mdns
Enable mDNS scanner and transponder (default true) Enable mDNS scanner and transponder (default true)
-mdnsname string -mdnsname string
@ -117,12 +125,16 @@ Usage of zoraxy:
Management web interface listening port (default ":8000") Management web interface listening port (default ":8000")
-sshlb -sshlb
Allow loopback web ssh connection (DANGER) Allow loopback web ssh connection (DANGER)
-update_geoip
Download the latest GeoIP data and exit
-uuid string
sys.uuid file path (default "./sys.uuid")
-version -version
Show version of this server Show version of this server
-webfm -webfm
Enable web file manager for static web server root folder (default true) Enable web file manager for static web server root folder (default true)
-webroot string -webroot string
Static web server root folder. Only allow chnage in start paramters (default "./www") Static web server root folder. Only allow change in start paramters (default "./www")
-ztauth string -ztauth string
ZeroTier authtoken for the local node ZeroTier authtoken for the local node
-ztport int -ztport int