Hiddify Manager

https://hiddify.com/manager/
Admin
Hiddify Manager is an application for server installation to create a VPN server that supports...
Tokens:74,859
Snippets:1,205
Trust Score:8.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install Speedtest Script

Source: https://hiddify.com/manager/basic-concepts-and-troubleshooting/How-to-do-speed-test-on-server

Installs the necessary curl utility, adds the Ookla speedtest-cli repository, and installs the speedtest package.

```bash
sudo apt-get install curl
curl -s https://packagecloud.io/install/repositories/ookla/speedtest-cli/script.deb.sh | sudo bash
sudo apt-get install speedtest
```

--------------------------------

### Cloud-init Script for Hiddify Manager Installation

Source: https://hiddify.com/manager/installation-and-setup/Cloud-init-installation

This script installs necessary packages and downloads/executes the Hiddify Manager setup script. It is designed to be pasted into the cloud-config field of your hosting provider.

```cloud-config
#cloud-config
package_upgrade: true
packages:
  - apt-transport-https
  - ca-certificates
  - curl
  - wget
  - gnupg-agent
  - software-properties-common
  - git
  - jq

runcmd:
  - cd /opt
  - bash -c "export CREATE_EASYSETUP_LINK='true';curl i.hiddify.com/release|bash -s -- --no-gui"

final_message: "The system is finally up, after $UPTIME seconds"
output: { all: "| tee -a /root/cloud-init-output.log" }

# you can see the generated link from the website by using 
# https://yourip.sslip.io/hiddify in one hour, after that,
# it will be disappear.

```

--------------------------------

### Install Beta Version of Hiddify Manager

Source: https://hiddify.com/manager/installation-and-setup/How-to-install-different-versions-of-Hiddify-Manager

Use this command to install the beta version of Hiddify Manager. This version is pre-release and may contain bugs. Back up your panel before installation.

```bash
bash <(curl https://i.hiddify.com/beta)
```

--------------------------------

### Install Speedtest Script

Source: https://hiddify.com/manager/basic-concepts-and-troubleshooting/How-to-do-speed-test-on-server?q=

Installs the speedtest script by first ensuring curl is present, then adding the Ookla repository and finally installing the speedtest package.

```bash
sudo apt-get install curl
curl -s https://packagecloud.io/install/repositories/ookla/speedtest-cli/script.deb.sh | sudo bash
sudo apt-get install speedtest

```

--------------------------------

### Install HAProxy

Source: https://hiddify.com/manager/domain-worker-cdn-and-tunneling/Tutorial-for-setting-up-HA-Proxy-tunnel-as-relay-server?q=

Installs the HAProxy package on Ubuntu 22.04.

```bash
sudo apt-get install haproxy
```

--------------------------------

### API Authentication Example

Source: https://hiddify.com/manager/contribution/How-to-use-API-in-HiddifyManager-project?q=

Example of how to authenticate API requests using curl with an API key.

```bash
curl -X GET "https://domain.com/admin_proxy_path/api/v2/panel/version" \
-H "Hiddify-API-Key: YOUR_ADMIN_UUID"
```

--------------------------------

### Install Relay Server Script

Source: https://hiddify.com/manager/domain-worker-cdn-and-tunneling/Tutorial-for-setting-up-IP-Tables-tunnel-as-relay-server

Run this command on the relay server to initiate the installation. You will be prompted to enter the main server's IP address.

```bash
bash <(curl https://gist.githubusercontent.com/hiddify-com/63836c9a158eca29bad6c941610028cf/raw/0e4e2138148ab9d3d678723fd904b1cad461ce62/relay.sh)
```

--------------------------------

### Install Git on Fedora

Source: https://hiddify.com/manager/contribution/How-to-contribute-to-this-project

Install the git-all package on Fedora Linux using the dnf package manager.

```bash
dnf install git-all
```

--------------------------------

### Install OpenSSH Client on Windows

