icepie/vuensee repository overview

⁠vuensee

A noVNC⁠ client interface built with Vue 3 and Vite.

Designed to match the features of the official client application but with an improved interface, optimizations, maintainability and customization support.

Check out the demo here⁠.

⁠Requirements

Runs on any modern browser.

Either Docker or Node 14+ is required for building and development.

VNC connection must support WebSockets. See the noVNC documentation⁠ for more information.

⁠Usage

There are three ways to build and run this application:

• Standard⁠
• Docker Compose⁠
• Docker Image⁠

⁠Standard

Install dependencies:

npm install

Start the development server:

npm run dev

Or to create a production build:

npm run build

⁠Docker Compose

To start up the development environment:

docker-compose up

You can also create a production build:

docker-compose run --rm vuensee npm run build

⁠Docker Image

Create and run a docker image using nginx with a production build:

docker build -t vuensee:custom .
docker run -p 8080:80 vuensee:custom

Or run a pre-built image with nginx:

docker run -p 8080:80 docker.pkg.github.com/andersevenrud/vuensee/vuensee:latest

⁠Configuration

Copy .env.example to .env and customize to your liking. Then build the solution.

Some settings can be overrided with URL parameters on runtime, ex: ?a=1&b=2.

The order of settings is as follows (from lowest to highest priority):

1. Environment variables
2. localStorage (user settings)
3. URL parameters

⁠License

MIT⁠

⁠Third party licenses

• noVNC⁠
• Feather Icons⁠
• Bell Sound⁠