tun - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #ai #golang #go #android #rust #linux #docker #cli #vue #awesome-list #pytorch #mcp

tun

(★ 103)

🌐 CLI Xray VPN client

파일 탐색기

최종 버전 다운로드 (.zip)

- - carbon.json
  - carbon.png
- - client.go
  - client_test.go
  - interfaces.go
  - metrics.go
  - metrics_test.go
.gitignore
go.mod
go.sum
LICENSE
main.go
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/goxray/tun

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd tun

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. 공식 설치 스크립트

쉬움 추천

사전 준비물

APT (Debian/Ubuntu 계열) Debian/Ubuntu 계열 리눅스에 기본 내장된 패키지 매니저입니다.

sudo apt install goxray-cli

APT 패키지 저장소에서 바로 설치합니다 (Debian/Ubuntu 계열).

✅ 설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Go

보통

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Go Go 언어 컴파일러 및 도구 모음입니다.

sudo go run . <proto_link>

따로 빌드하지 않고 바로 Go 프로그램을 실행합니다.

go build -o goxray_cli .

Go 프로그램을 컴파일해 실행 파일을 만듭니다.

env GOOS=darwin GOARCH=amd64 go build -o goxray_cli_darwin_amd64 .

Go 프로그램을 컴파일해 실행 파일을 만듭니다.

docker run --platform=linux/arm64 -v=${PWD}:/app --workdir=/app arm64v8/golang:1.24 env GOARCH=arm64 go build -o goxray_cli_linux_arm64 .

빌드된 이미지를 실제 컨테이너로 실행합니다.

docker run --platform=linux/amd64 -v=${PWD}:/app --workdir=/app amd64/golang:1.24 env GOARCH=amd64 go build -o goxray_cli_linux_amd64 .

빌드된 이미지를 실제 컨테이너로 실행합니다.

✅ 빌드가 에러 없이 끝나면 성공입니다. go run . 을 썼다면 터미널 출력을 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Go VPN client for XRay
![Static Badge](https://img.shields.io/badge/OS-macOS%20%7C%20Linux-blue?style=flat&logo=linux&logoColor=white&logoSize=auto&color=blue)
![Static Badge](https://img.shields.io/badge/Go-1.24+-00ADD8?style=flat&logo=go&logoColor=white)
[![Go Report Card](https://goreportcard.com/badge/github.com/goxray/tun)](https://goreportcard.com/report/github.com/goxray/tun)
[![Go Reference](https://pkg.go.dev/badge/github.com/goxray/tun.svg)](https://pkg.go.dev/github.com/goxray/tun)
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/goxray/tun/total?color=blue)

This project brings fully functioning [XRay](https://github.com/XTLS/Xray-core) VPN client implementation in Go.

> For desktop version see https://github.com/goxray/desktop

<img alt="Terminal example output" align="center" src="/.github/images/carbon.png">

> [!NOTE]
> The program will not damage your routing rules, default route is intact and only additional rules are added for the lifetime of application's TUN device. There are also additional complementary clean up procedures in place.

#### What is XRay?
Please visit https://xtls.github.io/en for more info.

#### Tested and supported on:
- macOS (tested on Sequoia 15.1.1)
- Linux (tested on Ubuntu 24.10)

> Feel free to test this on your system and let me know in the issues :)

## ✨ Features
- Stupidly easy to use
- Supports all [Xray-core](https://github.com/XTLS/Xray-core) protocols (vless, vmess e.t.c.) using link notation (`vless://` e.t.c.)
- Only soft routing rules are applied, no changes made to default routes

## ⚡️ Installation

The application can be used standalone, as compiled and thrown somewhere in the directory mentioned in PATH.

##### 📦 3rd party Debian package (maintained by [twdragon](https://github.com/twdragon))

The client is available from the PPA repository `ppa:twdragon/xray`, maintained by [twdragon](https://github.com/twdragon). The network privileges in specified automatically by the postinstall script. The package is in sync with this repo's release tags. You can check the pipeline at the [dedicated repository](https://github.com/twdragon/xray-debian-pkg). To install, use:

```bash
sudo add-apt-repository ppa:twdragon/xray
sudo apt update
sudo apt install goxray-cli
```

After the installation, the package might be updated automatically, as is done in Ubuntu. Packages are signed by [twdragon](https://github.com/twdragon) and published on [Launchpad](https://launchpad.net/~twdragon/+archive/ubuntu/xray). Experimental builds are also available in [pipeline repository](https://github.com/twdragon/xray-debian-pkg/actions).

## ⚡️ Usage
> [!IMPORTANT]
> - `sudo` is required
> - On linux set `sudo setcap cap_net_raw,cap_net_admin,cap_net_bind_service+eip goxray_binary_path`

### Standalone application:

Running the VPN on your machine is as simple as running this little command:
```bash
sudo go run . <proto_link>
```

Where `proto_link` is your XRay link (like `vless://example.com...`), you can get this from your VPN provider or get it from your XRay server.

### As library in your own project:
> [!NOTE]
> This project is built upon the `core` package, see details and documentation at https://github.com/goxray/core

Install:
```bash
go get github.com/goxray/tun/pkg/client
```

Example:
```go
logger := slog.New(slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{Level: slog.LevelError}))
vpn, _ := client.NewClientWithOpts(client.Config{
  TLSAllowInsecure: false,
  Logger:           logger,
})

_ = vpn.Connect(clientLink)
defer vpn.Disconnect(context.Background())

time.Sleep(60 * time.Second)
```

> Please refer to godoc for supported methods and types.

### As a dockerized experience

If you need to use it with Docker - you can look at [this proposed implementation](https://github.com/goxray/tun/pull/8).

## 🛠 Build

The project compiles like a regular Go program:
```bash
go build -o goxray_cli .
```

#### Cross-compilation

```bash
env GOOS=darwin GOARCH=amd64 go build -o goxray_cli_darwin_amd64 .
```

To cross-compile from macOS to Linux arm/amd I use these commands:
```bash
docker run --platform=linux/arm64 -v=${PWD}:/app --workdir=/app arm64v8/golang:1.24 env GOARCH=arm64 go build -o goxray_cli_linux_arm64 .
```
```bash
docker run --platform=linux/amd64 -v=${PWD}:/app --workdir=/app amd64/golang:1.24 env GOARCH=amd64 go build -o goxray_cli_linux_amd64 .
```

## How it works
- Application sets up new TUN device.
- Adds additional routes to route all system traffic to this newly created TUN device.
- Adds exception for XRay outbound address (basically your VPN server IP).
- Tunnel is created to process all incoming IP packets via TCP/IP stack. All outbound traffic is routed through the XRay inbound proxy and all incoming packets are routed back via TUN device.

## 📝 TODO
- [ ] Add IPV6 support

## 🎯 Motivation
There are no available XRay clients implementations in Go on Github, so I decided to do it myself. The attempt proved to be successfull and I wanted to share my findings in a complete and working VPN client.

## Credits

- https://github.com/xtls/xray-core
- https://github.com/lilendian0x00/xray-knife
- https://github.com/jackpal/gateway