Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pgaskin/easy-novnc

Single-binary noVNC instance, web UI, and multi-host proxy.
https://github.com/pgaskin/easy-novnc

html5 novnc proxy remote-desktop vnc websocket

Last synced: 10 days ago
JSON representation

Single-binary noVNC instance, web UI, and multi-host proxy.

Host: GitHub
URL: https://github.com/pgaskin/easy-novnc
Owner: pgaskin
License: mit
Archived: true
Created: 2019-04-09T01:27:21.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-02-25T00:12:02.000Z (over 1 year ago)
Last Synced: 2024-08-02T02:14:43.375Z (3 months ago)
Topics: html5, novnc, proxy, remote-desktop, vnc, websocket
Language: Go
Homepage:
Size: 4.02 MB
Stars: 175
Watchers: 5
Forks: 60
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # easy-novnc

An easy way to run a [noVNC](https://github.com/novnc/noVNC) instance and proxy with a single binary.

## Features

- Clean start page.

- CIDR whitelist/blacklist.

- Optionally allow connections to arbitrary hosts (and ports).

- Ensures the target port is a VNC server to prevent tunneling to unauthorized ports.

- Can be configured using environment variables or command line flags (but works out-of-the box).

- IPv6 support.

- Single binary, no dependencies.

- Easy setup.

- Optional [client](./wstcp) for local TCP connections tunneled through WebSockets.

## Installation

- Binaries for the latest commit can be downloaded [here](https://ci.appveyor.com/project/pgaskin/easy-novnc/build/artifacts).

- It can also be [deployed to Heroku](https://heroku.com/deploy).

- A Docker image is available: [geek1011/easy-novnc:latest](https://hub.docker.com/r/geek1011/easy-novnc).

- You can build your own binaries with go 1.13 or newer using `go get github.com/pgaskin/easy-novnc` or by cloning this repo and running `go build`.

## Usage

```

Usage: easy-novnc [options]

Options:

  -a, --addr string              The address to listen on (env NOVNC_ADDR) (default ":8080")

  -H, --arbitrary-hosts          Allow connection to other hosts (env NOVNC_ARBITRARY_HOSTS)

  -P, --arbitrary-ports          Allow connections to arbitrary ports (requires arbitrary-hosts) (env NOVNC_ARBITRARY_PORTS)

  -u, --basic-ui                 Hide connection options from the main screen (env NOVNC_BASIC_UI)

  -C, --cidr-blacklist strings   CIDR blacklist for when arbitrary hosts are enabled (comma separated) (conflicts with whitelist) (env NOVNC_CIDR_BLACKLIST)

  -c, --cidr-whitelist strings   CIDR whitelist for when arbitrary hosts are enabled (comma separated) (conflicts with blacklist) (env NOVNC_CIDR_WHITELIST)

      --default-view-only        Use view-only by default (env NOVNC_DEFAULT_VIEW_ONLY)

      --help                     Show this help text

  -h, --host string              The host/ip to connect to by default (env NOVNC_HOST) (default "localhost")

      --no-url-password          Do not allow password in URL params (env NOVNC_NO_URL_PASSWORD)

  -p, --port uint16              The port to connect to by default (env NOVNC_PORT) (default 5900)

  -v, --verbose                  Show extra log info (env NOVNC_VERBOSE)

```