v2ray-agent README

The project's README from github.com/mack-a/v2ray-agent. As one markdown file: README.md.

v2ray-agent

License: AGPL v3 Telegram Channel Telegram Group Official Website English Version

Xray-core/sing-box 一键脚本快速安装

功能

快速开始

安装脚本版

wget -P /root -N --no-check-certificate "https://raw.githubusercontent.com/mack-a/v2ray-agent/master/install.sh" && chmod 700 /root/install.sh && /root/install.sh

使用

安装后,运行以下命令可再次打开管理菜单:

vasma

安装Docker版

wget -P /root -N --no-check-certificate "https://raw.githubusercontent.com/mack-a/v2ray-agent/master/shell/docker_reality.sh" && chmod 700 /root/docker_reality.sh && /root/docker_reality.sh

使用

安装后,运行以下命令可再次打开管理菜单:

vasmad

文档和指南

社区与支持

捐赠

感谢您对开源项目的关注和支持。如果您觉得这个项目对您有帮助,欢迎通过以下方式进行捐赠。

许可证

本项根据 AGPL-3.0 许可证 授权.

v2ray-agent (mack-a/v2ray-agent)

Searching Database…

What is this?An all-in-one one-click script that installs and manages proxy services on your own server, built around the Xray-core and sing-box cores and driven from a terminal menu.
Do I need to install anything on my phone or laptop to use it?Nothing on your devices — the script only runs server-side, deploying the proxy core on a Linux VPS as a service that your laptop and phone connect to with a regular proxy client.
How do I get it running?Run the one-click install script from the README's Quick Start section (a Docker version is offered as well). Afterwards, rerun the command it gives to reopen the management menu.
What kind of server do I need for this?Any Linux VPS works; the README even links buying guides for budget hosts like RackNerd, BandwagonHost (搬瓦工) and DMIT, including plans on the China Unicom AS4837 route.
Does it work on Windows or macOS too?No — it is Linux-only, a Shell script for servers with no desktop build. The docs section does include dedicated pages on usage notes and error handling for when a run goes wrong.
Anything unusual about its license?It is licensed under AGPL-3.0 — a strong copyleft license that also requires source disclosure if you offer a modified version as a network service.
Which proxy protocols does it support?VLESS, VMess, Trojan, Hysteria2, Tuic and NaiveProxy, on either the Xray-core or the sing-box core — hence the 'eight-in-one' in its description. Variants like VLESS Reality with XTLS Vision and gRPC or WebSocket transports are covered too.
Do I have to deal with TLS certificates myself?No — the script applies for SSL certificates and renews them automatically.
Do I have to edit config files by hand?No — a simple menu manages users, ports and configuration, and it generates and manages subscription links for your client apps.
Can it unlock streaming sites or block P2P traffic?Yes. Traffic splitting supports WireGuard, IPv6, Socks5, DNS, VMess over WebSocket and SNI reverse proxying — usable for unlocking streaming services or bypassing IP checks. You also get a domain blacklist and a switch to block P2P/BT downloads.
Creator
mack-a
Size
35.6 MB
Stars
22.1K
Age
6y
Commits · 90 Days