puqcloud/vncwebproxy repository overview

⁠PUQ Proxmox KVM WHMCS Module - vncwebproxy

This is the official Docker image for the vncwebproxy service, which is required for the Proxmox KVM WHMCS Module by PUQ⁠.

This all-in-one image provides:

• The vncwebproxy Go daemon
• noVNC (v1.7.0) served statically via nginx
• Unified logging and automated healthchecks

⁠Quick Start

You can run this image using Docker or Docker Compose.

⁠Using Docker Compose (Recommended)

Create a docker-compose.yml file on your server:

name: "vncwebproxy-puq-info"

services:
  vncwebproxy.puq.info_vncwebproxy:
    container_name: vncwebproxy.puq.info_vncwebproxy
    image: puqcloud/vncwebproxy:latest
    restart: unless-stopped
    environment:
      - TZ=America/Winnipeg
      # Replace 'puqcloud' with your unique Proxy Key configured in WHMCS
      - PROXY_KEY=puqcloud
    networks:
      - nginx-proxy-manager_default

networks:
  nginx-proxy-manager_default:
    external: true

Run the container:

docker compose up -d

⁠Using Docker CLI

docker run -d \
  --name vncwebproxy \
  -p 8080:80 \
  -e PROXY_KEY=puqcloud \
  -e TZ=America/Winnipeg \
  puqcloud/vncwebproxy:latest

⁠Environment Variables

⁠Health Checks

This image includes a robust, built-in dual health check:

1. It verifies that NGINX is actively serving the noVNC client on port 80.
2. It verifies that the vncwebproxy daemon is actively listening for WebSocket connections internally on port 8080.

⁠Updating the Image

To get the latest updates, simply pull the latest image and restart your container:

docker pull puqcloud/vncwebproxy:latest
docker compose up -d

⁠Documentation

For full instructions on how to install, configure, and use the Proxmox KVM WHMCS module, please refer to the official documentation⁠.