From 94775bb0a0641f6eab67a05dde441758ccb1c613 Mon Sep 17 00:00:00 2001 From: Evgeny Nerush Date: Fri, 27 Oct 2023 15:03:55 +0300 Subject: [PATCH] fix misprints in Readme --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index d099fab..dc8e454 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,15 @@ (todo) [Readme in Chinese](README.cn.md) [XRay (aka ProjectX)](https://xtls.github.io/en/) is a frontier solution to surpass the internet censorship. It can work as a server and as -a client, but it's configuration sometimes confusing for a newcomer. So, here is a script which helps to +a client allowing to guide traffic through a VPS outside the region of censorship. XRay configuration can be confusing for a newcomer, +so, here is a script which helps to -- install/uninstall (todo: upgrade) *XRay* +- install/upgrade/remove XRay - generate credentials and server/client configs - (todo) add/delete users to the configs -First make the script `ex.sh` executable, then run it with a desired command. Use `./ex.sh help` to see the list of all available commands -and `./ex.sh install` to start interactive prompt which installs and configures *XRay*. +First, make the script `ex.sh` executable, then run a desired command with it. Use `./ex.sh help` to see the list of all available commands +and `./ex.sh install` to start interactive prompt which installs and configures XRay. ``` $ chmod +x ex.sh $ ./ex.sh help @@ -24,15 +25,15 @@ $ sudo ./ex.sh install ### Prerequisites For manipulations with configs, [jq](https://jqlang.github.io/jq/) is needed, it can be found in repositories of almost all popular Linux -distributives. +distributions. ### How it works -With current configs, *XRay* creates a tunnel between the client (your laptop, phone etc.) and the server (your VPS). The tunnel uses *VLESS -Reality* protocol that obfuscates traffic and in our case imitates [grpc](https://en.wikipedia.org/wiki/GRPC). For the censor the tunnel -looks like a usual connection to a site. The server responses to https requests as some popular site thus it is not suspicious for an active -probing. On the client side *XRay* creates a socks proxy which can be used by your Telegram or web -browser like this: +With current configs, XRay creates a tunnel between the client (your laptop, phone etc.) and the server (your VPS). The tunnel uses VLESS +[Reality](https://github.com/XTLS/REALITY/blob/main/README.en.md) protocol that obfuscates traffic and in our case imitates +[grpc](https://en.wikipedia.org/wiki/GRPC). For the censor the tunnel looks like a usual connection to a site. The server responds to https +requests as some popular site thus it is not suspicious for an active probing. On the client side *XRay* creates http/https and socks +proxies which can be used by your Telegram or web browser like this: ![browser proxy: http/https proxy 127.0.0.1 at port 801, socks v5 host 127.0.0.1 at port 800](browser-proxy-settings.png) @@ -50,4 +51,4 @@ For Windows, MacOS or Android you can try Nekobox, v2rayNG or ? (TODO): tests an [Configs](https://github.com/XTLS/Xray-examples/tree/main/VLESS-gRPC-REALITY) on which the template configs are based. -(TODO) logging, choose domain names or geoip, configs for phone... +(TODO) choose domain names or geoip, configs for phone...