Skip to content

Commit

Permalink
Merge pull request XrayR-project#227 from Github-Aiko/master
Browse files Browse the repository at this point in the history
Translate Readme for English(en) users
  • Loading branch information
pocketW authored Jan 20, 2023
2 parents 0160518 + 007d9a0 commit d8a3242
Show file tree
Hide file tree
Showing 4 changed files with 115 additions and 1 deletion.
109 changes: 109 additions & 0 deletions README-en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# XrayR

[![](https://img.shields.io/badge/TgChat-@XrayR讨论-blue.svg)](https://t.me/XrayR_project)
[![](https://img.shields.io/badge/Channel-@XrayR通知-blue.svg)](https://t.me/XrayR_channel)
![](https://img.shields.io/github/stars/XrayR-project/XrayR)
![](https://img.shields.io/github/forks/XrayR-project/XrayR)
![](https://github.com/XrayR-project/XrayR/actions/workflows/release.yml/badge.svg)
![](https://github.com/XrayR-project/XrayR/actions/workflows/docker.yml/badge.svg)
[![Github All Releases](https://img.shields.io/github/downloads/XrayR-project/XrayR/total.svg)]()

[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

[![Stargazers over time](https://starchart.cc/XrayR-project/XrayR.svg)](https://starchart.cc/XrayR-project/XrayR)


2 changes: 2 additions & 0 deletions README-vi.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
![](https://github.com/XrayR-project/XrayR/actions/workflows/docker.yml/badge.svg)
[![Github All Releases](https://img.shields.io/github/downloads/XrayR-project/XrayR/total.svg)]()

[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.

Khung trở lại dựa trên XRay hỗ trợ các giao thức V2ay, Trojan, Shadowsocks, dễ dàng mở rộng và hỗ trợ kết nối nhiều người.
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
![](https://github.com/XrayR-project/XrayR/actions/workflows/docker.yml/badge.svg)
[![Github All Releases](https://img.shields.io/github/downloads/XrayR-project/XrayR/total.svg)]()

[Iranian](https://github.com/XrayR-project/XrayR/blob/master/README_Fa.md)|[Vietnamese](https://github.com/XrayR-project/XrayR/blob/master/README-vi.md)

[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.

Expand Down
2 changes: 2 additions & 0 deletions README_Fa.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
![](https://github.com/XrayR-project/XrayR/actions/workflows/docker.yml/badge.svg)
[![Github All Releases](https://img.shields.io/github/downloads/XrayR-project/XrayR/total.svg)]()

[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)

یک فریمورک بک اند مبتنی بر xray که از چند از پنل پشتیبانی می کند

یک چارچوب بک‌اند مبتنی بر Xray که از پروتکل‌های V2ay، Trojan و Shadowsocks پشتیبانی می‌کند، به راحتی قابل گسترش است و از اتصال چند پنل پشتیبانی می‌کند.
Expand Down

0 comments on commit d8a3242

Please sign in to comment.