No description
  • Go 96.8%
  • Dockerfile 3.2%
Find a file
2024-12-06 22:01:22 +01:00
encryption ass logrus as logger 2024-10-10 19:20:03 +02:00
log ass logrus as logger 2024-10-10 19:20:03 +02:00
metrics add per vnc session metrics 2024-12-06 21:52:41 +01:00
types fix converting hostPort 2024-10-10 20:41:18 +02: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 Update public.ecr.aws/docker/library/golang Docker tag to v1.23.3 2024-11-07 09:23:02 +00:00
docker-compose.yml add docs for prometheus env variables 2024-12-06 22:01:22 +01:00
Dockerfile Update alpine Docker tag to v3.21.0 2024-12-06 00:01:04 +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 basic auth support for prometheus 2024-12-06 21:59:56 +01:00
Readme.md add docs for prometheus env variables 2024-12-06 22:01:22 +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.