### OVH Server Initial Setup with Cloud-Config

Source: https://github.com/hiddify/hiddify-manager/wiki/Quick-Installation-on-OVH-Servers

Use this cloud-config script to automatically upgrade packages, install necessary tools like curl and git, and execute the Hiddify installation script upon server boot. The generated link will be available at https://yourip.sslip.io/hiddify in one hour.

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

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

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 Speedtest CLI

Source: https://github.com/hiddify/hiddify-manager/wiki/How-to-do-speed-test-on-server

Install the speedtest script by downloading and executing the installation script, then installing the 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
```

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

### Hetzner Cloud-Init Configuration for Hiddify

Source: https://github.com/hiddify/hiddify-manager/wiki/Quick-installation-on-Hetzner-Servers

This cloud-config script automates the setup of Hiddify on a Hetzner server. It upgrades packages, installs necessary tools, and then downloads and executes the Hiddify installation script. The generated link for accessing the panel will be available via https://yourip.sslip.io/hiddify for one hour.

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

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

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 htop on Linux

Source: https://github.com/hiddify/hiddify-manager/wiki/How-to-monitor-server-resources-on-Hiddify

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

```bash
apt install htop
```

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

### Install Python Package

Source: https://github.com/hiddify/hiddify-manager/wiki/Guide-for-finding-a-clean-Cloudflare-IP

Install the 'requests' library required for the IP scanner. This is a prerequisite for running the script.

```bash
pip install requests
```

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

### Clone Repository and Start Hiddify with Docker

Source: https://github.com/hiddify/hiddify-manager/wiki/Install-Hiddify-using-Docker

Use these commands to clone the Hiddify repository, prepare the database file, and start the Docker containers. Note that the Docker version is experimental.

```bash
git clone https://github.com/hiddify/hiddify-config
cd hiddify-config
touch hiddify-panel/hiddifypanel.db
docker-compose up -d
```

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

### Cloud-init Configuration for Hiddify Manager

Source: https://github.com/hiddify/hiddify-manager/wiki/Cloud-init-installation

This cloud-init script automates the installation of Hiddify Manager. It upgrades packages, installs necessary dependencies, clones the Hiddify repository, and executes the installation script. Ensure your hosting supports cloud-config for this to work.

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

runcmd:
  - cd /opt
  - git clone https://github.com/hiddify/hiddify-config/
  - cd hiddify-config
 # uncomment it for using a special secret other wise it will be createed automatically
 # - echo "USER_SECRET=0123456789abcdef0123456789abcdef" >config.env
 # - echo "MAIN_DOMAIN=" >>config.env
  - echo "TELEGRAM_AD_TAG=" >>config.env
  - bash install.sh

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 http://yourip/ or https://yourip.sslip.io in one hour, after that, it will be disapear. 

```

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

### Combine Run and Stress Test

Source: https://github.com/hiddify/hiddify-manager/blob/dev/other/speedtest/README.md

You can combine multiple keywords, such as 'run' and 'stress', in a single request. This example starts an immediate speed test and runs it for 300 seconds in each direction.

```URL
http://192.168.1.5?run&stress=300
```

```URL
http://192.168.1.5?R&S=300
```

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

### Quick LXD Container Setup for Hiddify Manager

Source: https://github.com/hiddify/hiddify-manager/blob/dev/operations/lxd/README.md

Run these commands to clone the repository, navigate to the LXD directory, and set up the LXC container with Hiddify Manager.

```bash
git clone https://github.com/hiddify/Hiddify-Manager.git
cd Hiddify-Manager/operations/lxd
bash setup_lxc_container.sh
```

```bash
# After configuring your Hiddify Manager using the printed links:
bash utils/lxc_ports_to_host.sh
```

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

### Install Hiddify Manager Beta Version

Source: https://github.com/hiddify/hiddify-manager/wiki/How-to-install-different-versions-of-Hiddify-Manager

Use this command to install the beta version of Hiddify Manager, which includes new features and some bug fixes before the final release. Back up your panel beforehand.

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

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

### Install Python and Dependencies on Android via Termux

Source: https://github.com/hiddify/hiddify-manager/wiki/Guide-for-finding-a-clean-Cloudflare-IP

Install Python and essential packages on Android using Termux. Answer 'y' to all prompts during installation.

```bash
pkg update -y; pkg install -y python python-pip openssl python-cryptography
```

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

### Cloud-Init Configuration for Hiddify Manager Installation

Source: https://github.com/hiddify/hiddify-manager/wiki/Quick-installation-on-Vultr-Servers

This cloud-config script automates the installation of necessary packages and executes a bash script from a remote URL to set up the Hiddify Manager. Ensure you select Ubuntu 22.04 and enable Cloud-Init User-Data when creating your Vultr instance. The generated link will be available via https://yourip.sslip.io/hiddify for one hour after the server is up.

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

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

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 Scanner Prerequisites on Android

Source: https://github.com/hiddify/hiddify-manager/wiki/Guide-for-finding-a-clean-Cloudflare-IP

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 OpenSSH Client on Windows

Source: https://github.com/hiddify/hiddify-manager/wiki/How-to-connect-to-server-via-SSH

Use this command in an elevated PowerShell to install the OpenSSH client on Windows if it's not already present.

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

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

### Install Scanner Prerequisites on Windows

Source: https://github.com/hiddify/hiddify-manager/wiki/Guide-for-finding-a-clean-Cloudflare-IP

Use this command in the extracted scanner directory's Command Prompt to install necessary Python packages for Windows.

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

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

### Install Hiddify Manager Release Version

Source: https://github.com/hiddify/hiddify-manager/wiki/How-to-install-different-versions-of-Hiddify-Manager

Use this command to install the stable release version of Hiddify Manager. It is recommended to back up your panel before installation.

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

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

### Example SSH Connection with Custom Port

Source: https://github.com/hiddify/hiddify-manager/wiki/How-to-connect-to-server-via-SSH

An example of connecting to a server with a custom SSH port, specifying the IP address and port number.

```bash
ssh root@1.1.1.1 -p 2222
```

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

### Install DNS Utilities via SSH

Source: https://github.com/hiddify/hiddify-manager/wiki/How-to-set-DNS-server

If the 'nslookup' tool is not installed on your server, use this command to install the necessary DNS utilities. This is required for performing DNS leak tests.

```bash
sudo apt install dnsutils
```

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

### Using Custom Subdomains with Network Tags

Source: https://github.com/hiddify/hiddify-manager/wiki/Guide-for-using-mode-Auto_CDN_IP-on-Hiddify

This example shows how to use your own registered subdomains with corresponding network tags. This is an alternative to using the default `ircf.space` subdomains.

```text
mci.yourdomain.com MCI
mtn.yourdomain.com MTN
mkb.yourdomain.com MKB
```

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

### Start Speedtest Automatically

Source: https://github.com/hiddify/hiddify-manager/blob/dev/other/speedtest/README.md

Use the 'run' or 'r' URL parameter to automatically start a speed test. You can optionally specify a delay in seconds.

```URL
http://192.168.1.5?run
```

```URL
http://192.168.1.5?run=10
```

```URL
http://192.168.1.5?r=10
```

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

### Download Dev Version with Docker

Source: https://github.com/hiddify/hiddify-manager/blob/dev/HISTORY.md

Clones the project, builds it, and deploys using Docker Compose if the environment is 'dev' or 'development'. Otherwise, it uses the default installation method.

```bash
# If it's dev or development, clone the project, build it and deploy it using docker compose. else, use the default way. [tesla]
```

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

### Install Hiddify Manager Develop Version

Source: https://github.com/hiddify/hiddify-manager/wiki/How-to-install-different-versions-of-Hiddify-Manager

Use this command to install the develop version of Hiddify Manager, which contains the latest features but may have bugs. It is best suited for test servers. Ensure you have a backup.

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

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

### Example IPv6 Address

Source: https://github.com/hiddify/hiddify-manager/wiki/Basic-Concepts

Demonstrates the standard format of an IPv6 address, using hexadecimal numbers separated by colons.

```text
2017:c569:54ed:f141:ec49:0567
```

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

### Example IPv4 Address

Source: https://github.com/hiddify/hiddify-manager/wiki/Basic-Concepts

Illustrates the format of an IPv4 address, consisting of four sections separated by dots.

```text
54.78.11.14
```

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

### Vless + WS + TLS Configuration Example

Source: https://github.com/hiddify/hiddify-manager/wiki/Guide-for-finding-a-clean-Cloudflare-IP

This JSON configuration template is for a Vless protocol with WebSocket and TLS stream settings. It specifies inbound SOCKS settings and outbound Vless proxy details.

```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": {}
}
```

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

### Run the Cloudflare IP Scanner

Source: https://github.com/hiddify/hiddify-manager/wiki/Guide-for-finding-a-clean-Cloudflare-IP

Execute the main Python script to start the IP scanning process. The script will prompt for scan parameters.

```python
python main.py
```

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

### Install a Specific Hiddify Manager Version

Source: https://github.com/hiddify/hiddify-manager/wiki/How-to-install-different-versions-of-Hiddify-Manager

Install a specific version of Hiddify Manager by replacing 'VERSION' with the desired version number in the URL. For example, to install version 8, use the provided command.

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

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

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

### Run htop for Resource Monitoring

Source: https://github.com/hiddify/hiddify-manager/wiki/How-to-monitor-server-resources-on-Hiddify

Launch the htop interactive process viewer to monitor CPU and RAM usage per process. Press 'q' or 'ctrl+c' to exit.

```bash
htop
```

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

### Fix HAProxy Installation on Ubuntu

Source: https://github.com/hiddify/hiddify-manager/blob/dev/HISTORY.md

Adjusts the HAProxy installation process to be compatible with different Ubuntu versions.

```bash
# Fix installation of haproxy based on ubuntu version. [tesla]
```

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

### Run Benchmarking Tool

Source: https://github.com/hiddify/hiddify-manager/wiki/How-to-do-speed-test-on-server

Use the bench.sh tool to perform speed tests from multiple locations and view server hardware specifications.

```bash
wget -qO- bench.sh | bash
```

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

### List Backup Files on Server

Source: https://github.com/hiddify/hiddify-manager/wiki/How-to-transfer-files-between-a-server-and-a-computer

After SSHing into your server, use this command to view the list of available backup files in the specified directory.

```bash
ls /opt/hiddify-config/hiddify-panel/backup
```

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

### Run Speedtest

Source: https://github.com/hiddify/hiddify-manager/wiki/How-to-do-speed-test-on-server

Execute the speedtest command to perform a bandwidth test on your server. You may need to accept terms and conditions on the first run.

```bash
speedtest
```

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

### Connect to Server via SSH (Default Port)

Source: https://github.com/hiddify/hiddify-manager/wiki/How-to-connect-to-server-via-SSH

Connect to your server using the default SSH port. Replace 'root' with your username and '<IP_Address>' with your server's IP.

```bash
ssh root@<IP_Address>
```

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

### Automatic Test Start Configuration

Source: https://github.com/hiddify/hiddify-manager/blob/dev/other/speedtest/index.html

Controls whether a speed test starts automatically upon page load. The test can be delayed by specifying a number of seconds using the 'Run' or 'R' URL parameter.

```javascript
var enableRun = true;
```

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

### Connect to Server via SSH (Custom Port)

Source: https://github.com/hiddify/hiddify-manager/wiki/How-to-connect-to-server-via-SSH

Connect to your server using a custom SSH port. Replace 'root' with your username, '<IP_Address>' with your server's IP, and '<port_number>' with your custom port.

```bash
ssh root@<IP_Address> -p <port_number>
```

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

### Select Test Type (Download, Upload, Ping)

Source: https://github.com/hiddify/hiddify-manager/blob/dev/other/speedtest/README.md

Choose a specific test type (download, upload, or ping) using the 'Test' or 't' URL parameter. 'u' is for upload, 'd' for download, and 'p' for ping.

```URL
http://192.168.1.5?Test=upload
```

```URL
http://192.168.1.5?t=u
```

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

### Clone CFScanner Repository

Source: https://github.com/hiddify/hiddify-manager/wiki/Guide-for-finding-a-clean-Cloudflare-IP

Use this command to download the CFScanner program files from GitHub. Ensure you have Git installed.

```bash
git clone https://github.com/MortezaBashsiz/CFScanner.git
```

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

### Reduced IPv6 Address Example

Source: https://github.com/hiddify/hiddify-manager/wiki/Basic-Concepts

Shows a compressed representation of an IPv6 address where consecutive zero sections are omitted.

```text
2017:c569::0567
```

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

### Remove Old Speedtest CLI

Source: https://github.com/hiddify/hiddify-manager/wiki/How-to-do-speed-test-on-server

Before installing the new speedtest script, remove any old versions of speedtest-cli to avoid conflicts.

```bash
sudo apt-get remove speedtest-cli
```

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

### Restore iptables Rules

Source: https://github.com/hiddify/hiddify-manager/wiki/How-to-change-SSH-port-on-your-server

Restore `iptables` rules from a saved file. This command is useful for applying saved rules, for example, after a reboot.

```bash
sudo sh -c 'iptables-restore < /etc/iptables/rules.v4'
```