Xray-docs-next/docs/en/README.md

97 lines
3.7 KiB
Markdown
Raw Normal View History

2021-05-26 11:05:53 +00:00
---
home: true
heroImage: /LogoX2.png
heroText: Project X
tagline: Fear not the clouds that obscure the view, golden eyes like a torch brighten the sky
2021-05-26 11:05:53 +00:00
actions:
- text: Start here →
2021-05-26 11:05:53 +00:00
link: /document/
type: primary
- text: Configuration guide →
2021-05-26 11:05:53 +00:00
link: /config/
type: secondary
features:
- title: High-speed protocol
details: Original VLESS and XTLS protocols, free from redundant encryption, release CPU power
2021-05-26 11:05:53 +00:00
- title: Free combination
2021-05-26 11:05:53 +00:00
details: |
Perfect fallback mechanism, effectively prevent active detection, multi-service sharing ports
2021-05-26 11:05:53 +00:00
- title: Ultra-low occupancy
2021-05-26 11:05:53 +00:00
details: |
OpenWRT RaspberryPi and other simplified devices can be used
2021-05-26 11:05:53 +00:00
- title: Powerful routing
2021-05-26 11:05:53 +00:00
details: |
Highly customizable routing system to meet various usage requirements and fully exploit network performance
2021-05-26 11:05:53 +00:00
- title: Full compatibility
2021-05-26 11:05:53 +00:00
details: |
Fully compatible with v2ray-core configuration files and API calls
2021-05-26 11:05:53 +00:00
- title: Affinity
2021-05-26 11:05:53 +00:00
details: |
Active community discussions and contributions, MPL 2.0 open source license
2021-05-26 11:05:53 +00:00
footer: Licensed under CC-BY-SA 4.0 | Copyright 2020-Present Project X Community
---
## XTLS? Xray? V2Ray?
2021-05-26 11:05:53 +00:00
**XTLS are brilliant ideas for TLS we study, while Xray is the best practice we maintain.**
- Xray-core is a superset of v2ray-core, with better overall performance and enhancements such as XTLS, and it's~~completely~~compatible with v2ray-core functionality and configuration.
- Only one executable file, including ctl functionality, run is the default command
- Configuration is~~completely~~compatible, environment variables and API calls need to be changed to start with XRAY\_
- Exposed raw protocol's ReadV on all platforms
- Provides complete VLESS & Trojan XTLS support, both with ReadV
- Provides multiple XTLS flow control modes, unrivaled performance!
2021-05-26 11:05:53 +00:00
> "Configuration compatible, overall better"
2021-05-26 11:05:53 +00:00
### Who are we?
2021-05-26 11:05:53 +00:00
> **It doesn't matter who we are. What matters is that we will keep riding and never look back.**
2021-05-26 11:05:53 +00:00
### Help Xray become stronger
2021-05-26 11:05:53 +00:00
Welcome to help Xray become stronger!
2021-05-26 11:05:53 +00:00
- 🖥️ Help develop and test Xray, submit high-quality Pull requests.
- 📩 Initiate constructive or meaningful issues and discussions in [GitHub Issues](https://github.com/XTLS/Xray-core/issues) or [Discussion area](https://github.com/XTLS/Xray-core/discussions).
- 📝 Write down your usage experience and submit it to Xray's [documentation website](https://github.com/XTLS/Xray-docs-next).
- 💬 Help group members/chat in Telegram group.
- **...In fact, every support for Xray will make Xray stronger**
2021-05-26 11:05:53 +00:00
### Telegram
- [Project X Discussion Group](https://t.me/projectXray)
2021-05-26 11:05:53 +00:00
- You can chat freely above the bottom line in the discussion group, don't fight, no abuse of power.
- Feel free to ask questions, and try to answer those you know.
- No politics, No NSFW
2021-05-26 11:05:53 +00:00
- [Project X Channel](https://t.me/projectXtls)
- Publish the latest news of Project X
2021-05-26 11:05:53 +00:00
### Thanks
2021-05-26 11:05:53 +00:00
- Thanks to everyone for their support!
- Thanks to all kinds of scripts, Docker images, client support... Thanks to all the big guys who helped improve the ecosystem!
- Thanks to friends who have contributed to the Xray website and documentation.
- Thanks to friends who have made meaningful suggestions and comments.
- Thanks to every friend in the Telegram group who helps others.
2021-05-26 11:05:53 +00:00
### More about project X
2021-05-26 11:05:53 +00:00
- If you would like to learn more about project X's history and growth, please click [here](./about/news.md)
2021-05-26 11:05:53 +00:00
### License
[Mozilla Public License Version 2.0](https://github.com/XTLS/Xray-core/blob/main/LICENSE)
### Stargazers over time
[![Stargazers over time](https://starchart.cc/XTLS/Xray-core.svg)](https://starchart.cc/XTLS/Xray-core)