mirror of
https://github.com/xjasonlyu/tun2socks.git
synced 2026-10-21 03:33:07 +00:00
73 lines
3.5 KiB
Markdown
73 lines
3.5 KiB
Markdown
|
|
|
|
[![Go Build][1]](https://github.com/xjasonlyu/tun2socks/actions/workflows/docker.yml)
|
|
[![Go Linter][2]](https://github.com/xjasonlyu/tun2socks/actions/workflows/linter.yml)
|
|
[![Go Version][3]](https://github.com/xjasonlyu/tun2socks/blob/main/go.mod)
|
|
[![Maintainability][4]](https://qlty.sh/gh/xjasonlyu/projects/tun2socks)
|
|
[![GitHub License][5]](https://github.com/xjasonlyu/tun2socks/blob/main/LICENSE)
|
|
[![Docker Pulls][6]](https://hub.docker.com/r/xjasonlyu/tun2socks)
|
|
[![Releases][7]](https://github.com/xjasonlyu/tun2socks/releases)
|
|
|
|
## Features
|
|
|
|
- **Universal Proxying**: Transparently routes all network traffic from any application through a proxy.
|
|
- **Multi-Protocol**: Supports HTTP/SOCKS/Shadowsocks/SSH/Relay proxies with optional authentication.
|
|
- **Cross-Platform**: Runs on Linux/macOS/Windows/FreeBSD/OpenBSD with platform-specific optimizations.
|
|
- **Gateway Mode**: Acts as a Layer 3 gateway to route traffic from other devices on the same network.
|
|
- **Full IPv6 Compatibility**: Natively supports IPv6; seamlessly tunnels IPv4 over IPv6 and vice versa.
|
|
- **User-Space Networking**: Leverages the **[gVisor](https://github.com/google/gvisor)** network stack for enhanced
|
|
performance and flexibility.
|
|
|
|
## Benchmarks
|
|
|
|
|
|
|
|
For all scenarios of usage, tun2socks performs best.
|
|
See [benchmarks](https://github.com/xjasonlyu/tun2socks/wiki/Benchmarks) for more details.
|
|
|
|
## Documentation
|
|
|
|
- [Install from Source](https://github.com/xjasonlyu/tun2socks/wiki/Install-from-Source)
|
|
- [Quickstart Examples](https://github.com/xjasonlyu/tun2socks/wiki/Examples)
|
|
- [Memory Optimization](https://github.com/xjasonlyu/tun2socks/wiki/Memory-Optimization)
|
|
|
|
Full documentation and technical guides can be found at [Wiki](https://github.com/xjasonlyu/tun2socks/wiki).
|
|
|
|
## Community
|
|
|
|
Welcome and feel free to ask any questions at [Discussions](https://github.com/xjasonlyu/tun2socks/discussions).
|
|
|
|
## Credits
|
|
|
|
- [google/gvisor](https://github.com/google/gvisor) - Application Kernel for Containers
|
|
- [wireguard-go](https://git.zx2c4.com/wireguard-go) - Go Implementation of WireGuard
|
|
- [wintun](https://git.zx2c4.com/wintun/) - Layer 3 TUN Driver for Windows
|
|
|
|
## License
|
|
|
|
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fxjasonlyu%2Ftun2socks?ref=badge_large)
|
|
|
|
## Star History
|
|
|
|
<a href="https://star-history.com/#xjasonlyu/tun2socks&Date">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=xjasonlyu/tun2socks&type=Date&theme=dark" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=xjasonlyu/tun2socks&type=Date" />
|
|
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=xjasonlyu/tun2socks&type=Date" />
|
|
</picture>
|
|
</a>
|
|
|
|
[1]: https://img.shields.io/github/actions/workflow/status/xjasonlyu/tun2socks/docker.yml?branch=main&logo=github
|
|
|
|
[2]: https://img.shields.io/github/actions/workflow/status/xjasonlyu/tun2socks/linter.yml?branch=main&logo=githubactions&label=golangci-lint
|
|
|
|
[3]: https://img.shields.io/github/go-mod/go-version/xjasonlyu/tun2socks?logo=go
|
|
|
|
[4]: https://qlty.sh/gh/xjasonlyu/projects/tun2socks/maintainability.svg
|
|
|
|
[5]: https://img.shields.io/github/license/xjasonlyu/tun2socks
|
|
|
|
[6]: https://img.shields.io/docker/pulls/xjasonlyu/tun2socks?logo=docker
|
|
|
|
[7]: https://img.shields.io/github/v/release/xjasonlyu/tun2socks?logo=smartthings
|