3X-UI Graphics Panel¶

Getting started after deploying 3X-UI¶

After payment of the order, a notification of the server's readiness for operation will be sent to the e-mail address specified during registration. It will contain the IP address of the VPS, as well as the login and password for connection. Clients of our company manage the equipment in the server control panel and API - Invapi.

Here you can also find the credentials, which can be found either in the Info >> Tags tab of the server control panel or in the email sent to you:

• Link to access the 3X-UI webpanel: in the webpanel tag. The exact link of the form https://{Server_ID_from_Invapi}.hostkey.in:XXXXX comes in the email sent when the server is handed over;
• Login: root;
• Password: comes in a letter to your email address when you hand over the server.

Set up a New Connection¶

1. After logging into the 3X-UI panel, go to the Inbounds tab and click on the Add Inbound button:

   

2. Fill in the following fields in the opened menu:

   • Remark - name the connection using the protocol type (e.g. VLESS) or client group type.This name will be displayed in the list of incoming connections;
   • Protocol - protocol selection is set to vless by default, but it can bechanged and configured manually if desired;
   • Listen IP - if you leave this field empty, the server will listen on all IP addresses;
   • Port - specify port 443.

   Note

   The fields Total Flow (GB) and Expire Date are optional.

   

3. Select the REALITY tab located under Security at the bottom of the window.

   

4. Navigate to the client settings and complete the necessary fields in the Client section.

   • Email - client ID, must be unique. If entering an email, it must also be unique for each protocol. If you have a user, keep the existing one or create a new user by clicking the icon next to the email field. If there are multiple users, set a readable identifier such as [email protected].
   • ID - unique identifier for the incoming connection. The ID must be 32 characters long and can only contain numbers and lowercase letters of the Latin alphabet. It can be generated automatically by clicking the icon in front of the key input field.
   • Flow - the value is set to xtls-rprx-vision.

   

5. Navigate to the REALITY setting and select chrome in the uTLS field, or choose another option from the list.

6. Enter the domain to mask in the Dest and SNI fields. The default option is yahoo.com.

   Attention

   Consider selecting a different domain from the proposed options and replacing the default one in the corresponding fields:

   • Dest: www.microsoft.com:443 and SNI: www.microsoft.com
   • Dest: dl.google.com:443 and SNI: dl.google.com

7. In ShortIds click on the icon . This action will generate a random ID.

8. Click the Get New Cert button to generate new keys for Private Key and Public Key.

   

9. After entering the data, click the Create button.

If configured correctly, you will have an entry with the protocol.

Connections for other protocols can be configured in the same manner.

The connection to 3X-UI from PC¶

