No description
  • Go 96.8%
  • Dockerfile 3.2%
Find a file
2024-12-06 23:50:42 +01:00
development add dev mode for testing vnc proxy 2024-12-06 23:50:42 +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 add dev mode for testing vnc proxy 2024-12-06 23:50:42 +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
.gitlab-ci.yml use new create-build-context command 2024-12-06 22:17:21 +01:00
docker-compose.yml add docs for prometheus env variables 2024-12-06 22:01:22 +01:00
Dockerfile pull alpine from aws docker registry 2024-12-06 22:27:01 +01:00
go.mod enable initial support for prometheus metrics 2024-12-06 21:40:47 +01:00
go.sum enable initial support for prometheus metrics 2024-12-06 21:40:47 +01:00
main.go add dev mode for testing vnc proxy 2024-12-06 23:50:42 +01:00
Readme.md add dev mode for testing vnc proxy 2024-12-06 23:50:42 +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