Source: https://hiddify.com/manager/basic-concepts-and-troubleshooting/How-to-transfer-files-between-a-server-and-a-computer?q=

Run this command in PowerShell to install the OpenSSH client if it's not already installed on your Windows machine.

```powershell
Add-WindowsCapability -Online -Name OpenSSH.Client
```

--------------------------------

### Install htop on Linux

Source: https://hiddify.com/manager/basic-concepts-and-troubleshooting/How-to-monitor-server-resources-on-Hiddify

Install the htop utility on your Linux server if it's not already present. This tool is usually pre-installed on Ubuntu 20.04 and 22.04.

```bash
apt install htop
```

--------------------------------

### Install Hiddify Relay Builder

Source: https://hiddify.com/manager/domain-worker-cdn-and-tunneling/How-to-setup-relay-server-using-Hiddify-Relay-Builder

Run this command to install and set up the Hiddify Relay Builder application on your relay server.

```bash
bash -c "$(curl -L https://raw.githubusercontent.com/hiddify/hiddify-relay/main/install.sh)"
```

--------------------------------

### View Install Logs

Source: https://hiddify.com/manager/configuration-and-advanced-settings/How-to-connect-and-troubleshoot-via-SSH?q=

Displays the installation logs for the Hiddify panel. This is useful for troubleshooting installation-related issues.

```bash
install-log
```

--------------------------------

### Install Git on Arch Linux

Source: https://hiddify.com/manager/contribution/How-to-contribute-to-this-project

Install the git-all package on Arch Linux using the pacman package manager.

```bash
pacman -Syu git-all
```

--------------------------------

### Install via Graphical Menu

Source: https://hiddify.com/manager/installation-and-setup/How-to-install-different-versions-of-Hiddify-Manager

Run this command to display a graphical menu for selecting and installing desired Hiddify Manager versions. Back up your panel before installation.

```bash
bash <(curl https://i.hiddify.com/custom)
```

--------------------------------

### Install Git on Debian/Ubuntu

Source: https://hiddify.com/manager/contribution/How-to-contribute-to-this-project

Install the git-all package on Debian-based Linux distributions like Ubuntu.

```bash
sudo apt-get install git-all
```

--------------------------------

### Reload systemd, Enable and Start wstunnel Service

Source: https://hiddify.com/manager/domain-worker-cdn-and-tunneling/Tutorial-for-setting-up-WST-tunnel-as-relay-server

Apply systemd configuration changes, enable the wstunnel service to start on boot, and start the service immediately. These commands ensure the tunnel is managed by systemd.

```bash
sudo systemctl daemon-reload
sudo systemctl enable wstunnel.service
sudo systemctl start wstunnel.service

```

--------------------------------

### Install HA-Proxy

Source: https://hiddify.com/manager/domain-worker-cdn-and-tunneling/Tutorial-for-setting-up-HA-Proxy-tunnel-as-relay-server

Installs the HA-Proxy package on Ubuntu 22.04 using apt-get.

```bash
sudo apt-get install haproxy

```

--------------------------------

### Install Python Requests Library

Source: https://hiddify.com/manager/domain-worker-cdn-and-tunneling/Guide-for-finding-a-clean-Cloudflare-IP?q=

Install the 'requests' library for Python, a prerequisite for Vahid Farid's scanner.

```bash
pip install requests

```

--------------------------------

### Install Xray Kernel

Source: https://hiddify.com/manager/domain-worker-cdn-and-tunneling/Tutorial-for-setting-up-Dokodemo-Door-tunnel-as-relay-server

Installs the Xray kernel on the relay server using a bash script. This is the first step in setting up the tunnel.

```bash
sudo bash -c "$(curl -L https://github.com/XTLS/Xray-install/raw/main/install-release.sh)" @ install

```

--------------------------------

### Install Safa Safarian's Scanner Prerequisites on Android

Source: https://hiddify.com/manager/domain-worker-cdn-and-tunneling/Guide-for-finding-a-clean-Cloudflare-IP?q=

