Xray-docs-next/docs/en
yuhan6665 289cda827a Fix prettier format 2023-05-19 11:10:34 -04:00
..
about Add English translate (WIP) 2021-05-26 19:05:53 +08:00
config Translate into English (#368) 2023-05-14 19:35:07 -04:00
development Fix prettier format 2023-05-19 11:10:34 -04:00
document Fix prettier format 2023-05-19 11:10:34 -04:00
README.md Translate into English (#368) 2023-05-14 19:35:07 -04:00

README.md

home heroImage heroText tagline actions features footer
true /LogoX2.png Project X Fear not the clouds that obscure the view, golden eyes like a torch brighten the sky
text link type
Start here → /document/ primary
text link type
Configuration guide → /config/ secondary
title details
High-speed protocol Original VLESS and XTLS protocols, free from redundant encryption, release CPU power
title details
Free combination Perfect fallback mechanism, effectively prevent active detection, multi-service sharing ports
title details
Ultra-low occupancy OpenWRT RaspberryPi and other simplified devices can be used
title details
Powerful routing Highly customizable routing system to meet various usage requirements and fully exploit network performance
title details
Full compatibility Fully compatible with v2ray-core configuration files and API calls
title details
Affinity Active community discussions and contributions, MPL 2.0 open source license
Licensed under CC-BY-SA 4.0 | Copyright 2020-Present Project X Community

XTLS? Xray? V2Ray?

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'scompletelycompatible with v2ray-core functionality and configuration.
    • Only one executable file, including ctl functionality, run is the default command
    • Configuration iscompletelycompatible, 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!

"Configuration compatible, overall better"

Who are we?

It doesn't matter who we are. What matters is that we will keep riding and never look back.

Help Xray become stronger

Welcome to help Xray become stronger!

  • 🖥️ Help develop and test Xray, submit high-quality Pull requests.
  • 📩 Initiate constructive or meaningful issues and discussions in GitHub Issues or Discussion area.
  • 📝 Write down your usage experience and submit it to Xray's documentation website.
  • 💬 Help group members/chat in Telegram group.
  • ...In fact, every support for Xray will make Xray stronger

Telegram

  • Project X Discussion Group

    • 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
  • Project X Channel

    • Publish the latest news of Project X

Thanks

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

More about project X

  • If you would like to learn more about project X's history and growth, please click here

License

Mozilla Public License Version 2.0

Stargazers over time

Stargazers over time