No description
  • Go 96.8%
  • Dockerfile 3.2%
Find a file
jonasled 59fd7b79f1
Some checks failed
/ build (darwin/amd64) (push) Successful in 1m47s
/ build (linux/arm) (push) Successful in 1m29s
/ build (freebsd/amd64) (push) Successful in 1m49s
/ build (darwin/arm64) (push) Successful in 1m51s
/ build (linux/386) (push) Successful in 1m45s
/ build (windows/amd64) (push) Successful in 1m30s
/ build (linux/amd64) (push) Successful in 1m56s
/ build (freebsd/arm64) (push) Successful in 2m8s
/ sbom (push) Successful in 1m30s
/ build (linux/arm64) (push) Successful in 1m52s
/ build (windows/arm64) (push) Successful in 1m56s
/ build (push) Successful in 3m22s
/ docker (push) Successful in 0s
/ upload (push) Failing after 15s
/ binaries (push) Failing after 0s
Port CI to Forgejo Actions
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-18 10:56:15 +01:00
.forgejo/workflows Port CI to Forgejo Actions 2026-11-18 10:56:15 +01:00
development allow int and string for vmid 2025-01-11 13:37:25 +01:00
encryption add dev mode for testing vnc proxy 2024-12-06 23:50:42 +01:00
log ass logrus as logger 2024-10-10 19:20:03 +02:00
metrics move promethgeus init in metrics package 2024-12-06 22:03:44 +01:00
types allow int and string for vmid 2025-01-11 13:37:25 +01:00
.dockerignore add example systemd config 2024-10-14 19:51:06 +02:00
.gitignore initial commit 2024-10-09 23:48:49 +02:00
docker-compose.yml add docs for prometheus env variables 2024-12-06 22:01:22 +01:00
Dockerfile Update golang Docker tag to v1.27.4 2026-11-11 23:05:44 +00:00
go.mod Update module github.com/prometheus/client_golang to v1.25.0 2026-10-08 22:25:35 +00:00
go.sum Update module github.com/prometheus/client_golang to v1.25.0 2026-10-08 22:25:35 +00:00
LICENSE Add LICENSE 2024-12-07 01:35:15 +01:00
main.go allow int and string for vmid 2025-01-11 13:37:25 +01:00
Readme.md update s3 endpoint 2026-03-22 09:56:05 +01:00
renovate.json Add renovate.json 2024-10-10 22:02:23 +00:00
vncproxy.service add example systemd config 2024-10-14 19:51:06 +02:00

VNC Proxy for Hostware

This repository contains a VNC Proxy, which is compatible with the Proxy used by hostware. It's extremly lightweight. Without any active conections it uses about 10Mb memory and 0 CPU. With active connections the resources will increase only slightly.

Installation

Using Docker

When using docker for connecting, there is a example docker-compose.yml file located in this repository. For SSL encryption, you can either provide the TLS_CERT and TLS_KEY environment variables with the path to the certificate or use a external reverse Proxy. You can also place a LoadBalancer, like HaProxy or Traefik in front of the VNC prox, to balance the connections between multiple instances.

Using Binary file

The current binary can be downloaded using the following Links:

You can either provide the configuration via environment variables or through a .env file next to the binary with the following content:

JWT_SIGN_KEY=""
PVE_IGNORE_SSL=true
GIN_MODE=release
TLS_CERT=
TLS_KEY=
PROMETHEUS_METRICS=false
PROMETHEUS_AUTH_USERNAME=prometheus
PROMETHEUS_AUTH_PASSWORD=password

When using systemd you can cop the example vncproxy.service file from this repo and place it in /etc/systemd/system. After setting the correct environment variables and the path to the binary you can enable the service using the following commands:

systemctl daemon-reload
systemctl enable vncproxy
systemctl start vncproxy

When using a dedicated VPS, use the smalles one you can get.

Dev Mode

You can enable the dev mode by setting DEV_MODE to true. With this mode you get a new HTTP endpoint at /vnc to directly start a VNC session. It will create the VNC Ticket using the PVE API, encrypts it and passes it to a noVNC iframe. It can be called with the following parameters:

http://localhost:8080/vnc
  ?host=1.2.3.4
  &node=pve
  &user=root@pam
  &password=myPveUserPassword
  &vm=100
  &type=qemu # optional parameter
  &port=8006 # optional parameter