2021-10-21 08:43:59 +00:00
# Fourth
> Hey, now we are on level 4!
2021-10-25 14:29:02 +00:00
[](https://crates.io/crates/fourth) [](https://github.com/KernelErr/fourth/actions/workflows/rust.yml)
2021-10-26 15:58:00 +00:00
**Under heavy development, version 0.1 may update frequently**
2021-10-26 13:36:12 +00:00
Fourth is a layer 4 proxy implemented by Rust to listen on specific ports and transfer TCP/KCP data to remote addresses(only TCP) according to configuration.
2021-10-21 08:43:59 +00:00
## Features
- Listen on specific port and proxy to local or remote port
- SNI-based rule without terminating TLS connection
2021-10-26 15:02:05 +00:00
- Allow KCP inbound(warning: untested)
2021-10-21 08:43:59 +00:00
## Installation
To gain best performance on your computer's architecture, please consider build the source code. First, you may need [Rust tool chain ](https://rustup.rs/ ).
```bash
$ cd fourth
$ cargo build --release
```
Binary file will be generated at `target/release/fourth` , or you can use `cargo install --path .` to install.
2021-10-26 13:40:40 +00:00
Or you can use Cargo to install Fourth:
```bash
$ cargo install fourth
```
2021-10-21 08:43:59 +00:00
## Configuration
Fourth will read yaml format configuration file from `/etc/fourth/config.yaml` , here is an example:
```yaml
version: 1
log: info
servers:
example_server:
listen:
- "0.0.0.0:443"
- "[::]:443"
tls: true # Enable TLS features like SNI
sni:
proxy.example.com: proxy
www.example.com: nginx
default: ban
relay_server:
listen:
- "127.0.0.1:8081"
default: remote
upstream:
nginx: "127.0.0.1:8080"
proxy: "127.0.0.1:1024"
2021-10-26 15:27:03 +00:00
remote: "www.remote.example.com:8082" # proxy to remote address
2021-10-21 08:43:59 +00:00
```
Built-in two upstreams: ban(terminate connection immediately), echo
2021-10-26 15:02:05 +00:00
## Thanks
- [tokio_kcp ](https://github.com/Matrix-Zhang/tokio_kcp )
2021-10-21 08:43:59 +00:00
## License
Fourth is available under terms of Apache-2.0.
