Hiddify¶

Getting started after deploying Hiddify¶

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.

  Attention

  Once installed, a random site will be shown to you at {server id}.hostkey.in or its IP address, just access the link from the server control panel.

After clicking on the link, you do not need to enter a password.

Initial Settings in Admin Panel¶

Access the admin panel by following these steps:

1. Follow the link from the :fontawesome-solid-tags webpanel tag.

   Note

   You can also obtain this link by following the instructions.

   Attention

   When you go to the IP address of the server, you may get an error about an insecure connection.

   

   To get around this, in your Chrome browser (and on your Chrome browser), click on Advanced and then on the link Proceed to {server_ip}....

2. In the Hiddify panel, select the country labeled as Others.

3. Specify a domain in the format of {Server ID}.hostkey.in, for example, 48543.hostkey.in, in the Domain field.

   Note

   The server ID and IP can be found in the control panel

4. In the Decoy Site field, you can enter the URL of the website that will be displayed when accessing the IP address or domain name from step 3.

5. Click the Submit button.

   

6. Installation should take around five minutes. It is important to copy and save the panel access link provided by the form administrator: https://48543.hostkey.in/oN6xxKuCjrLIm0Garp2SGtMgH/0d3603c3-a8a3-47ad-9ee1-6c56044aae14/admin/. This link will be displayed during the installation process.

   

   Attention

   If you did not save the admin link, you can restore it.

7. Upon successful installation, a message will be displayed:

   

   Attention

   To access the admin panel, use only the link saved in step 6. This is because after installation, a random site will be displayed at {Server ID}.hostkey.in or site with URL from step 4.

Adding a New User¶

User management is done in the Users section.

To create a new user, go to the specified section and click on the Create button:

Then fill in the information about the new user. The Name field is mandatory:

The Usage limit fields enable you to specify the amount of traffic available to the user, while the Package Days field allows you to set the duration of time during which the user can consume this traffic.

Set the following values for the default network traffic volume included in the server tariff: Usage limit = 3000 and Package Days = 30.

After entering the user data, click on the Save button.

User Control Panel¶

To access a user's control panel from the admin panel, click on the address button in the User Link column of their row.

In the panel that appears, you can:

• View the remaining traffic in the Traffic Usage field by clicking Show Usage Details;

• Get a QR code or link to set up Hiddify access clients by clicking View QR Code in the QR Code field;

  To access the content, scan the QR code with your smartphone camera or click Copy to obtain the access link for third-party clients.

  

  Note

  The default selection is AUTO configuration. To choose a specific protocol, navigate to the All Configs tab in the User Control Panel.

• Configure the HiddifyN client already installed on the system by clicking on the Tap to set anti-filter field;

• Get a short link to access the User Dashboard by clicking on the Temporary Short Link field.

Connecting to Hiddify from a computer¶

Using the HiddifyN client¶

HiddifyN is Xray-based software. You should follow these steps to use this client:

1. Download the program. In the Desktop tab, open the section related to HiddifyN and click on the icon:

   

2. Install the SDK and then extract and run the downloaded HiddifyN file in the appropriate folder.

   

3. Add a new user profile to the application. To do this, go to the Hiddify control panel and press the Click to import button. This will automatically add the connection configuration to the PC client.

4. Choose the proxy mode.

   One of the key parts of HiddifyN is the proxy modes:

   • Auto. Automatic connection to the configuration with the highest speed (lowest ping).
   • Load Balance. Simultaneously connect to multiple configurations (traffic is distributed between them). This mode is useful for load balancing across multiple configurations simultaneously to achieve an acceptable speed.
   • Manual. Used for manual configuration. This mode allows you to perform advanced program settings.

5. Connect to the VPN by clicking the middle circular button. The software will connect to the configurations based on the chosen proxy mode, and the ping associated with the configuration will be displayed next to the button:

   

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

To connect to Hiddify 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. Follow these steps to add server data:

   • In the window displaying the QR code, click on Copy button and store the access link for third-party clients.

   

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

Android Mobile Devices¶

Connecting using HiddifyN¶

You can also use the HiddifyN client to connect to Hiddify from Android mobile devices. After clicking the link in the Hiddify control panel, you can either download the client directly from the link or use Google Play. After installing the application, choose the language and country. Then download the connection link and click on the Click to connect button:

You can also use a QR code to connect to the HiddifyN client. To do this, click on the button (number 1 on the image), then scan the QR code (number 3 on the image):

Here, you can also copy the link or open it directly on your local device (number 2 on the image). If there are any issues with scanning the QR code, you can use the copied link.

Connecting using Hiddify Next¶

To connect to the Hiddify 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. Follow these steps to add server data:

   • To obtain a QR code that will allow you to set up access to Hiddify, simply click on the Display QR Code button located in the QR Code field of the user control panel.

   

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

   

iOS Mobile Devices¶

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:

Alternative Clients¶

It is possible to use HiddifyClashAndroid, HiddifyClashDesktop.

Hiddify Update¶

To update the panel, go to the Actions tab and select Update. The system will be reinstalled in approximately five minutes.

!(./images/hiddify_0_9.png)

Restore administrator link using the console.¶

To obtain the administrator link, follow these steps:

1. To access the server, use ssh from a terminal or HTML5 console:

   ssh root@{You Server IP}
   

2. Execute the script by copying it into the console and pressing the Enter key.

   /opt/hiddify-manager/menu.sh
   

3. Select the Show admin link in the admin menu and press Enter.

   

4. Copy the link by highlighting it and using the keyboard shortcut Ctrl+C or Shift+Ins.

   

Hiddify. Key Features¶

• Quick installation;
• Multiple Xray and SingBox cores;
• Smart proxy (Hiddify and Clash clients);
• Automatic update and backup;
• Automatic connection to Cloudflare;
• Multiple domain usage;
• Automatic CDN IP configuration;
• Active configuration management;
• Multi-level admin rights;
• Unified SingBox panel with user-management feature;
• Time and traffic restrictions for each user;
• Telegram proxy using different libraries;
• DNS over HTTPS (DoH);
• User management via Telegram bot.

Features of the assembly¶

• Installation is possible on Ubuntu 20.04 and 22.04. The panel handles domains' certificate generation.
• Installation of Hiddify VPN panel without Docker in /opt;
• Installed software: - hiddify/hiddify-config;
• Route to application: - /opt/hiddify-config.
• The web interface will be available after installation in the personal account using a unique link.

Ordering a server with Hiddify 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=" \