whatisgithub

What is sing-box?

eooce/sing-box — explained in plain English

Analysis updated 2026-06-26

4,591ShellAudience · ops devopsComplexity · 3/5LicenseSetup · moderate

In one sentence

Shell scripts that install a multi-protocol proxy server on a Linux VPS or free hosting platform in a single command, supporting VLESS, VMess, Hysteria2, and TUIC5 via environment variable configuration.

Mindmap

mindmap
  root((sing-box scripts))
    What it does
      One-command install
      Multi-protocol proxy
    Protocols
      VLESS-Reality
      VMess WebSocket
      Hysteria2
      TUIC5
    Platforms
      Standard VPS
      Serv00 free hosting
      Game hosting runtimes
    Config
      Environment variables
      Cloudflare Argo tunnel
      Subscription link output
Click or tap to explore — scroll the page freely

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

Deploy a multi-protocol proxy server on a VPS with a single shell command and import the subscription link into a proxy client app.

USE CASE 2

Set up sing-box on Serv00 free hosting with automatic keep-alive so the process does not stop unexpectedly.

USE CASE 3

Configure a proxy node on game-hosting platforms using environment variables with no manual config file editing.

What is it built with?

Shellsing-box

How does it compare?

eooce/sing-boxkaitai-io/kaitai_structsecurity-onion-solutions/securityonion
Stars4,5914,5994,605
LanguageShellShellShell
Setup difficultymoderatemoderatehard
Complexity3/53/54/5
Audienceops devopsdeveloperops devops

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

How do you get it running?

Difficulty · moderate Time to first run · 30min

Requires SSH access to a server and familiarity with environment variables and proxy client apps to set up and use.

So what is it?

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.

Copy-paste prompts

Prompt 1
I want to set up a sing-box proxy on my VPS. Walk me through configuring the environment variables for UUID, port, and Cloudflare Argo tunnel credentials before running the install script.
Prompt 2
How do I import the subscription link that sing-box outputs into V2ray or Shadowrocket on my phone so I can use the proxy?
Prompt 3
I'm running sing-box on Serv00 free hosting and the process stops after a few hours. How do I enable the automatic keep-alive service in the script?

Frequently asked questions

What is sing-box?

Shell scripts that install a multi-protocol proxy server on a Linux VPS or free hosting platform in a single command, supporting VLESS, VMess, Hysteria2, and TUIC5 via environment variable configuration.

What language is sing-box written in?

Mainly Shell. The stack also includes Shell, sing-box.

How hard is sing-box to set up?

Setup difficulty is rated moderate, with roughly 30min to a first successful run.

Who is sing-box for?

Mainly ops devops.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.