Navigate to the extracted scanner directory and install its Python dependencies using pip.

```bash
cd ss-cloud-scanner-main
pip install -r ./requirements.txt

```

--------------------------------

### Install WARP Service on Hiddify

Source: https://hiddify.com/manager/configuration-and-advanced-settings/How-to-activate-WARP-on-the-Hiddify-panel?q=

SSH into your server and run this command to install the WARP service. Ensure you exit the Hiddify menu first.

```bash
cd /opt/hiddify-manager/other/warp/wireguard && bash install.sh

```

--------------------------------

### Example Reality Configuration Link

Source: https://hiddify.com/manager/configuration-and-advanced-settings/How-to-use-Hiddify-Reality-Scanner

An example of a vLess Reality configuration link that can be used with the scanner. Replace SERVER_IP with your server's IP address.

```text
vless://hiddify@SERVER_IP:11443/?fp=chrome&security=reality&pbk=Z84J2IelR9ch3k8VtlVhhs5ycBUlXA7wHBWcBrjqnAw&sid=6ba85179e30d4fc2&sni=www.yahoo.com&type=tcp&flow=xtls-rprx-vision&encryption=none#Hiddify
```

--------------------------------

### Start and Enable GOST Service

Source: https://hiddify.com/manager/domain-worker-cdn-and-tunneling/Tutorial-for-setting-up-GOST-tunnel-as-relay-server?q=

Starts the GOST service immediately and enables it to run automatically on system boot. This activates the configured GOST tunnel.

```bash
sudo systemctl start gost && systemctl enable gost
```

--------------------------------

### Vless+WS+TLS Configuration Example

Source: https://hiddify.com/manager/domain-worker-cdn-and-tunneling/Guide-for-finding-a-clean-Cloudflare-IP

This JSON configuration is an example template for setting up Vless with WebSocket (WS) and TLS. It includes inbound and outbound settings for a proxy server.

```json
{
"inbounds": [{
    "port": "PORTPORT", 
    "listen": "127.0.0.1",
    "tag": "socks-inbound",
    "protocol": "socks",
    "settings": {
      "auth": "noauth",
      "udp": false,
      "ip": "127.0.0.1"
    },
    "sniffing": {
      "enabled": true,
      "destOverride": ["http", "tls"]
    }
  }],
  "outbounds": [
    {
      "tag": "proxy",
      "protocol": "vless",
      "settings": {
        "vnext": [{
        "address": "IP.IP.IP.IP", 
        "port": xxxxx,
        "users": [{"id": "xxxxx",
        "encryption": "none"
            }]
      }]
      },
      "streamSettings": {
        "network": "ws",
        "security": "tls",
        "tlsSettings": {
          "allowInsecure": false,
          "serverName": "xxxxx",
          "alpn": [
            "http/1.1"
          ],
          "fingerprint": "chrome"
        },
        "wsSettings": {
          "path": "xxxxx",
          "headers": {
            "Host": "xxxxx"
          }
        }
      }
    }
  ],
    "other": {}
}
```

--------------------------------

### Install a Specific Major Version (e.g., v8)

Source: https://hiddify.com/manager/installation-and-setup/How-to-install-different-versions-of-Hiddify-Manager

Install the latest update for a specific major version, such as version 8. Back up your panel before running this command.

```bash
bash <(curl https://i.hiddify.com/v8)
```

--------------------------------

### Install Custom Xray Core

Source: https://hiddify.com/manager/configuration-and-advanced-settings/How-to-use-Hiddify-Reality-Scanner?q=

Installs or updates the Hiddify custom Xray core on the server. Ensure to stop the Hiddify Xray service before installation and start it afterward if you are using Hiddify Manager or Panel.

