GreenTunnel

(β˜… 4,899)

GreenTunnel is an anti-censorship utility designed to bypass the DPI system that is put in place by various ISPs to block access to certain websites.

  • .dockerignore
  • .editorconfig
  • .gitignore
  • .nvmrc
  • .prettierignore
  • .prettierrc.json
  • _config.yml
  • CLAUDE.md
  • Dockerfile
  • eslint.config.js
  • LICENSE
  • package-lock.json
  • package.json
  • README.md
  • tsconfig.base.json
  • tsconfig.json
  • vitest.config.ts

# Installation Guide

1. Get the code
git clone https://github.com/SadeghHayeri/GreenTunnel

Downloads the entire project code from GitHub to your computer.

cd GreenTunnel

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
npm install -g green-tunnel

Installs the package published on the npm registry globally β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run -p 8000:8000 sadeghhayeri/green-tunnel

Runs the built image as an actual container.

docker run -e PORT=9000 -p 9000:9000 sadeghhayeri/green-tunnel

Runs the built image as an actual container.

docker run -d --restart unless-stopped -p 8000:8000 sadeghhayeri/green-tunnel

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install -g green-tunnel

Installs the package published on the npm registry globally β€” no need to clone the source.

npm install # workspaces: packages/*, apps/*

Downloads and installs the libraries listed in package.json.

npm run check # typecheck + lint + test

Type this command into your terminal and run it.

npm run build # core, cli, desktop

Builds optimized production files.

npm run dev # the desktop app, with HMR

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation