Skip to content

Deployment Overview of Hiddify on Server

Prerequisites and Basic Requirements

To ensure a successful deployment, the server must meet the following requirements:

  • Operating System: Ubuntu (recommended).

  • Privileges: Root or sudo access is required for package installation and script execution.

  • Network Ports:

  • Port 443 (HTTPS) must be open to allow external traffic.

  • Dependencies: The system requires curl, unzip, and pip.

FQDN of the final panel on the hostkey.in domain

The application uses a specific domain template for its web interface:

Parameter Value
Prefix hiddify
Domain hostkey.in
Full template hiddify{Server_ID_from_Invapi}.hostkey.in

File and Directory Structure

The following directories are used for configuration, scripts, and SSL management:

  • /root/nginx/: Contains the Docker Compose configuration for the Nginx proxy.

  • /root/download.sh: The installation script downloaded from the official repository.

  • /data/nginx/user_conf.d/: Stores the Nginx user configuration files.

  • /data/nginx/nginx-certbot.env: Environment file containing SSL certificate settings.

Application installation process

The installation is performed using a combination of system package management and an official installation script:

  1. System Preparation: The system updates its package lists and installs curl, unzip, and pip.

  2. Environment Setup: The pip utility is upgraded, and the pyopenssl library is installed to support secure communications.

  3. Package Maintenance: All existing system packages are upgraded to their latest versions, and unused packages are purged to ensure a clean environment.

  4. Script Acquisition: The official Hiddify installation script (download.sh) is downloaded from the official GitHub repository to /root/.

  5. Core Installation: The installation script is executed with the following command:

    /bin/bash /root/download.sh release --no-gui
    

Access Rights and Security

  • Firewall: Port 443 must be accessible to allow HTTPS traffic.

  • User Privileges: The installation process requires root access to manage system packages and Docker containers.

  • SSL Management: SSL certificates are managed via a dedicated Nginx container using Let's Encrypt.

Docker Containers and Their Deployment

The deployment utilizes the following container:

Image Ports Volumes Environment Variables Restart Policy
jonasal/nginx-certbot:latest Host Network Mode - nginx_secrets:/etc/letsencrypt
- /data/nginx/user_conf.d:/etc/nginx/user_conf.d
[email protected] unless-stopped

Note: This container operates in network_mode: host to facilitate direct handling of traffic on the host's network interface.

Custom Scripts and Additional Setup

The deployment utilizes an external installation script for core application logic:

  • Location: /root/download.sh

  • Purpose: This script handles the automated download, extraction, and configuration of the Hiddify Manager components in a non-interactive mode (--no-gui).

Application Update Instructions

To update the main application, re-run the installation script:

/bin/bash /root/download.sh release --no-gui

Location of configuration files and data

  • Nginx Configuration: /data/nginx/user_conf.d/

  • SSL Certificates: Managed within the nginx_secrets Docker volume.

  • Installation Logs/Scripts: /root/

Available ports for connection

  • HTTPS: 443 (via Nginx proxy)
question_mark
Is there anything I can help you with?
question_mark
AI Assistant ×