Various clients can be used to connect to 3X-UI: [v2rayN](https://github.com/2dust/v2rayN), [Invisible Man XRay](https://github.com/InvisibleManVPN/InvisibleMan-XRayClient), [v2rayU](https://github.com/yanue/V2rayU/tree/master), [Nekoray](https://github.com/MatsuriDayo/nekoray) and others. For macOS devices, it is recommended to use the FoXray client or Hiddify Next.

Using the Hiddify Next client on Windows, Linux or macOS¶

To connect to 3X-UI using the Hiddify Next client, follow these steps:

1. [Download] the Hiddify Next release with the Latest tag and install the package or file for your operating system.

2. In Explorer, navigate to the installation path (usually C:\Program Files\hiddify), select Properties from the right-click menu of the HiddifyNext.exe file, and click the Compatibility tab in the window that opens.

   Click on Change settings for all users, check the box Run this program as administrator, and click OK.

   

3. Open the Hiddify Next client and configure the following settings:

   • Go to Settings and choose Region - Other.

   

   • Go to Settings >> Config Options and set Service Mode - VPN (Experimental).

   

4. Add server data by following these steps:

   • Open the QR code with the connection settings in the 3X-UI graphical panel:

     

   • Copy the QR code in the 3X-UI graphic panel to the clipboard (just click on it);

   • Navigate to the Home page and establish a connection to the server by selecting either + New Profile or the + icon located in the upper right corner.

   • Click on the panel labeled Add From Clipboard:

   

   Upon successful addition of the data, a pop-up message will appear and the server profile will be added to the list:

   

To connect to the 3X-UI, press the large round button. If the connection is successful, the icon will turn green and display Connected. Disconnecting is done in the same way by clicking the button.

Using the Nekoray client on Windows or Linux¶

To connect to 3X-UI using the Nekoray client, follow these steps:

1. Download the archive containing the Windows program or download and install the package on Linux.

   To use Nekoray on Windows, extract the nekoray folder from the archive onto your disk and run nekoray.exe from within the folder.

2. The first time you start the client, specify the kernel - sing-box. You can change the kernel in the already installed client by going to Preference >> Basic settings >> Core.

3. Add server data. To do this:

   • Open the QR code with the connection settings in the 3X-UI graphical panel:

     

   • Without minimising the browser window with the QR code, go to the Program menu in Nekoray and select Scan QR Code:

     

   or

   • Copy the QR code in the 3X-UI graphic panel to the clipboard (just click on it);

   • In the Nekoray client, select Program >> Add profile from clipboard.

4. Check the box next to Tun mode;

5. Start the connection by right-clicking on its name and selecting Start:

Android Mobile Devices¶

Connecting using Hiddify Next¶

To connect to the 3X-UI using Hiddify Next, follow these steps:

1. Download and install FoXray Hiddify Next from Google Play or download the appropriate APK for your architecture from the developer's website.

2. To complete the presets, open the Hiddify Next app:

   • Go to the menu item Settings under the icon and select Region - Other;
   • In the menu , go to Settings >> Config Options. From there, set the Service Mode - VPN.

   

3. Include server data by following these steps:

   • Open the QR code with the connection settings in the 3X-UI graphical panel on the server:

     

   • To add a server connection in the Hiddify Next app, navigate to the main screen and click on either the + New Profile button or the + icon located in the top right corner. Next, select Scan QR Code and scan the code:

     

4. Upon successful completion of the scan, a message will display and the server profile will be added to the list. To connect to the 3X-UI, click the large round button. Once the connection is established, the icon will turn green and display Connected. To disconnect, simply click the button again.

5. To enable proxy mode for specific applications, go to >> Settings and turn ON the Per-app Proxy switch. Then, select the applications you want by checking the proxy mode checkbox next to them.

   

Connect using v2rayNG¶

To connect to the 3X-UI using v2rayNG, follow these steps:

1. Download and install v2rayNG from the Google Play.

2. Open the v2rayNG app and click the button:

1. In the menu, choose the Import profile from QR code option and scan the QR code in the 3X-UI graphical panel:

You need to scan the QR code with the connection settings in the 3X-UI graphic panel:

1. Activate the connection.

iOS Mobile Devices¶

In our example, we will use the FoXray client. Alternatively, you can use the v2box or Shadowrocket client. To connect to 3X-UI using FoXray, follow these steps:

1. Download and install FoXray from the App Store.

1. Open the FoXray app and click the button (it will allow you to add the configuration manually) or scan the QR code in the 3X-UI graphical panel:

1. Click the Play button and allow the app to add the VPN configuration to the device:

3X-UI Update¶

To update the panel to the latest version, connect to your server via SSH or HTML5 console from the command line.

ssh root@<Server IP>

Please enter the root password and execute the following commands:

cd 3x-ui
docker compose down
docker compose pull 3x-ui
docker compose up -d

3X-UI. Key Features¶

• Traffic Encryption: VLESS, Shadowsocks-2022, and XRay (XTLS) allow encrypting user’s traffic, making it impossible to read or monitor by the Internet service provider or other third parties.
• Multi-factor Authentication: Support for multi-factor authentication enhances security and protects users’ data from unauthorized access.
• Flexible Settings: The ability to configure connection’s parameters such as encryption type, ports, and protocols. It provides flexibility in connection setup and ease of use.
• Speed Optimization: Optimization for fast network connection. They can use various technologies such as TCP Fast Open and Congestion Control, which accelerate data transmission and improve connection quality.
• Support for Various Operating Systems: Windows, MacOS, Linux, Android, and iOS. This ensures the universality and accessibility of the product for users on any platform.
• Open Source: It provides developers with the opportunity to study the code and make their own changes, which can help improve the product and its functionality.
• Reliability and Stability: VLESS, Shadowsocks-2022, and XRay (XTLS) are reliable and stable protocols. They provide high connection speed and stability, as well as protection of user data.

Features of the assembly¶

• Installation on RHEL 8+ and Ubuntu 20.04+ families is possible. In RHEL-like operating systems, VLESS and Shadowsocks-2022 protocols are open only on port 443 by default.
• Installation time is 15-20 minutes, including OS.
• Containerized installation of 3X-UI + SSL in the hostkey.in zone.
• Installed software:
  • Docker CE
  • Docker Compose.
• Xray Panel - the channel of the developer's panel on Telegram.
• The build MHSanaei/3x-ui.
• Used containers:
  • ghcr.io/mhsanaei/3x-ui
  • jonasal/nginx-certbot:latest
• Route to compose: /root/3x-ui.
• Route to mounted directories: /data.

• To customize the installation, you need to make changes in /root/3x-ui/compose.yml Then restart compose via commands:

  • To stop containers, run the command:

    docker compose -f /root/3x-ui/compose.yml down
    

  • To enable containers, you need to run the command :

    docker compose -f /root/3x-ui/compose.yml -d up
    

Ordering a server with 3X-UI using the API¶

curl -s "https://invapi.hostkey.com/eq.php" -X POST \
--data "action=order_instance" \
--data "token=" \
--data "deploy_period=" \
--data "deploy_notify=" \
--data "email=" \
--data "pin=" \
--data "id=" \
--data "os_id=" \
--data "root_pass=" \
--data "hostname=" \
--data "ssh_key=" \
--data "post_install_callback=" \
--data "post_install_script=" \
--data "reinstall_key=" \
--data "os_name=" \
--data "imitate_deploy=" \
--data "imitate_error=0" \
--data "own_os=" \
--data "jenkins_task=" \
--data "traffic_plan=" \
--data "invoice_relid=" \
--data "preset=" \
--data "location_name=" \