```bash
# remove old xray
bash -c "$(curl -L https://github.com/XTLS/Xray-install/raw/main/install-release.sh)" @ remove

#only if you have hiddify manager and hiddify panel
systemctl stop hiddify-xray

# install hiddify custom xray
bash -c "$(curl -L https://github.com/hiddify/Xray-core-custom/raw/main/install-release.sh)" @ install

#only if you have hiddify manager and hiddify panel
systemctl start hiddify-xray

```

--------------------------------

### Import X-UI Panel Database (Example with root path)

Source: https://hiddify.com/manager/configuration-and-advanced-settings/how-to-import-xui-to-hiddifymanager?q=

An example of the import command when the database file is located in the root directory. Ensure the path `</root/file.db>` correctly points to your database file.

```bash
cd /opt/hiddify-manager/hiddify-panel/&&hiddifypanel xui-importer -x </root/file.db>

```

--------------------------------

### Install HiddifyManager Beta Version via Docker

Source: https://hiddify.com/manager/installation-and-setup/Install-Hiddify-using-Docker

Use this command to install the beta version of HiddifyManager via Docker. The script automates Docker setup.

```bash
bash <(curl https://i.hiddify.com/docker/beta)
```

--------------------------------

### Create Server Configuration

Source: https://hiddify.com/manager/configuration-and-advanced-settings/How-to-use-Hiddify-Reality-Scanner?q=

Downloads a server configuration file and prints example Reality vLess links for IPv6 and IPv4. These links can be used to set up a temporary Xray server.

```bash
curl -o server_config.json https://raw.githubusercontent.com/hiddify/Hiddify_Reality_Scanner/main/server_config.json

echo "---------------IPV6---------"
echo "vless://hiddify@$(curl -6 ip.sb):11443/?fp=chrome&security=reality&pbk=Z84J2IelR9ch3k8VtlVhhs5ycBUlXA7wHBWcBrjqnAw&sid=6ba85179e30d4fc2&sni=www.google.com&type=tcp&flow=xtls-rprx-vision&encryption=none#Hiddify"

echo "---------------IPV4---------"
echo "vless://hiddify@$(curl -4 ip.sb):11443/?fp=chrome&security=reality&pbk=Z84J2IelR9ch3k8VtlVhhs5ycBUlXA7wHBWcBrjqnAw&sid=6ba85179e30d4fc2&sni=www.google.com&type=tcp&flow=xtls-rprx-vision&encryption=none#Hiddify"

```

--------------------------------

### Prepare CFScanner Binaries and Configuration

Source: https://hiddify.com/manager/domain-worker-cdn-and-tunneling/Guide-for-finding-a-clean-Cloudflare-IP

Navigate to the CFScanner directory, make the binary files executable, and download the client configuration file. This prepares the tool for execution on Linux.

```bash
cd CFScanner/bash
chmod +x ../bin/*

```

```bash
curl -s https://raw.githubusercontent.com/MortezaBashsiz/CFScanner/main/bash/ClientConfig.json -o config.real

```

--------------------------------

### Open sysctl.conf with nano

Source: https://hiddify.com/manager/basic-concepts-and-troubleshooting/How-to-disable-IP-version-6-on-Hiddify?q=

Connect to your server via SSH and use nano to open the system settings file for editing.

```bash
sudo nano /etc/sysctl.conf
```

--------------------------------

### Install Hiddify Custom Xray Core

Source: https://hiddify.com/manager/configuration-and-advanced-settings/How-to-use-Hiddify-Reality-Scanner

Installs the Hiddify custom Xray core on the server. This command first removes any old Xray installation and then installs the custom version. It's recommended for users with Hiddify Manager and Hiddify Panel.

```bash
# remove old xray
bash -c "$(curl -L https://github.com/XTLS/Xray-install/raw/main/install-release.sh)" @ remove

#only if you have hiddify manager and hiddify panel
systemctl stop hiddify-xray

# install hiddify custom xray
bash -c "$(curl -L https://github.com/hiddify/Xray-core-custom/raw/main/install-release.sh)" @ install

#only if you have hiddify manager and hiddify panel
systemctl start hiddify-xray
```

