github-mirrors/easy-xray
1
0
Fork 0
mirror of https://github.com/EvgenyNerush/easy-xray.git synced 2025-12-13 21:35:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

update readme with browser settings; change port

Browse Source
This commit is contained in:
Evgeny Nerush
2023-10-25 11:35:04 +03:00
parent d04fde6cc1
commit c5b1ed7397
6 changed files with 24 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -1,22 +1,23 @@
# easy-xray
*Script for Linux which make XRay installation and configuration easy.*
*Script for Linux which makes XRay installation and configuration easy.*
(todo) [Readme in Russian](README.ru.md)
(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 newbie. So, here is a scripts which help
a client, but it's configuration sometimes confusing for a newcomer. So, here is a script which helps to
- install(todo /uninstall/update) *XRay*
- generate credentials and server/client config
- (todo) add/delete user and update config
- install/uninstall (todo: upgrade) *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 all` to start interactive prompt which installs and configures *XRay*.
and `./ex.sh install` to start interactive prompt which installs and configures *XRay*.
```
$ chmod +x ex.sh
$ ./ex.sh help
$ sudo ./ex.sh all
$ sudo ./ex.sh install
```
### Prerequisites
@@ -24,9 +25,19 @@ $ sudo ./ex.sh all
For manipulations with configs, [jq](https://jqlang.github.io/jq/) is needed, it can be found in repositories of almost all popular Linux
distributives.
### How it works
With current configs, *XRay* creates a [grpc](https://en.wikipedia.org/wiki/GRPC) tunnel between the client (your laptop, phone etc.) and
the server (your VPS). 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
web browser, telegram or TorBrowser like that:
![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)
### Acknowledgements
[This article (in Russian)](https://habr.com/ru/articles/731608/) helped me install *XRay* for the first time.
[This article (in Russian)](https://habr.com/ru/articles/731608/) helped me to install *XRay* for the first time.
[XRay config reference](https://xtls.github.io/en/config/) is brilliant and helped me much.
[Configs](https://github.com/XTLS/Xray-examples/tree/main/VLESS-gRPC-REALITY) on which the template configs are based.
(TODO) about, reality-vless, domains, browser settings, no encription(!), choose domain names or geoip
(TODO) about, reality-vless, domains, browser settings, no encription(!), choose domain names or geoip, configs for phone...