Tunnels

- Website - License - Discord - Live Development

Requirements

Client Web UI

- vite

Client Golang App

- golang (macos: ifconfig, route), (windows: netsh)

Server (supports linux and docker)

- iptables (only needed when running the server) - golang

Starting the golang client

NOTE: The client requires sudo/admin on windows and mac, but only narrow net admin permission on linux.

$ cd ./cmd/main
$ go build .
$ ./main

Starting the web UI

NOTE: when opening the dev ui, you must first accept the TLS certificate on port 7777 (https://127.0.0.1:7777)

$ cd ./frontend
$ pnpm install .
$ vite dev

Starting the server

$ cd ./server
$ go build .
fresh run: $ ./server --config 
$ ./server

Notes about development

We accept any code, even from machine learning models as long as the code makes sense, even small spellfixing contributions. Just remember to run the linter before submitting.

Random development / deployment information

iptables for the server

these are applied automatically on startup

$ iptables -I OUTPUT -p tcp --src {interface_IP} --tcp-flags ACK,RST RST -j DROP

Testing

The project includes comprehensive test coverage for all server components.

# Run all tests
$ make test
Run tests with verbose output
$ make test-server
Run tests with coverage report
$ make test-coverage
Count total number of tests
$ make test-count
Run tests with race detection
$ make test-verbose
Or run tests directly with go
$ go test ./server/...

Linting

$ golangci-lint run --timeout=10m --config .golangci.yml
Or use make
$ make lint

Permissions

- Windows: admin - macos: sudo - linux: setcap 'capnetraw,capnetbindservice,capnet_admin+eip' main

Building

Tests are automatically run before building in the goreleaser pipeline.

- DEV: ./releaser-build-snapshot.sh (or make release) - PROD: ./releaser-build-release.sh ( requires GITHUB_TOKEN )

# Build using make
$ make build           # Build all binaries
$ make build-server    # Build server only
$ make build-client    # Build client only
Test before building
$ make pre-commit      # Run tests and linting
$ make ci              # Run CI checks locally

Experimental

Wails

We are experimenting with a wails GUI, it will output it's build into the build directory.

Special mentiones

These are the real MVPs:

- n00bady: creator of bluam https://github.com/n00bady/bluam - 0xMALVEE: for major contributiosn to the front-end - keyb1nd_'s twitch chat for the backseat debugging and support! - comahacks for security reviews - klauspost for development advice - olexsmir for please don't add your name to readme.md for no reason

[forks-shield]: https://img.shields.io/github/forks/tunnels-is/tunnels?style=for-the-badge&logo=github [forks-url]: https://github.com/tunnels-is/tunnels/network/members [stars-shield]: https://img.shields.io/github/stars/tunnels-is/tunnels?style=for-the-badge&logo=github [stars-url]: https://github.com/tunnels-is/tunnels/stargazers [issues-shield]: https://img.shields.io/github/issues/tunnels-is/tunnels?style=for-the-badge&logo=github [issues-url]: https://github.com/tunnels-is/tunnels/issues