Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andersevenrud/vuensee
A noVNC client interface built with Vue 3 and Vite.
https://github.com/andersevenrud/vuensee
novnc remote-desktop vite vnc vnc-client vnc-viewer vue vue3
Last synced: 3 months ago
JSON representation
A noVNC client interface built with Vue 3 and Vite.
- Host: GitHub
- URL: https://github.com/andersevenrud/vuensee
- Owner: andersevenrud
- License: other
- Created: 2020-12-04T18:46:15.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-02T18:46:01.000Z (over 3 years ago)
- Last Synced: 2024-05-02T01:16:20.789Z (9 months ago)
- Topics: novnc, remote-desktop, vite, vnc, vnc-client, vnc-viewer, vue, vue3
- Language: Vue
- Homepage: https://andersevenrud.github.io/vuensee/
- Size: 847 KB
- Stars: 21
- Watchers: 3
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# vuensee
> `/wuː'ɛn'siː/`
A [noVNC](https://github.com/novnc/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](https://andersevenrud.github.io/vuensee/index.html).
## 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](https://github.com/novnc/noVNC#server-requirements)
for more information.
## Usage
There are three ways to build and run this application:
> Alternatively you can [download](https://github.com/andersevenrud/vuensee/releases)
> a pre-built release from Github ready for use.
* [Standard](#standard)
* [Docker Compose](#docker-compose)
* [Docker Image](#docker-image)
### Standard
Install dependencies:
```shell
npm install
```
Start the development server:
```shell
npm run dev
```
Or to create a production build:
```shell
npm run build
```
### Docker Compose
To start up the development environment:
```shell
docker-compose up
```
You can also create a production build:
```shell
docker-compose run --rm vuensee npm run build
```
### Docker Image
Create and run a docker image using nginx with a production build:
```shell
docker build -t vuensee:custom .
docker run -p 8080:80 vuensee:custom
```
Or run a pre-built image with nginx:
```shell
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.
> You have to restart the development environment after changing this file.
Some settings can be overrided with URL parameters on runtime, ex: `?a=1&b=2`.
> User settings are stored (by default) in the browser using localStorage.
> To clear storage use the following URL parameter: `?_clear=true`.
The order of settings is as follows (from lowest to highest priority):
1. Environment variables
2. localStorage (user settings)
3. URL parameters
| Environment variable | URL parameter | Type | Default | Notes |
| ----------------------------------- | ---------------- | -------- | ------------ | ------------------------ |
| `VITE_TITLE` | | String | `vuensee` | |
| `VITE_ENABLE_PANEL` | | Boolean | `true` | |
| `VITE_ENABLE_SETTINGS` | | Boolean | `true` | |
| `VITE_ENABLE_CLIPBOARD` | | Boolean | `true` | |
| `VITE_ENABLE_FULLSCREEN` | | Boolean | `true` | |
| `VITE_ENABLE_POWER` | | Boolean | `true` | |
| `VITE_ENABLE_KEYS` | | Boolean | `true` | |
| `VITE_ENABLE_TOUCH_KEYBOARD` | | Boolean | `true` | |
| `VITE_ENABLE_URL_SETTINGS` | | Boolean | `true` | |
| `VITE_ENABLE_LOCALSTORAGE_SETTINGS` | | Boolean | `true` | |
| `VITE_ENABLE_VIEWPORT_DRAGGING` | | Boolean | `true` | |
| `VITE_SETTINGS_LANGUAGE` | `language` | String | Auto | `en`, `no`, `es` |
| `VITE_SETTINGS_AUTOCONNECT` | `autoconnect` | Boolean | `false` | |
| `VITE_SETTINGS_BELL` | `bell` | Boolean | `true` | |
| `VITE_SETTINGS_SHARED_MODE` | `sharedMode` | Boolean | `true` | |
| `VITE_SETTINGS_VIEW_ONLY` | `viewOnly` | Boolean | `false` | |
| `VITE_SETTINGS_CLIP_TO_WINDOW` | `clipToWindow` | Boolean | `false` | |
| `VITE_SETTINGS_SCALING_MODE` | `scalingMode` | String | `off` | `off`, `scale`, `remote` |
| `VITE_SETTINGS_QUALITY` | `quality` | Number | `6` | `0` - `9` |
| `VITE_SETTINGS_COMPRESSION` | `compression` | Number | `2` | `0` - `9` |
| `VITE_SETTINGS_RECONNECT` | `reconnect` | Boolean | `false` | |
| `VITE_SETTINGS_RECONNECT_DELAY` | `reconnectDelay` | Number | `5000` | |
| `VITE_SETTINGS_MESSAGE_TIMEOUT` | `messageTimeout` | Number | `4000` | |
| `VITE_SETTINGS_DOT_CURSOR` | `dotCursor` | Boolean | `false` | |
| `VITE_SETTINGS_HOSTNAME` | `hostname` | String | Auto | |
| `VITE_SETTINGS_PATH` | `path` | String | `websockify` | |
| `VITE_SETTINGS_REPEATER_ID` | `repeaterId` | String | | |
| `VITE_SETTINGS_PORT` | `port` | Number | Auto | |
| `VITE_SETTINGS_SSL` | `ssl` | Boolean | Auto | |
## License
[MIT](https://github.com/andersevenrud/vuensee/blob/main/LICENSE)
### Third party licenses
* [noVNC](https://github.com/novnc/noVNC/blob/master/LICENSE.txt)
* [Feather Icons](https://raw.githubusercontent.com/feathericons/feather/master/LICENSE)
* [Bell Sound](https://github.com/novnc/noVNC/blob/9142f8f0f7b4a53447f5cfec3a797cbf0d6204a9/app/sounds/CREDITS)