Hiddify

https://hiddify.com
Admin
Hiddify is an open-source, multi-platform VPN and proxy tool-chain designed to bypass internet...
Tokens:105,755
Snippets:1,053
Trust Score:8.3
Update:1 day ago
Show doc for...
Tokens:
Raw
### Cloud-init script for Hiddify installation on Hetzner

Source: https://hiddify.com/manager/installation-and-setup/Quick-installation-on-Hetzner-Servers/

Use this cloud-init script when creating a new Hetzner server to automatically install Hiddify. It upgrades packages, installs required dependencies, and runs the Hiddify installation command. The generated setup link is available at https://yourip.sslip.io/hiddify for one hour after installation.

```yaml
#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 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 install the relay setup. It will prompt for the main server's IP address.

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

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

### Install htop on Linux server

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

Use this command to install htop if it is not already installed. It is typically pre-installed on Ubuntu 20.04 and 22.04.

```bash
apt install htop
```

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

### Enable and start HiddifyCli service

Source: https://hiddify.com/app/How-to-use-HiddifyCli-on-OpenWrt/

Enables the HiddifyCli service to start at boot and starts it immediately.

```bash
service HiddifyCli enable  
service HiddifyCli start  
```

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

### Install Beta version

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

Run this command to install the beta version of Hiddify Manager, which includes new features but may have some bugs. Backup is recommended before installation.

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

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

### Install git on Fedora

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

Install git on Fedora using dnf.

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

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

### Install git on Arch

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

Install git on Arch using pacman.

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

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

### Install beta version

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

Run this command to install the beta version of HiddifyManager using Docker. The script automatically installs Docker if needed.

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

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

### Clash format example

Source: https://hiddify.com/app/URL-Scheme/

Example of importing a clash subscription link.

```plaintext
hiddify://import/https://raw.githubusercontent.com/yebekhe/TelegramV2rayCollector/d6ce7b907eeb58abf503c283af192e7bc915d143/clash/mix.yml

```

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

### Singbox format example

Source: https://hiddify.com/app/URL-Scheme/

Example of importing a singbox subscription link.

```plaintext
hiddify://import/https://raw.githubusercontent.com/yebekhe/TelegramV2rayCollector/fe3637db4ece53e56ac99ea09dbefa34466f280f/singbox/sfasfi/mixLite.json

```

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

### Install git on Debian/Ubuntu

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

Install git on Debian/Ubuntu distributions using apt-get.

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

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

### Install FragmentScanner script

Source: https://hiddify.com/manager/basic-concepts-and-troubleshooting/A-good-way-to-find-TLS-trick-values/

Run this command on your VPS or Termux to install the FragmentScanner script. After installation, you'll be presented with options: 'config to fragment', 'fragment scanner', and 'exit'.

```bash
bash <(curl -fsSL https://raw.githubusercontent.com/Ptechgithub/FragmentScanner/main/install.sh)
```

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

### Start and enable GOST service

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

Starts the GOST service and enables it to run automatically on system reboot.

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

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

### Import X-UI database with example path

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

Example command when the database file is in the root/ folder. Replace </root/file.db> with the actual path.

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

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

### Import X-UI database with placeholder path

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

Use this command to import the X-UI panel database file. Replace /path/to/db/file.db with the actual path to the database file.

```bash
cd /opt/hiddify-manager/hiddify-panel/&&hiddifypanel xui-importer -x /path/to/db/file.db
```

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

### Authentication Example with curl

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

Use this curl command to authenticate with the Hiddify Manager API v2 by sending a GET request to the panel version endpoint with the Hiddify-API-Key header. Replace YOUR_ADMIN_UUID with your actual admin UUID.

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

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

### Install exact version 10.7.0

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

From version 10, you can install an exact specific update. This command installs version 10.7.0.

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

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

### Install OpenSSH Client in Windows PowerShell

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 SSH is not installed. It installs the OpenSSH.Client capability.

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

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

### Open htop to monitor resources

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

Run this command to launch htop, which displays CPU and RAM usage per process. Sort by CPU or MEM by clicking the respective column headers.

```bash
htop
```

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

### Example: Transfer backup file from server to Windows

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

Example command to copy a backup file from the server to the Backup folder on the C drive of a Windows system.

```bash
scp root@1.1.1.1:/opt/Hiddify-Manager/hiddify-panel/backup/2023_05_06__06_00_03.json "C:\Backup"\
```

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

### Enable and start wstunnel service on main server

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

Reload systemd, enable and start the wstunnel service on the main server. Run these commands after creating the service file.

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

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

### Install Hiddify on Ubuntu

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

Run this command in your terminal to install Hiddify. It downloads and executes the installation script from i.hiddify.com. This is tested only on Ubuntu 22.04.

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

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

### Install development version

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

Run this command to install the development version of HiddifyManager using Docker. The script automatically installs Docker if needed.

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

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

### Enter scanner folder and install prerequisites on Android

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

After downloading, change into the scanner directory and install the required Python packages.

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

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

### Install stable version

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

Run this command to install the stable version of HiddifyManager using Docker. The script automatically installs Docker if needed.

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

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

### Install Develop version

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

Run this command to install the development version of Hiddify Manager, which contains the latest features but may be unstable. Backup is recommended before installation.

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

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

### Enable Swap

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

Activates the swap file. After running this, verify with 'sudo swapon --show'.

```bash
sudo swapon /swapfile
```

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

### Example CFScanner command

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

Example command using 8 threads, 1 try count, config.real, speed 100, and custom.subnets.

```bash
bash cfScanner.sh SUBNET DOWN 8 1 config.real 100 custom.subnets
```

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

### Run Xray with server config

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

Starts a temporary Xray server using the downloaded server_config.json.

```bash
xray run -c server_config.json
```

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

### Navigate to root directory

Source: https://hiddify.com/manager/basic-concepts-and-troubleshooting/How-to-address-VPS-abuse-issue/

Change to the root directory before running the installation command.

```bash
cd /
```

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

### Create init script for HiddifyCli service

Source: https://hiddify.com/app/How-to-use-HiddifyCli-on-OpenWrt/

Creates an empty init script file at /etc/init.d/HiddifyCli to be filled with service configuration.

```bash
touch /etc/init.d/HiddifyCli  
```

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

### 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 on the relay server to download and execute the Hiddify Relay Builder installation script. After installation, you can choose one of the tunnel methods from the main menu.

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

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

### Enable and start redsocks service

Source: https://hiddify.com/app/How-to-Enable-Free-Internet-Access-for-Clients-Behind-an-OpenWrt-Router-Using-HiddifyCli/

Enables and starts the redsocks service to begin proxying traffic.

```shell
service redsocks enable
service redsocks start
```
Tokens:
Raw