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

various (conjugation, etc) fixes

Lomanic 2025-05-01 23:12:26 +02:00
parent bd0c6d737a
commit 92fc706466
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
Getting-Started.md

@ -1,14 +1,14 @@
Here is a quick tutorial to get your Zoraxy up and running to serve your self-hosted site.
If you have having issue with the docker version of Zoraxy, see [here](https://github.com/tobychui/zoraxy/wiki/Zoraxy-in-Docker-with-Portainer-and-Nginx-as-examples).
If you are having issues with the docker version of Zoraxy, see [here](https://github.com/tobychui/zoraxy/wiki/Zoraxy-in-Docker-with-Portainer-and-Nginx-as-examples).
## 1. Get Zoraxy
Visit the [release page](https://github.com/tobychui/zoraxy/releases/) and get Zoraxy that matches your server's OS and CPU architecture.
Visit the [release page](https://github.com/tobychui/zoraxy/releases/) and download the version that matches your server's OS and CPU architecture.
**For those who are not experience with networking in dockerized environment, DO NOT use the docker version. Most of the Zoraxy functions are automated based on different kind of protocol sniffing logics and usually require direct access to the networking interface and original (unmodified) request. Zoraxy will still works in docker with incorrect network settings, but you might see unexpected routing / access control behavior or incorrect statistics.**
**For those who are not experienced with networking in a dockerized environment, DO NOT use the docker version. Most of the Zoraxy functions are automated based on different kinds of protocol sniffing logic and usually require direct access to the networking interface and the original (unmodified) request. Zoraxy will still work in docker with incorrect network settings, but you might see unexpected routing/access control behavior or incorrect statistics.**
## 2. Setup system daemon for Zoraxy
If you are using Linux, system daemon can be setup using systemctl. You can follow the steps mentioned [here](https://github.com/tobychui/zoraxy/wiki/FAQ---Frequently-Asked-Questions#create-a-systemd-service-for-zoraxy) to create the service file.
If you are using Linux, system daemon can be set up using systemctl. You can follow the steps mentioned [here](https://github.com/tobychui/zoraxy/wiki/FAQ---Frequently-Asked-Questions#create-a-systemd-service-for-zoraxy) to create the service file.
If you are using Windows, you can first create a desktop shortcut for Zoraxy and move the shortcut inside your `startup` folder. Afterward, when your computer finished startup, Zoraxy will also be started automatically.
@ -22,14 +22,14 @@ After your account is setup and logged in, you will see the Zoraxy management in
![圖片](https://github.com/tobychui/zoraxy/assets/24617523/61eb1498-179a-4859-984f-dacd7beb0777)
## 4. Setting up your host in Zoraxy
Lets assume your DNS has already been configured to point a certain domain to Zoraxy. If no, you should go to your DNS provider and create an A record that point to the IP address of which your Zoraxy is hosted. Here is an example where the `93.184.216.34` should be changed to your server's (public) IP address and `example.com` is your domain.
Let's assume your DNS has already been configured to point a certain domain to Zoraxy. If not, you should go to your DNS provider and create an A record that points to the IP address of which your Zoraxy is hosted. Here is an example where the `93.184.216.34` should be changed to your server's (public) IP address and `example.com` is your domain.
Name | Type | Data | TTL | Class
-- | -- | -- | -- | --
example.com | A | 93.184.216.34 | 86400 | IN
_If you are hosting Zoraxy under an NAT router, remember to port forward the required ports (usually port 80 and 443) to your server that is hosting Zoraxy._
_If you are hosting Zoraxy behind a NAT, remember to port forward the required ports (usually port 80 and 443) on your router to your server that is hosting Zoraxy._
By default, Zoraxy listens to port 80 (default http port). You can check if Zoraxy is working by visiting `http://server_ip_here/` and you should be able to see the Zoraxy build in static web server.
By default, Zoraxy listens to port 80 (default http port). You can check if Zoraxy is working by visiting `http://server_ip_here/` and you should be able to see the Zoraxy built-in static web server.
![圖片](https://github.com/tobychui/zoraxy/assets/24617523/4ff33a5e-46be-4a65-988a-923dba0e9eca)
If no, please make sure your Static Web server is enabled and the default site is set to "Internal Static Web Server"
@ -41,18 +41,18 @@ If no, please make sure your Static Web server is enabled and the default site i
If everything is working, once you enter your domain name into your browser and connect to it using HTTP (e.g. `http://you_domain.com`), you should be able to see the static web server page identical as what you would see when visiting your server via LAN IP address (e.g. http://server_ip_here/`)
## 5. Setting Up Subdomain
Let say you have another web server in LAN with LAN IP `192.168.0.101` providing another web server at port `8080` which you want to expose using subdomain (e.g. http://arozos.example.com). Also lets assume you already have a subdomain CNAME record set in your DNS provider that points to the A record of your domain which looks something like this
Let's say you have another web server in LAN with LAN IP `192.168.0.101` providing another web server at port `8080` which you want to expose using a subdomain (e.g. http://arozos.example.com). Also let's assume you already have a subdomain CNAME record set in your DNS provider that points to the A record of your domain which looks something like this
Name | Type | Data | TTL | Class
-- | -- | -- | -- | --
example.com | A | 93.184.216.34 | 86400 | IN
arozos.example.com | CNAME | example.com | 600 | IN
Then you can teach Zoraxy how to route traffics if the visitor is coming from arozos.example.com. To do that, you first go to `Create Proxy Rules` > Fill in all the information > Create Endpoint and fill in the information as follows.
Then you can tell Zoraxy how to route traffic when visitors are coming from arozos.example.com. To do that, you first go to `Create Proxy Rules` > Fill in all the information > Create Endpoint and fill in the information as follows.
![圖片](https://github.com/tobychui/zoraxy/assets/24617523/6e03b988-6b1c-4cf6-81fe-bc5b856f7324)
* If your service requires TLS connections (i.e. you must connect to it using https://), check the "Proxy Target require TLS Connection" options.
* Sometime, these services might also uses a self-signed certificate. In such case, you will also need to open the "Advance Setting" dropdown menu and select "Ignore TLS/SSL Verification Error" option.
* Websocket is automatically proxied using header sniffing detection approach. You do not need to setup websocket manually and Zoraxy will decided when to switch to websocket for you.
* If your service requires TLS connections (i.e. you must connect to it using https://), check the "Proxy Target requires TLS Connection" options.
* Sometimes, these services might also use a self-signed certificate. In such case, you will also need to open the "Advanced Settings" dropdown menu and select the "Ignore TLS/SSL Verification Error" option.
* Websockets are automatically proxied using header sniffing detection. You do not need to setup websockets manually and Zoraxy will decide when to switch to websocket for you.
![圖片](https://github.com/tobychui/zoraxy/assets/24617523/6636b7f7-c601-4c79-bad8-849748d7fe0f)
@ -60,7 +60,7 @@ After the setup is completed, you will see your subdomain being registered in th
![圖片](https://github.com/tobychui/zoraxy/assets/24617523/8aeab10a-3c5e-4ad4-81b2-cd3f9399533a)
## Setting up TLS / SSL certificate for your site
To setup TLS/SSL certificate for your site, you can go to the TLS / SSL certificates tab. Scroll to the bottom of the page and click on the "Open ACME tool".
To set up TLS/SSL certificate for your site, you can go to the TLS/SSL certificates tab. Scroll to the bottom of the page and click on the "Open ACME tool".
![圖片](https://github.com/tobychui/zoraxy/assets/24617523/443a882b-0cee-45d2-b1a9-7321b5aebadc)
@ -79,7 +79,7 @@ Certificate generation will take a few minutes. After it is completed, you can g
![圖片](https://github.com/tobychui/zoraxy/assets/24617523/8b9bbd3f-37d2-4c9d-9493-47f6f92009f8)
Now, you should be able to visit your site with `https://arozos.example.com` and see a valid TLS certificate being loaded. If you see a self-signed certificate, which means your "Get Certificate" steps is not successful. You might want to use the HTTPS wizard and try to debug your networking issues. You can find the link to the build in HTTPS wizard under the "Get Certificate" button.
Now, you should be able to visit your site with `https://arozos.example.com` and see a valid TLS certificate being loaded. If you see a self-signed certificate, this means your "Get Certificate" steps were not successful. You might want to use the HTTPS wizard and try to debug your networking issues. You can find the link to the build in HTTPS wizard under the "Get Certificate" button.
![圖片](https://github.com/tobychui/zoraxy/assets/24617523/81abae39-15b1-4a8c-8f59-25f02ce308fa)