forked from wyx2685/XrayR
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request XrayR-project#227 from Github-Aiko/master
Translate Readme for English(en) users
- Loading branch information
Showing
4 changed files
with
115 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
# XrayR | ||
|
||
[](https://t.me/XrayR_project) | ||
[](https://t.me/XrayR_channel) | ||
 | ||
 | ||
 | ||
 | ||
[]() | ||
|
||
[Iranian(farsi) README](https://github.com/XrayR-project/XrayR/blob/master/README_Fa.md), [Vietnamese(vi) README](https://github.com/XrayR-project/XrayR/blob/master/README-vi.md), [English(en) README](https://github.com/XrayR-project/XrayR/blob/master/README-en.md) | ||
|
||
A Xray backend framework that can easily support many panels. | ||
|
||
A back -end framework based on XRAY supports V2ay, Trojan, Shadowsocks protocols, which are easy to expand and support multi -panel docker. | ||
|
||
|
||
If you like this project, you can click STAR+WATCH in the upper right corner to continue to pay attention to the progress of this project. | ||
|
||
## Guide for use | ||
|
||
Tutorial:[Detailed tutorial](https://xrayr-project.github.io/XrayR-doc/) | ||
|
||
|
||
## Disclaimer | ||
|
||
This project is just my personal learning and development and maintenance. I do not guarantee any availability and is not responsible for any consequences caused by the use of this software. | ||
|
||
## Features | ||
|
||
* Permanent open source and free. | ||
* Support V2Ray, Trojan, Shadowsocks multiple protocols. | ||
* Support new features such as Vless and XTLS. | ||
* Support single instance docking multi -panel and multi -node, no need to start repeatedly. | ||
* Support restriction online IP | ||
* Support node port level and user level speed limit. | ||
* The configuration is simple and clear. | ||
* Modify the automatic restart instance. | ||
* Easy to compile and upgrade, you can quickly update the core version and support the new features of XRAY-CORE. | ||
|
||
## Function | ||
|
||
| Function | v2ray | trojan | shadowsocks | | ||
|-----------|-------|--------|-------------| | ||
| Get node information | √ | √ | √ | | ||
| Get user information | √ | √ | √ | | ||
| User traffic statistics | √ | √ | √ | | ||
| Server information report | √ | √ | √ | | ||
| Automatically apply for a TLS certificate | √ | √ | √ | | ||
| Automatic renewal TLS certificate | √ | √ | √ | | ||
| Number of online people | √ | √ | √ | | ||
| Online user restrictions | √ | √ | √ | | ||
| Audit rules | √ | √ | √ | | ||
| Node port speed limit | √ | √ | √ | | ||
| According to user speed limit | √ | √ | √ | | ||
| Custom DNS | √ | √ | √ | | ||
|
||
## Support for panels | ||
|
||
| Panel | v2ray | trojan | shadowsocks | | ||
|--------------------------------------------------------|-------|--------|-------------------------| | ||
| sspanel-uim | √ | √ | √ (Single-ended multi-user and V2Ray-Plugin) | | ||
| v2board | √ | √ | √ | | ||
| [PMPanel](https://github.com/ByteInternetHK/PMPanel) | √ | √ | √ | | ||
| [ProxyPanel](https://github.com/ProxyPanel/ProxyPanel) | √ | √ | √ | | ||
| [WHMCS (V2RaySocks)](https://v2raysocks.doxtex.com/) | √ | √ | √ | | ||
|
||
## Software Installation | ||
|
||
### 1-Click installation | ||
|
||
``` | ||
wget -N https://raw.githubusercontent.com/XrayR-project/XrayR-release/master/install.sh && bash install.sh | ||
``` | ||
|
||
### Docker | ||
|
||
[Docker deployment tutorial](https://xrayr-project.github.io/XrayR-doc/xrayr-xia-zai-he-an-zhuang/install/docker) | ||
|
||
### Manual installation | ||
|
||
[Manual installation tutorial](https://xrayr-project.github.io/XrayR-doc/xrayr-xia-zai-he-an-zhuang/install/manual) | ||
|
||
## Configuration file and detailed use tutorial | ||
|
||
[Detailed tutorial](https://xrayr-project.github.io/XrayR-doc/) | ||
|
||
## Thanks | ||
|
||
* [Project X](https://github.com/XTLS/) | ||
* [V2Fly](https://github.com/v2fly) | ||
* [VNet-V2ray](https://github.com/ProxyPanel/VNet-V2ray) | ||
* [Air-Universe](https://github.com/crossfw/Air-Universe) | ||
|
||
## Licence | ||
|
||
[Mozilla Public License Version 2.0](https://github.com/XrayR-project/XrayR/blob/master/LICENSE) | ||
|
||
## Telgram | ||
|
||
[Xrayr back-end discussion](https://t.me/XrayR_project) | ||
|
||
[Xrayr notification](https://t.me/XrayR_channel) | ||
|
||
## Stargazers over time | ||
|
||
[](https://starchart.cc/XrayR-project/XrayR) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters