explaingit

eooce/sing-box

4,591Shell
This is a quick first-pass explanation. The richer sections — use-cases, tech stack, setup, prompts — are still being generated.

TLDR

This repository is a collection of shell scripts that set up a network proxy system called sing-box on a variety of server environments.

Mindmap

A visual breakdown will appear here once this repo is fully enriched.

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

In plain English

This repository is a collection of shell scripts that set up a network proxy system called sing-box on a variety of server environments. The scripts let someone install four different proxy protocols in a single command, covering VLESS-Reality, VMess over WebSocket with TLS, Hysteria2, and TUIC5. The goal is to get a working proxy node running without manual configuration steps. The project targets three distinct hosting situations. The first is a standard VPS (a rented Linux server), where a single command pulls and runs the install script. The second is Serv00 and CT8, which are free shell-hosting platforms with restricted permissions, separate scripts handle their unusual environment, including automatic keep-alive services so the process does not stop. The third is game-hosting platforms that provide a Node, Python, Java, or Go runtime, where a different set of files gets uploaded and configured through environment variables. Configuration is done entirely through environment variables rather than config files. You set things like UUID (an identifier for your node), ports, Cloudflare Argo tunnel credentials for TLS tunneling, and optional Nezha monitoring agent details before running the script. If Argo tunnel credentials are left blank, the script falls back to a temporary tunnel automatically. The scripts output a subscription link that proxy client apps such as V2ray, Nekbox, or Shadowrocket can import directly. The README is written almost entirely in Chinese and is aimed at users familiar with self-hosted proxy setups, particularly those routing traffic through Cloudflare's network. The disclaimer states the project is for educational purposes only, asks users to delete it within 24 hours of downloading, and prohibits commercial use. A Telegram group is linked for community feedback. This is a technical tool for people who already understand what proxy protocols and VPS hosting are. There is no graphical interface, everything runs through the command line, and the scripts assume you have SSH access to your server and basic familiarity with environment variables.

Open on GitHub → Explain another repo

← eooce on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.