marcel/zoraxy
1
0
Fork 0
mirror of https://github.com/tobychui/zoraxy.git synced 2025-06-04 22:57:20 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated README

Browse Source 
- Added start.sh
- Updated provider.json
This commit is contained in:
Toby Chui 2024-05-15 14:27:59 +08:00
parent ce4f46cb50
commit 7b69b5fa63
3 changed files with 14 additions and 405 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -34,6 +34,7 @@ General purpose request (reverse) proxy and forwarding tool for networking noobs
- SMTP config for password reset - SMTP config for password reset
## Downloads ## Downloads
[Windows](https://github.com/tobychui/zoraxy/releases/latest/download/zoraxy_windows_amd64.exe) [Windows](https://github.com/tobychui/zoraxy/releases/latest/download/zoraxy_windows_amd64.exe)
/[Linux (amd64)](https://github.com/tobychui/zoraxy/releases/latest/download/zoraxy_linux_amd64) /[Linux (amd64)](https://github.com/tobychui/zoraxy/releases/latest/download/zoraxy_linux_amd64)
/[Linux (arm64)](https://github.com/tobychui/zoraxy/releases/latest/download/zoraxy_linux_arm64) /[Linux (arm64)](https://github.com/tobychui/zoraxy/releases/latest/download/zoraxy_linux_arm64)
@ -41,6 +42,7 @@ General purpose request (reverse) proxy and forwarding tool for networking noobs
For other systems or architectures, please see [Release](https://github.com/tobychui/zoraxy/releases/latest/) For other systems or architectures, please see [Release](https://github.com/tobychui/zoraxy/releases/latest/)
## Build from Source ## Build from Source
Requires Go 1.22 or higher Requires Go 1.22 or higher
```bash ```bash
@ -79,21 +81,23 @@ The installation method is same as Linux. If you are using a Raspberry Pi 4 or n
The installation method is same as Linux. For other ARM SBCs, please refer to your SBC's CPU architecture and pick the one that is suitable for your device. The installation method is same as Linux. For other ARM SBCs, please refer to your SBC's CPU architecture and pick the one that is suitable for your device.
#### Docker #### Docker
See the [/docker](https://github.com/tobychui/zoraxy/tree/main/docker) folder for more details. See the [/docker](https://github.com/tobychui/zoraxy/tree/main/docker) folder for more details.
### Start Paramters ### Start Paramters
``` ```
Usage of zoraxy: Usage of zoraxy:
-autorenew int -autorenew int
ACME auto TLS/SSL certificate renew check interval (seconds) (default 86400) ACME auto TLS/SSL certificate renew check interval (seconds) (default 86400)
-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)
-info
Show information about this program in JSON
-log -log
Log terminal output to file (default true) Log terminal output to file (default true)
-mdns -mdns
Enable mDNS scanner and transponder (default true) Enable mDNS scanner and transponder (default true)
-mdnsname string
mDNS name, leave empty to use default (zoraxy_{node-uuid}.local)
-noauth -noauth
Disable authentication for management interface Disable authentication for management interface
-port string -port string
@ -153,6 +157,7 @@ This allows you to have an infinite number of network members in your Global Are
## Web SSH ## Web SSH
Web SSH currently only supports Linux based OSes. The following platforms are supported: Web SSH currently only supports Linux based OSes. The following platforms are supported:
- linux/amd64 - linux/amd64
- linux/arm64 - linux/arm64
- linux/armv6 (experimental) - linux/armv6 (experimental)
@ -167,12 +172,14 @@ Loopback web SSH connection, by default, is disabled. This means that if you are
``` ```
## Sponsor This Project ## Sponsor This Project
If you like the project and want to support us, please consider a donation. You can use the links below If you like the project and want to support us, please consider a donation. You can use the links below
- [tobychui (Primary author)](https://paypal.me/tobychui) - [tobychui (Primary author)](https://paypal.me/tobychui)
- PassiveLemon (Docker compatibility maintainer) - PassiveLemon (Docker compatibility maintainer)
## License ## License
This project is open-sourced under AGPL. I open-sourced this project so everyone can check for security issues and benefit all users. **If you plan to use this project in a commercial environment (which violate the AGPL terms), please contact toby@imuslab.com for an alternative license.** This project is open-sourced under AGPL. I open-sourced this project so everyone can check for security issues and benefit all users. **This software is intended to be free of charge. If you have acquired this software from a third-party seller, the authors of this repository bears no responsibility for any technical difficulties assistance or support.**

400
src/mod/acme/acmedns/providers.json
View File

File diff suppressed because it is too large Load Diff

2
src/start.sh Normal file
View File

@ -0,0 +1,2 @@
#/bin/bash
sudo ./zoraxy