diff --git a/README.md b/README.md index 80ae406..f956932 100644 --- a/README.md +++ b/README.md @@ -8,31 +8,31 @@ 中文介绍见 [Wiki](https://github.com/wweir/sower/wiki) -The sower is a cross-platform intelligent transparent proxy tool. It provide both socks5 proxy and DNS-based proxy. All these kinds of proxy support intelligent router. +Sower is a cross-platform intelligent transparent proxy tool. It provides both socks5 proxy and DNS-based proxy. All these kinds of proxies support intelligent routing. -If you already have another proxy solution, you can use it's socks5(h) service as a parent proxy to enjoy the sower's intelligent router. +If you already have another proxy solution, you can use its socks5(h) service as a parent proxy to enjoy sower's intelligent routing. ## Installation -To enjoy the sower, you need to deploy sower on both server-side(sowerd) and client-side(sower). +To enjoy sower, you need to deploy sower on both server-side(sowerd) and client-side(sower). ## Sowerd -_If you wanna use sower as secondary proxy to provide intelligent router, you can skip sowerd._ +_If you want to use sower as a secondary proxy to provide intelligent routing, you can skip sowerd._ -At the server-side, the sowerd runs just like a web server proxy. It will occupy two ports `80` / `443`. +On the server-side, sowerd runs just like a web server proxy. It will bind two ports `80` / `443`. -You can use your own certificate or the certificate automatically applied for by the sowerd from [`Let's Encrypt`](https://letsencrypt.org/). +You can use your own certificate or the certificate automatically applied for by sowerd from [`Let's Encrypt`](https://letsencrypt.org/). There are two ways to run the sowerd service: -1. run the shell command with root permission +1. Run the command with root permission ```shell # sowerd -password XXX -fake_site 127.0.0.1:8080 ``` -2. install as a systemd service +2. Install as a systemd service ```service [Unit] @@ -51,20 +51,21 @@ There are two ways to run the sowerd service: ## Sower -A config file is required in sower client side. [Here](https://github.com/wweir/sower/wiki/sower.hcl) is an usable example in China. +A config file is required on the sower client side. [Here](https://github.com/wweir/sower/wiki/sower.hcl) is a usable example in China. -`Sower` will take 4 port by default with root permission. They are: `udp(53)` / `tcp(80)` / `tcp(443)` / `tcp(1080)`. +`Sower` will bind 4 ports by default with root permission. They are: `udp(53)` / `tcp(80)` / `tcp(443)` / `tcp(1080)`. -After do the next three step, you can enjoy the intelligent transparent proxy solution: +After doing the next three steps, you can enjoy the intelligent transparent proxy solution: -1. run the command line with root permission: +1. Run the command with root permission: ```shell # sower -f sower.hcl ``` -2. changing your DNS server to `127.0.0.1` and -3. setting your proxy to `socks5h://127.0.0.1:1080`. +2. Change your DNS server to `127.0.0.1`. + +3. Set your proxy to `socks5h://127.0.0.1:1080`. ## Architecture