--------------------------------

### Create a Swap File (2GB Example)

Source: https://hiddify.com/manager/basic-concepts-and-troubleshooting/How-to-enable-Swap-on-Linux

This command creates a new 2GB Swap file. If `fallocate` is not supported, an alternative `dd` command is provided.

```bash
sudo fallocate -l 2G /swapfile

```

```bash
sudo dd if=/dev/zero of=/swapfile bs=1M count=2048

```

--------------------------------

### Create Server Configuration

Source: https://hiddify.com/manager/configuration-and-advanced-settings/How-to-use-Hiddify-Reality-Scanner

Downloads a server configuration file and prints example vLess Reality configuration strings for IPv6 and IPv4. These commands are used to set up the server for the Reality Scanner.

```bash
curl -o server_config.json https://raw.githubusercontent.com/hiddify/Hiddify_Reality_Scanner/main/server_config.json

echo "---------------IPV6---------"
echo "vless://hiddify@$(curl -6 ip.sb):11443/?fp=chrome&security=reality&pbk=Z84J2IelR9ch3k8VtlVhhs5ycBUlXA7wHBWcBrjqnAw&sid=6ba85179e30d4fc2&sni=www.google.com&type=tcp&flow=xtls-rprx-vision&encryption=none#Hiddify"

echo "---------------IPV4---------"
echo "vless://hiddify@$(curl -4 ip.sb):11443/?fp=chrome&security=reality&pbk=Z84J2IelR9ch3k8VtlVhhs5ycBUlXA7wHBWcBrjqnAw&sid=6ba85179e30d4fc2&sni=www.google.com&type=tcp&flow=xtls-rprx-vision&encryption=none#Hiddify"
```

--------------------------------

### Create a Swap File (Recommended)

Source: https://hiddify.com/manager/basic-concepts-and-troubleshooting/How-to-enable-Swap-on-Linux?q=

This command creates a new swap file of a specified size (e.g., 2GB). It's a quick way to allocate space for swap.

```bash
sudo fallocate -l 2G /swapfile
```

--------------------------------

### Install HiddifyManager Development Version via Docker

Source: https://hiddify.com/manager/installation-and-setup/Install-Hiddify-using-Docker

Execute this command to install the development version of HiddifyManager using Docker. Docker will be installed automatically if not present.

```bash
bash <(curl https://i.hiddify.com/docker/dev)
```

--------------------------------

### Install Hiddify Reality Scanner Client

Source: https://hiddify.com/manager/configuration-and-advanced-settings/How-to-use-Hiddify-Reality-Scanner

Installs the Hiddify Reality Scanner client-side tool using pip. Ensure Python is installed before running this command.

```bash
pip install -U hiddify_reality_scanner
```

--------------------------------

### Install Prerequisites for Safa Safarian's Scanner (Windows)

Source: https://hiddify.com/manager/domain-worker-cdn-and-tunneling/Guide-for-finding-a-clean-Cloudflare-IP?q=

Install necessary Python packages for Safa Safarian's scanner on Windows using a requirements file.

```bash
pip install -r ./requirements.txt

```

--------------------------------

### Enable Swap

Source: https://hiddify.com/manager/basic-concepts-and-troubleshooting/How-to-enable-Swap-on-Linux

Activate the newly configured Swap file. After running this, you should verify the status again.

```bash
sudo swapon /swapfile

```

--------------------------------

### Install Release Version of Hiddify Manager

Source: https://hiddify.com/manager/installation-and-setup/How-to-install-different-versions-of-Hiddify-Manager

Run this command to install the stable release version of Hiddify Manager. Ensure you have backed up your panel if a previous version was installed.

```bash
bash <(curl https://i.hiddify.com/release)
```

--------------------------------

### Install a Specific Major Version of Hiddify Manager

Source: https://hiddify.com/manager/installation-and-setup/How-to-install-different-versions-of-Hiddify-Manager?q=

