whatisgithub

What is g-tunnel?

arixworks/g-tunnel — explained in plain English

Analysis updated 2026-05-18

★ 32ShellAudience · generalComplexity · 2/5LicenseSetup · easy

In one sentence

A fork-and-run script that spins up a VLESS proxy server inside a free GitHub Codespace to help people in restricted networks reach the open internet.

Mindmap

mindmap
  root((G-Tunnel))
    What it does
      Proxy in GitHub Codespaces
      Bypasses network restrictions
      Auto-generates connection links
    Tech stack
      Shell
      Xray
      VLESS over WebSocket
    Use cases
      Personal proxy server
      Restricted network access
      No manual config
    Audience
      Users in censored regions
      Codespaces owners

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Set up a personal proxy server inside a free GitHub Codespace to bypass internet restrictions.

USE CASE 2

Generate a VLESS over WebSocket connection link automatically without manual server setup.

USE CASE 3

Get temporary unrestricted internet access from a region with heavy network filtering.

What is it built with?

ShellXrayVLESSWebSocketTLS

How does it compare?

arixworks/g-tunnelguanhuaye/codex-tmux-scrollvirtudude/armada
Stars323232
LanguageShellShellShell
Setup difficultyeasyeasyhard
Complexity2/52/54/5
Audiencegeneraldevelopergeneral

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Requires a GitHub account with Codespaces access, README is written primarily in Persian.

Free to use, modify, and distribute for any purpose, including commercially, as long as you keep the copyright notice.

So what is it?

G-Tunnel is a tool that sets up a high-performance proxy server running inside GitHub Codespaces, which is a cloud-based coding environment provided by GitHub. The purpose is to route internet traffic through this proxy to bypass network restrictions. The README is written primarily in Persian (Farsi) and targets users in restricted network environments, particularly referencing Iran. Setup is described as fully automated: you fork the repository, open a Codespace, and connection links are generated automatically in the terminal. It uses the VLESS protocol over WebSocket with TLS encryption and is built on the Xray networking core. The project is a Shell script and MIT licensed.

Copy-paste prompts

Prompt 1
Walk me through forking G-Tunnel and starting a Codespace to get a working proxy link.
Prompt 2
Explain what the VLESS protocol and Xray core do in G-Tunnel's setup.
Prompt 3
Help me troubleshoot G-Tunnel if my Codespace proxy link isn't connecting.
Prompt 4
Translate G-Tunnel's Persian setup instructions into plain English for me.

Frequently asked questions

What is g-tunnel?

A fork-and-run script that spins up a VLESS proxy server inside a free GitHub Codespace to help people in restricted networks reach the open internet.

What language is g-tunnel written in?

Mainly Shell. The stack also includes Shell, Xray, VLESS.

What license does g-tunnel use?

Free to use, modify, and distribute for any purpose, including commercially, as long as you keep the copyright notice.

How hard is g-tunnel to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is g-tunnel for?

Mainly general.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.

What are similar repos?