From 3a8bd683ff8512d52821dd93638a5f8a91216abf Mon Sep 17 00:00:00 2001 From: mack-a <57424792+mack-a@users.noreply.github.com> Date: Sun, 13 Nov 2022 23:20:53 +0800 Subject: [PATCH] feat(readme): update --- README.md | 2 - documents/en/README_EN.md | 140 ++++++++++++++++++++++---------------- 2 files changed, 81 insertions(+), 61 deletions(-) diff --git a/README.md b/README.md index b60749e..9f5fa6f 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,6 @@ # 目录 - [1.脚本安装](#1vlesstcptlsvlesswstlsvmesstcptlsvmesswstlstrojan-伪装站点-五合一共存脚本) - - [组合方式](#组合方式) - - [组合推荐](#组合推荐) - [特性](#特性) - [注意事项](#注意事项) - [安装脚本](#安装脚本) diff --git a/documents/en/README_EN.md b/documents/en/README_EN.md index 5700b31..0fc1e95 100644 --- a/documents/en/README_EN.md +++ b/documents/en/README_EN.md @@ -2,95 +2,117 @@ > [Thanks for non-commercial open source development authorization by JetBrains](https://www.jetbrains.com/?from=v2ray-agent) -- [Cloudflare Optimization Solutions](https://github.com/mack-a/v2ray-agent/blob/master/documents/optimize_V2Ray.md) -- [Traffic Transit Tutorial](https://github.com/mack-a/v2ray-agent/blob/master/documents/traffic_relay.md) -- [SSH Getting Started Tutorial](https://www.v2ray-agent.com/2020-12-16-ssh%E5%85%A5%E9%97%A8%E6%95%99%E7%A8%8B) -- [TG Group](https://t.me/technologyshare)、[TG Channel](https://t.me/joinchat/VuYxsKnlIQp3VRw-)、[Blog](https://www.v2ray-agent.com/) -- Welcome Pull request +> [Thanks for non-commercial open source development authorization by JetBrains]( https://www.jetbrains.com/?from=v2ray-agent) -* * * +> [English Version](https://github.com/mack-a/v2ray-agent/blob/master/documents/en/README_EN.md) + +- [Cloudflare Optimization Solution](https://github.com/mack-a/v2ray-agent/blob/master/documents/optimize_V2Ray.md) +- [Traffic Relay](https://github.com/mack-a/v2ray-agent/blob/master/documents/traffic_relay.md) +- [manual self-build tutorial](https://github.com/mack-a/v2ray-agent/blob/master/documents/Cloudflare_install_manual.md) +- [ssh introductory tutorial](https://www.v2ray-agent.com/2020-12-16-ssh%E5%85%A5%E9%97%A8%E6%95%99%E7%A8%8B) + +- [TG group](https://t.me/technologyshare), [TG channel-update notification](https://t.me/v2rayAgentChannel), [blog address](https://www.v2ray-agent.com/) +- **Please give a ⭐ support** + +* * * # Catalog -- [1.Installation Script](#1vlesstcptlsvlesswstlsvmesstcptlsvmesswstlstrojan-伪装博客-五合一共存脚本) - * [Characteristics](#characteristics) - * [architecture](#architecture) - * [Line recommendation(China)](#line-recommendationchina) - * [Combination recommendation](#combination-recommendation) - * [Cautions](#cautions) - * [Usage](#usage) +- [1.Script installation](#1vlesstcptlsvlesswstlsvmesstcptlsvmesswstlstrojan-camouflage site-five-in-one coexistence script) + - [Features](#Features) + - [Notes](#Notes) + - [Installation Script](#Installation Script) -* * * +* * * -# 1.Eight-in-One Coexistence Script+Camouflage site +# 1.Eight-in-one coexistence script+ Mock Site -- [Cloudflare Introductory tutorial](https://github.com/mack-a/v2ray-agent/blob/master/documents/cloudflare_init.md) +- [Cloudflare Getting Started Tutorial](https://github.com/mack-a/v2ray-agent/blob/master/documents/cloudflare_init.md) -## Characteristics - -- Support [Xray-core[XTLS]](https://github.com/XTLS/Xray-core) and [v2ray-core](https://github.com/v2fly/v2ray-core) -- Support VLESS/Trojan Forward Proxy [VLESS XTLS -> Trojan XTLS]、[Trojan XTLS -> VLESS XTLS] -- Support for reading configuration files from different cores to each other -- Support VLESS/VMess/trojan -- Support Debian, Ubuntu, and Centos. Support mainstream cpu architecture -- Support any combination of installation, multi-user management, adding multiple ports -- Support IPv6，[IPv6 Notes](https://github.com/mack-a/v2ray-agent/blob/master/documents/ipv6_help.md) +## Features +- Support [Xray-core[XTLS]](https ://github.com/XTLS/Xray-core), [v2ray-core](https://github.com/v2fly/v2ray-core) +- support VLESS/VMess/trojan protocol +- supports VLESS/Trojan prepending [VLESS XTLS -> Trojan XTLS], [Trojan XTLS -> VLESS XTLS] +- Support mutual reading of configuration files between different cores +- Trojan+TCP+xtls-rprx-direct +- Support Debian, Ubuntu, Centos systems and mainstream CPU architectures. +- Support any combination of installation, support for multi-user management, support for DNS streaming media unlock, support for adding multiple ports, [support any door to unlock Netflix](https://github.com/mack-a/v2ray-agent/blob/master/documents/netflix/dokodemo-unblock_netflix.md) +- support to keep tls certificate after uninstall +- support for IPv6, [IPv6 note](https://github.com/mack-a/v2ray-agent/blob/master/documents/ipv6_help.md) +- Support WARP offload, IPv6 offload +- Support BT download management, log management, domain name blacklist management, core management, camouflage site management - [Support custom certificate installation](https://github.com/mack-a/v2ray-agent/blob/master/documents/install_tls.md) ## Supported installation types - VLESS+TCP+TLS - VLESS+TCP+xtls-rprx-direct -- VLESS+gRPC+TLS [Support CDN, IPv6, low latency] -- VLESS+WS+TLS [Support CDN, IPv6] -- Trojan+TCP+TLS [**Recommended**] -- Trojan+TCP+xtls-rprx-direct -- Trojan+gRPC+TLS [Support CDN, IPv6, low latency] -- VMess+WS+TLS [Support CDN, IPv6] +- VLESS+gRPC+TLS [support CDN, IPv6, delay Low] +- VLESS+WS+TLS [support CDN, IPv6] +- Trojan+TCP+TLS [**recommended**] +- Trojan+gRPC+TLS [support CDN, IPv6, low latency] +- VMess+WS+TLS [support CDN, IPv6] -## Cautions +## Route recommendation + +- [CN2 GIA](https://github.com/mack-a/v2ray-agent/blob/master/documents/donation_aff.md#1cn2-gia) +- Shanghai CN2+HK +- [AS9929]( https://github.com/mack-a/v2ray-agent/blob/master/documents/donation_aff.md#2%E8%81%94%E9%80%9A-as9929a%E7%BD%91) +- [AS4837](https://github.com/mack-a/v2ray-agent/blob/master/documents/donation_aff.md#3%E8%81%94%E9%80%9A-as4837%E6%99%AE%E9%80%9A%E6%B0%91%E7%94%A8%E7%BD%91) +- [Unicom Japan Softbank](https://github.com/mack-a/v2ray-agent/blob/master/documents/donation_aff.md#4%E8%81%94%E9%80%9A-%E6%97%A5%E6%9C%AC%E8%BD%AF%E9%93%B6) +- Unicom+ Taiwan TFN +- China Unicom+NTT +- Guangzhou Mobile/Zhushift+HKIX/CMI/NTT +- Guangzhou Mobile/CN2+Cloudflare+ Global +- Guangzhou Mobile/CN2/South Union+Hong Kong AZ+Global +- Transit+cloudflare+Landing Machine【Kela Global】 + +## Precautions - **Modify Cloudflare->SSL/TLS->Overview->Full** -- **Cloudflare ---> A record resolution of clouds must be gray** -- **If you use CDN and direct connection at the same time, turn off cloud and use self-selected IP. More info in [Cloudflare Optimization Solutions](https://github.com/mack-a/v2ray-agent/blob/master/documents/optimize_V2Ray.md)** -- **Use the pure system installation, if you have installed using other scripts, please re-build the system and then install** -- wget: command not found [**Here you need to manually install the wget yourself**] - , If you have not used Linux，[Click to view](https://github.com/mack-a/v2ray-agent/tree/master/documents/install_tools.md)Installation Tutorial -- Non-root accounts are not supported -- **If you find Nginx-related problems, please uninstall the self-compiled nginx or re-build the system** -- **If you want to give feedback, please show detailed screenshots or in accordance with the template specifications. No screenshots or not in accordance with the specifications of the issue will be directly closed** +- **Cloudflare ---> Clouds parsed by A record must be gray [if not gray, it will affect the automatic renewal certificate of scheduled tasks]** +- **If you use CDN and direct connection at the same time, turn off Yunduo + self-selected IP, refer to the above [Cloudflare optimization plan](https://github.com/mack-a/v2ray-agent/blob/master/documents/optimize_V2Ray.md)** +- **Use the pure system to install, if you have installed it with other scripts and you cannot modify the error yourself, please reinstall the system and try to install again** +- wget: command not found [**Here you need to do it manually Install wget**] + , if you have not used Linux, [click to view](https://github.com/mack-a/v2ray-agent/tree/master/documents/install_tools.md) installation tutorial +- does not support non- root account +- **If you find Nginx-related problems, please uninstall the self-compiled nginx or reinstall the system** +- **In order to save time, please bring detailed screenshots or follow the template specifications for feedback, no screenshots or issues that do not follow the specifications Will be closed directly** - **Not recommended for GCP users** -- **Centos and lower versions are not recommended, Centos6 and Ubuntu 16.x are no longer supported** - **Oracle Cloud has an additional firewall that needs to be set manually** -- **Oracle Cloud only supports Ubuntu** +- **Centos and lower versions of the system are not recommended, if the Centos installation fails, please switch to Debian10 and try again, the script no longer supports Centos6 , Ubuntu 16.x** +- **[If you don't understand the usage, please check the script usage guide first](https://github.com/mack-a/v2ray-agent/blob/master/documents/how_to_use.md)** +- ** Oracle Cloud only supports Ubuntu** - **If you use gRPC to forward through cloudflare, you need to allow gRPC in cloudflare settings, path: cloudflare Network->gRPC** -- **gRPC is currently in beta and may not be compatible with the client you are using. Ignore it if you have any problems** -- **The issue about not starting when the script is upgraded from lower version, [Here is solution](https://github.com/mack-a/v2ray-agent/blob/master/documents/how_to_use.md#4%E4%BD%8E%E7%89%88%E6%9C%AC%E5%8D%87%E7%BA%A7%E9%AB%98%E7%89%88%E6%9C%AC%E5%90%8E%E6%97%A0%E6%B3%95%E5%90%AF%E5%8A%A8%E6%A0%B8%E5%BF%83)** +- **gRPC is currently in beta and may not work for the client you use Compatible, if you can't use it, please ignore ** +- ** The problem that the lower version script cannot be started when upgrading the higher version, [please click this link to view the solution](https://github.com/mack-a/v2ray-agent/blob/master/documents/how_to_use.md#4%E4%BD%8E%E7%89%88%E6%9C%AC%E5%8D%87%E7%BA%A7%E9%AB%98%E7%89%88%E6%9C%AC%E5%90%8E%E6%97%A0%E6%B3%95%E5%90%AF%E5%8A%A8%E6%A0%B8%E5%BF%83)** -## Script Catalog +## Donate -- v2ray-core 【**/etc/v2ray-agent/v2ray**】 -- Xray-core 【**/etc/v2ray-agent/xray**】 -- Trojan 【**/etc/v2ray-agent/trojan**】 -- TLS 【**/etc/v2ray-agent/tls**】 -- Nginx Configuration file 【**/etc/nginx/conf.d/alone.conf**】、Nginx fake site directory 【**/usr/share/nginx/html**】 +[You can use my AFF to buy VPS donation-blog](https://www.v2ray-agent.com/%E6%82%A8%E5%8F%AF%E4%BB%A5%E9%80%9A%E8%BF%87%E6%88%91%E7%9A%84AFF%E8%B4%AD%E4%B9%B0vps%E6%8D%90%E8%B5%A0) -## Usage +[You can use my AFF to buy VPS donations - Github](https://github.com/mack-a/v2ray-agent/blob/master/documents/donation_aff.md) -- Support shortcut start, after installation, shell input [**vasma**] to open the script, script execution path [**/etc/v2ray-agent/install.sh**] +[Support donations to me via virtual currency](https://github.com/mack-a/v2ray-agent/blob/master/documents/donation.md) -- Latest Version -``` -wget -P /root -N --no-check-certificate "https://raw.githubusercontent.com/mack-a/v2ray-agent/master/shell/install_en.sh" && chmod 700 /root/install_en.sh && mv /root/install_en.sh /root/install.sh && /root/install.sh -``` +## Installation script -- Example diagram +- supports shortcut startup, after installation, enter [**vasma**] in the shell You can open the script, the script execution path [**/etc/v2ray-agent/install.sh**] + +- Latest Version [recommended] + +``` +wget -P/root -N --no-check-certificate "https://raw.githubusercontent.com/mack-a/v2ray-agent/master/shell/install_en.sh" && chmod 700/root/install.sh &&/root/install.sh +``` + + +# example image -# License +# licence -[GPL-3.0](https://github.com/mack-a/v2ray-agent/blob/master/LICENSE) +[AGPL-3.0](https://github.com/mack-a/v2ray-agent/blob/master/LICENSE) ## Stargazers over time