# sower

[![GitHub release](http://img.shields.io/github/release/wweir/sower.svg?style=popout)](https://github.com/wweir/sower/releases)
[![Actions Status](https://github.com/wweir/sower/workflows/Go/badge.svg)](https://github.com/wweir/sower/actions)
[![GitHub issue](https://img.shields.io/github/issues/wweir/sower.svg?style=popout)](https://github.com/wweir/sower/issues)
[![GitHub star](https://img.shields.io/github/stars/wweir/sower.svg?style=popout)](https://github.com/wweir/sower/stargazers)
[![GitHub license](https://img.shields.io/github/license/wweir/sower.svg?style=popout)](LICENSE)

中文介绍见 [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.

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(sowerd) and client-side(sower).

## Sowerd

_If you wanna use sower as secondary proxy to provide intelligent router, you can skip sowerd._

At the server-side, the sowerd runs just like a web server proxy. It will occupy 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/).

There are two ways to run the sowerd service:

1. run the shell command with root permission

   ```shell
   # sowerd -password XXX -fake_site 127.0.0.1:8080
   ```

2. install as a systemd service

   ```service
   [Unit]
   Description=sower server service
   After=network.target

   [Service]
   Type=simple
   ExecStart=/usr/local/bin/sowerd
   Environment="FAKE_SITE=127.0.0.1:8080"
   Environment="PASSWORD=XXX"

   [Install]
   WantedBy=multi-user.target
   ```

## 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.

`Sower` will take 4 port 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:

1. run the command line 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`.

## Architecture

![Architecture diagram](./sower.drawio.svg)