sing-box README

The project's README from github.com/SagerNet/sing-box. As one markdown file: README.md.

sing-box

The universal proxy platform.

Packaging status

Documentation

https://sing-box.sagernet.org

License

Copyright (C) 2022 by nekohasekai <[email protected]>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

In addition, no derivative work may use the name or imply association
with this application without prior consent.

sing-box (SagerNet/sing-box)

dns
Searching Database…

39K ·GitHub
Sing-box
What is this?sing-box describes itself as 'the universal proxy platform' — a single Go program meant to run and configure various proxy protocols instead of needing separate tools for each one.
Is this a GUI app or a command-line core?It's a Go-based proxy engine built from a CLI/binary, with a Dockerfile and CI workflows (build.yml, docker.yml, linux.yml) for producing binaries and container images rather than a bundled graphical app.
What platforms can I run it on?The repo's CI explicitly builds a Linux target and a Docker image; as a Go project without stated OS restrictions, it can typically also be compiled for Windows and macOS.
Why is it called a 'universal' proxy platform?The description implies it aims to unify configuration and operation of multiple proxy protocols under one program, rather than requiring a separate tool per protocol.
Does the project ship an official Docker image?Yes, the repository contains a Dockerfile and a dedicated docker.yml CI workflow, which confirms official Docker image builds are maintained.
What are similar projects?gost, dnscrypt-proxy, brook, tailcat, v2ray-core, Xray-core, MasterDnsVPN, numa
Which topics is it in?dns, vpn, proxy, networking, go, privacy, security, terminal, tool, server, docker, self-hosted
Creator
SagerNet
Size
28.8 MB
Stars
39K
Updated
CommitOct 13Releasev1.14.3Oct 09
Age
4y
Commits · 90 Days