Download the PHP
package estaheri/3x-ui without Composer
On this page you can find all versions of the php package
estaheri/3x-ui. It is possible to download/install
these versions without Composer. Possible dependencies are resolved
automatically.
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
[](https://www.php.net/releases/8.2/en.php)
[](https://github.com/MHSanaei/3x-ui/releases/tag/v2.4.8)
[](https://github.com/XTLS/Xray-core/releases/tag/v24.11.21)
[](https://github.com/es-taheri/3x-ui/releases/latest)
[](https://github.com/es-taheri/3x-ui/blob/master/LICENSE)
### PHP 3X-UI
**Simple open-source PHP library for managing MHSanaei 3x-ui panel without its official rest api.**
> [!IMPORTANT]\
> This library is only for personal using, please do not use it for illegal purposes, please do not use it in a
> production environment.
## Quick Start
* Require library in your project 📁
* Require composer autoload in your php code ⚓
* Instantiating `Xui` class and set connection credentials 📡
* Login to panel using username & password 🔐
* Now you can do anything ✅
## Full Documentation
[Responses](#responses)\
[Protocols](#protocols)\
[Rules](#rules)\
[New Xui](#new-xui)
* [Login](#login)
* [Random](#random)
* [Uuid](#uuid)
[Xray](#xray)
* [Inbound](#inbound)
* [Outbound](#outbound)
* [Routing](#routing)
* [Reverse](#reverse)
* [Configs](#configs)
[Server](#server)
* [Status](#status)
* [Database](#database)
* [Xray-Restart-Stop](#xray-restart-stop)
* [Reality-Certificate](#reality-certificate)
* [Xui-log](#xui-log)
[Panel](#panel)
* [Settings](#settings)
* [Restart](#restart)
* [Default-Xray-Config](#default-xray-config)
### Responses
All methods return value based this document :
- #### Methods Return
We have 3 types of methods return value :
- Object (Default)
- JSON
- Array
> [!NOTE]\
> You can set return type from `$output` property in all classes.\
> You can set it globally when Calling `Xui` Object-oriented class.
**General structure of recursive methods :**
- #### Response
We have 3 types of response in methods return value :
- Object (Default)
- JSON
- Array
> [!NOTE]\
> You can set response type from `$response_output` property in all classes.\
> You can set it globally when Calling `Xui` Object-oriented class.
**General structure of response :**
### Protocols
You can create a config for inbound/outbound by calling its object-orinted class
> [!TIP]
> All variables and properties of protocols and streams classes and methods based on Project X official documentations.\
> You can find full documentation of protocols and their configuration
> on [Xtls/Xray official website](https://xtls.github.io/en/)\
> [Inbound Protocols Docs](https://xtls.github.io/en/config/inbounds/)\
> [Outbound Protocols Docs](https://xtls.github.io/en/config/outbounds/)\
> [Inbound/Outbound Streams Docs](https://xtls.github.io/en/config/transport.html)
Supported Inbound protocols :
- Vmess
- Vless
- Trojan
- Shadowsocks
- Socks
- Http
- DokodomoDoor
Supported Outbound protocols :
- Vmess
- Vless
- Trojan
- Shadowsocks
- Socks
- Http
- Dns
- Blackhole
- Freedom
Supported Inbound/Outbound Streams and Security :
- tcp
- kcp
- ws
- http
- quic
- ds
- grpc
- sockopt
- tls
- reality
### Rules
An object-oriented class for creating a routing rule
Get or Set a rule setting :
Rule settings supported :
### New Xui
Calling `Xui` Object-oriented class for creating connection to 3x-ui
- #### Login
After instantiating `Xui` class must use this method to login to panel.
> [!Note]\
> Library automatically use cookie if login recently
- #### Random
An static method for generating random string.
- #### Uuid
An static method for generating random uuid useful to set inbound/outbounds clients uuid.
### Xray
A property to accessing Xray configs including Inbound,Outbound,Routing,Reverse,Others and restarting xray-core.
- #### Inbound
A property to accessing Xray configs **inbounds**.
##### Methods
- #### Outbound
A property to accessing Xray configs **outbounds**.
##### Methods
- #### Routing
A property to accessing Xray configs **routing**.
> [!Note]\
> Before using routing methods must call `load()` method to load routing configs from xray config!
##### Methods
- #### Reverse
A property to accessing Xray configs **reverse**.
> [!Note]\
> Before using reverse methods must call `load()` method to load reverse configs from xray config!
##### Methods
- #### Configs
Use these methods for configuring xray core or get xray core configuration.
> [!Note]\
> You must restart xray to apply changes made to xray configurations. \
> Use `set_config()` to apply default xray configuration got from `$xui->panel->default_xray_config()` Or set a full
> custom xray configuration.
##### Methods
### Server
A property to accessing server status,panel database,restart/stop xray,xui logs,...
- #### Status
Use this method to get a full information about server resources and usage of it and information about xray-core.
- #### Database
Import / Export panel SQLLite database.
- #### Xray-Restart-Stop
Restart / Stop Xray-core
- #### Reality-Certificate
Use this method to get a x25519 certificate for reality
- #### Xray-Full-Config
Use this method to get xray-core fully config included inbounds,...
- #### Xui-log
Get xui logs
### Panel
A property to accessing panel settings,restart panel,default xray config.
- #### Settings
Methods to get/update 3x-ui panel settings.
##### Methods
- #### Restart
Restart 3x-ui panel (Only panel!)
- #### Default-Xray-Config
Get default xray config based on panel and xray-core version. (Only Xray default config!)
## Special Thanks to
- [MHSanaei](https://github.com/MHSanaei)
- [alireza0](https://github.com/alireza0/)
## Support project
### Give Star ⭐
**If this library is helpful to you, you may wish to give it a STAR**
### Donate 💵
**Help me improve this library by a donate** ❤️
- TRX : `TXFE1je6Ed7fADvxAQXXo2g45eQtXvwith`
- TON : `UQDb44qyae9n0hmgay3Bs_oom6RR8cZbLF5_9UCei0q13T0b`
- USDT (TRON): `TCTyFGJVkCgruAYmvPpetF6jVybuZSpTg6`
- USDT (TRX): `UQBnnLMdbAH6Pq86lsH9jEySH-D5___ctqUFKiuBXnd74FTD`
Composer command for our command line client (download client)This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free.Standard composer command
The package estaheri/3x-ui contains the following files
Loading the files please wait ....
Loading please wait ...
Before you can download the PHP files, the dependencies should be resolved. This can take some minutes. Please be patient.
