whatisgithub

What is nikvpn-codespace?

nikvpn-iran/nikvpn-codespace — explained in plain English

Analysis updated 2026-05-18

65ShellAudience · generalComplexity · 2/5Setup · easy

In one sentence

A free tool for people in Iran that sets up an encrypted VLESS proxy on GitHub Codespaces to bypass government internet filtering in under five minutes.

Mindmap

mindmap
  root((NikVPN Codespace))
    What it does
      VLESS proxy over xHTTP
      Runs on GitHub Codespaces
      Keepalive mechanism
    Tech stack
      Shell
      Docker
      Xray-core
    Use cases
      Bypass internet censorship
      Access blocked websites
      Free no registration proxy
    Audience
      Users in Iran
      Censorship circumvention

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

Bypass government internet filtering from a phone or computer

USE CASE 2

Access blocked websites using a free GitHub Codespace as the server

USE CASE 3

Get a VLESS connection link to import into a proxy client app

USE CASE 4

Keep the Codespace proxy alive during longer browsing sessions

What is it built with?

ShellDockerXray-core

How does it compare?

nikvpn-iran/nikvpn-codespacefilipedeschamps/dotfilesayghri/i-have-adhd
Stars656761
LanguageShellShellShell
Last pushed2025-04-23
MaintenanceStale
Setup difficultyeasymoderateeasy
Complexity2/52/51/5
Audiencegeneraldevelopervibe coder

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

How do you get it running?

Difficulty · easy Time to first run · 5min

Free GitHub account gives 60 hours of Codespace runtime per month.

So what is it?

NikVPN Codespace is a tool for people in Iran who want free internet access past government-imposed filtering. It sets up a VLESS proxy, a type of encrypted tunnel that disguises your internet traffic so it is harder for filtering systems to detect and block, using GitHub Codespaces as the underlying server infrastructure. A codespace is a free cloud computer that GitHub provides for running development environments, this project hijacks that free resource to host the proxy server instead. The setup takes under five minutes. You fork the repository on GitHub, launch a Codespace from it, and the startup scripts automatically install and run Xray-core (the proxy engine) inside a Docker container. Once running, the terminal prints a VLESS connection link that you import into a proxy client app on your phone or computer. Supported client apps include v2rayNG and Nekobox on Android, Streisand and FoXray on iOS, and v2rayN or Nekoray on Windows and Linux. The project includes a keepalive mechanism so the Codespace stays awake and does not go to sleep during use. The transport protocol is VLESS over xHTTP, which is designed to blend in with regular web traffic and resist deep packet inspection (the method Iran's filtering system uses to detect VPNs). You would use this if you are in Iran and need a free, no-registration way to bypass internet censorship for accessing blocked websites. GitHub's free tier provides 60 hours of Codespace runtime per month. The project is written in Shell and requires only a free GitHub account.

Copy-paste prompts

Prompt 1
Walk me through forking NikVPN Codespace and launching my own Codespace proxy.
Prompt 2
Explain how VLESS over xHTTP helps this proxy resist deep packet inspection.
Prompt 3
Help me configure v2rayNG or Nekobox to connect using the link this project generates.
Prompt 4
Show me how the keepalive mechanism stops my Codespace from going to sleep.

Frequently asked questions

What is nikvpn-codespace?

A free tool for people in Iran that sets up an encrypted VLESS proxy on GitHub Codespaces to bypass government internet filtering in under five minutes.

What language is nikvpn-codespace written in?

Mainly Shell. The stack also includes Shell, Docker, Xray-core.

How hard is nikvpn-codespace to set up?

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

Who is nikvpn-codespace for?

Mainly general.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.