diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml index cd80fbd..d4c8c4f 100644 --- a/.github/workflows/go.yml +++ b/.github/workflows/go.yml @@ -1,44 +1,35 @@ name: Go on: push: - branches: - - master + tags: + - "v*.*.*" jobs: build: name: Build runs-on: ubuntu-latest steps: - - name: Check out code into the Go module directory - uses: actions/checkout@v1 - - - name: Set up Go Build Environment - uses: actions/setup-go@v1 - with: - go-version: 1.13 - id: go - - - name: Prepare Scripts - run: | - cp conf/sower.toml . - cp -r .github/* . + - uses: actions/setup-go@v2-beta + - uses: actions/checkout@v2 - name: build matrix run: | + cp conf/sower.toml sower.toml + GOOS=linux GOARCH=amd64 make build - tar czvf sower-linux-amd64.tar.gz sower sower.toml sower-client.service sower-server.service + tar czvf sower-linux-amd64.tar.gz sower sower.toml GOOS=linux GOARCH=386 make build - tar czvf sower-linux-386.tar.gz sower sower.toml sower-client.service sower-server.service + tar czvf sower-linux-386.tar.gz sower sower.toml GOOS=linux GOARCH=arm make build - tar czvf sower-linux-arm.tar.gz sower sower.toml sower-client.service sower-server.service + tar czvf sower-linux-arm.tar.gz sower sower.toml GOOS=linux GOARCH=arm64 make build - tar czvf sower-linux-arm64.tar.gz sower sower.toml sower-client.service sower-server.service + tar czvf sower-linux-arm64.tar.gz sower sower.toml GOOS=linux GOARCH=mips make build - tar czvf sower-linux-mips.tar.gz sower sower.toml sower-client.service sower-server.service + tar czvf sower-linux-mips.tar.gz sower sower.toml GOOS=linux GOARCH=mipsle make build - tar czvf sower-linux-mipsle.tar.gz sower sower.toml sower-client.service sower-server.service + tar czvf sower-linux-mipsle.tar.gz sower sower.toml GOOS=darwin GOARCH=amd64 make build - tar czvf sower-darwin-amd64.tar.gz sower sower.toml cc.wweir.sower.plist + tar czvf sower-darwin-amd64.tar.gz sower sower.toml GOOS=windows GOARCH=amd64 make build tar czvf sower-windows-amd64.tar.gz sower.exe sower.toml @@ -46,8 +37,7 @@ jobs: tar czvf sower-windows-386.tar.gz sower.exe sower.toml - name: Release - uses: softprops/action-gh-release@v1 - if: startsWith(github.ref, 'refs/tags/') + uses: softprops/action-gh-release@master with: files: | sower-linux-amd64.tar.gz diff --git a/Makefile b/Makefile index c2ba3d3..da8f9ce 100644 --- a/Makefile +++ b/Makefile @@ -5,7 +5,7 @@ test: go list ./... | grep -v internal | xargs go test build: go build -ldflags "-w -s \ - -X conf.version=$(shell git describe --tags) \ + -X conf.version=$(shell git describe --tags --always) \ -X conf.date=$(shell date +%Y-%m-%d)" image: docker build -t sower -f .github/Dockerfile . diff --git a/README.md b/README.md index f84f2fb..5485645 100644 --- a/README.md +++ b/README.md @@ -11,28 +11,28 @@ The sower is a cross-platform intelligent transparent proxy tool. -The first time you visit a new website, the sower will detect if the domain in the block list and add it in the dynamic detect list. So, you do not need to care about the rules, sower will handle it in an intelligent way. +The first time you visit a new website, the sower will detect if the domain is accessible and add it in the dynamic detect list. So, you do not need to care about the rules, sower will handle it intelligently. -Sower provider both http_proxy/https_proxy and dns-based proxy. All these kinds of proxy support intelligent router. You can also port-forward any tcp request to remote, such as: ssh / smtp / pop3. +Sower provider both http_proxy/https_proxy and DNS-based proxy. All these kinds of proxy support intelligent router. You can also port-forward any TCP request to remote, such as SSH / SMTP / POP3. -You are able to enjoy it by setting http_proxy or your DNS without any other settings. +You can enjoy it by setting http_proxy or your DNS without any other settings. -If you already have another proxy solution, you can use it's socks5(h) service as parent proxy to enjoy sower's intelligent router. +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. ## Installation To enjoy the sower, you need to deploy sower on both server-side and client-side. -Installation script has been integrated into sower. You can install sower as system service by running `./sower -install 'xxx'` +The installation script has been integrated into the sower. You can install sower as system service by running `./sower -install 'xxx'` ## Server -*If you already have another proxy solution with socks5h support, you can skip server side.* +*If you already have another proxy solution with socks5h support, you can skip server-side.* -At server-side, sower run just like a web server proxy. -It redirect http request to https, and proxy https requests to the setted upstream http service. -You can use your own certificate or use the auto generated certificate by sower. +At the server-side, the sower runs just like a web server proxy. +It redirects HTTP requests to HTTPS and proxy https requests to the upstream HTTP service. +You can use your certificate or use the auto-generated certificate by the sower. -What you must set is the upstream http service. You can set it by parameter `-s`, eg: +What you must set is the upstream HTTP service. You can set it by parameter `-s`, eg: ``` shell # sower -s 127.0.0.1:8080 ``` @@ -44,15 +44,15 @@ The easiest way to run it is: ``` But a configuration file is recommended to persist dynamic rules in client side. -There are 3 kinds of proxy solutions, they are: http(s)_proxy / dns-based proxy / port-forward. +There are 3 kinds of proxy solutions, they are HTTP(S)_PROXY / DNS-based proxy / port-forward. ### HTTP(S)_PROXY -An http(s)_proxy listening on `:8080` is setted by deault if you run sower as client mode. +An HTTP(S)_PROXY listening on `:8080` is set by default if you run sower as client mode. -### dns-based proxy -You can set the `serve_ip` field in `dns` section in configuration file to start dns-based proxy. You should also set the value of `serve_ip` as your default DNS in OS. +### DNS-based proxy +You can set the `serve_ip` field in the `dns` section in the configuration file to start the DNS-based proxy. You should also set the value of `serve_ip` as your default DNS in OS. -If you want to enjoy the full experience provided by sower, you can take sower as your private DNS on long running server and setting it as your default DNS in you router. +If you want to enjoy the full experience provided by the sower, you can take sower as your private DNS on a long-running server and set it as your default DNS in your router. ### port-forward The port-forward can be only setted in configuration file, you can set it in section `client.router.port_mapping`, eg: