Skip to content

Home

Jump to bottom
moqsien edited this page Mar 28, 2024 · 46 revisions

Welcome to the neobox wiki!

中文说明

I know that it may take you some time and patience to go through this document. But trust me, you will never regret to do so.

1. What's NeoBox?

NeoBox is a cmdline tool for Free-VPN-Solutions.

It has a very powerful interactive shell as UI.

The commands provided by the interactive shell are very intuitive.

2. Main features.

  • Provides free VPNs collected from Internet.
  • Filters and tests free VPNs.
  • Adds your own VPNs manually.
  • With cloudflare edge-tunnel and Wireguard/Warp+ including IP/domain selections supported.
  • With QRCode supported.
  • With protocols including vmess/vless/shadowsocks/trojan/wireguard supported.
  • With global/system-wide proxy supported.
  • Switches between xray-core (by default) and sing-box.
  • Auto-completions for commands and flags .
  • Command history recording.
  • Auto restarts on system booting.
  • And more.

Note:If you are looking forward to Free VPNs, you should know how to set a decryption key and how to enable the verifier. To learn these, please read setup and vf. Additionally, the decrytion key is aDdwDsaYmdeF5yWj currently.

3. Explains to commands.

An overview of available commands.

moqsien in [data/projects/go/src/neobox/example]
>>> -h                                                                  09:28:08
This is an interactive shell powered by gshell.

Usage:
   [command]

gshell commands:
  cf          Cloudflare related CLIs.
  exit        Exit gshell.
  help        Help about any command
  ls          Show list of proxies/vpns and neobox running status.
  manual      Manually added proxies/vpns.
  restart     Restart the running neobox server with a chosen proxy/vpn.
  setup       Setup for neobox.
  start       Start a neobox client.
  stop        Stop neobox client.
  tools       Tools for neobox.
  vf          Verifier related CLIs.

Flags:
  -h, --help   help for this command

Use " [command] --help" for more information about a command.
  • cf: cloudflare related VPNs/Proxies.
  • ls: shows VPN/Proxy list, the status of NeoBox, etc.
  • manual: adds your own VPNs except for edge-tunnels.
  • restart: restarts NeoBox Server.
  • setup: does some setups for NeoBox.
  • start: starts NeoBox Server, this is already covered by "restart".
  • stop: stops everything that NeoBox runs.
  • tools: provides some useful tools.
  • vf: verifier for Free VPNs.

4. Installation and usage.

NeoBox is designed to be used in command line and mainly targeted at those who have some experiences in programming or linux, although it works on Windows too.

  1. If you are a gopher, you can go and see the example. But do not use the example directly if you prefer to put the NeoBox-related files in a more professional place.

  2. Use "~/.neobox/" as default workdir for NeoBox:

go install -tags "with_wireguard with_utls with_gvisor with_grpc with_ech with_dhcp" github.com/gvcgo/neobox/cmd/nbox@latest
  1. In case that you are not so farmiliar with go, you can just download GVC binaries from its releases page. GVC has fully adopted NeoBox as one of its features. I promise that GVC is so awesome, and you are going to love it if you are a real programmer.

5. License.

MIT License

Copyright (c) 2023 moqsien

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Clone this wiki locally