Install a specific major version (e.g., version 8) by replacing VERSION with the desired number. Backup your data before installation.

```bash
bash <(curl https://i.hiddify.com/vVERSION)
```

```bash
bash <(curl https://i.hiddify.com/v8)
```

--------------------------------

### Install HiddifyManager Stable Version via Docker

Source: https://hiddify.com/manager/installation-and-setup/Install-Hiddify-using-Docker

Run this command to install the latest stable version of HiddifyManager using Docker. The script will automatically handle Docker installation if needed.

```bash
bash <(curl https://i.hiddify.com/docker/latest)
```

--------------------------------

### Configure File as Swap

Source: https://hiddify.com/manager/basic-concepts-and-troubleshooting/How-to-enable-Swap-on-Linux

Prepare the created file to be used as Swap memory with this command.

```bash
sudo mkswap /swapfile

```

--------------------------------

### Example Reality vLess Link

Source: https://hiddify.com/manager/configuration-and-advanced-settings/How-to-use-Hiddify-Reality-Scanner?q=

An example of a Reality vLess configuration link. Replace SERVER_IP with your server's IP address and adjust SNI as needed.

```bash
vless://hiddify@SERVER_IP:11443/?fp=chrome&security=reality&pbk=Z84J2IelR9ch3k8VtlVhhs5ycBUlXA7wHBWcBrjqnAw&sid=6ba85179e30d4fc2&sni=www.yahoo.com&type=tcp&flow=xtls-rprx-vision&encryption=none#Hiddify

```

--------------------------------

### Install iproute2 on Relay Server

Source: https://hiddify.com/manager/domain-worker-cdn-and-tunneling/Tutorial-for-setting-up-local-IPv6

Installs the iproute2 package, which is required for network configuration.

```bash
sudo apt-get install iproute2

```

--------------------------------

### Install a Specific Minor Version (e.g., v10.7.0)

Source: https://hiddify.com/manager/installation-and-setup/How-to-install-different-versions-of-Hiddify-Manager

Install an exact update for versions 10 and above, like version 10.7.0. Ensure your panel is backed up prior to execution.

```bash
bash <(curl https://i.hiddify.com/v10.7.0)
```

--------------------------------

### Install Specific HiddifyManager Version via Docker

Source: https://hiddify.com/manager/installation-and-setup/Install-Hiddify-using-Docker

Run this command to install a specific version of HiddifyManager using Docker. Replace 'v10.80.0' with the desired version number. The script handles Docker installation.

```bash
bash <(curl https://i.hiddify.com/docker/v10.80.0)
```

--------------------------------

### Create a Swap File (Alternative)

Source: https://hiddify.com/manager/basic-concepts-and-troubleshooting/How-to-enable-Swap-on-Linux?q=

If `fallocate` is not supported, this command can be used to create a swap file by writing zeros to it. It achieves the same result but may be slower.

```bash
sudo dd if=/dev/zero of=/swapfile bs=1M count=2048
```

--------------------------------

### Install OpenSSH Client on Windows

Source: https://hiddify.com/manager/basic-concepts-and-troubleshooting/How-to-transfer-files-between-a-server-and-a-computer

Run this command in PowerShell on Windows if the SSH client is not installed.

```powershell
Add-WindowsCapability -Online -Name OpenSSH.Client

```

--------------------------------

### Run Speedtest

Source: https://hiddify.com/manager/basic-concepts-and-troubleshooting/How-to-do-speed-test-on-server?q=

Execute the installed speedtest script to perform a bandwidth test on your server. You will be prompted to accept terms and conditions on the first run.

```bash
speedtest

```

--------------------------------

### Example SSH Connection with Custom Port

Source: https://hiddify.com/manager/installation-and-setup/How-to-connect-to-server-via-SSH

An example of connecting to a server with IP 1.1.1.1 on port 2222.

```bash
ssh root@1.1.1.1 -p 2222
```
Tokens:
Raw