Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nicholaswilde/docker-novnc

A multi-architecture Docker image for noVNC.
https://github.com/nicholaswilde/docker-novnc

docker docker-image html5 multi-architecture-images novnc vnc

Last synced: 25 days ago
JSON representation

A multi-architecture Docker image for noVNC.

Awesome Lists containing this project

README

        

# Docker noVNC
[![Docker Image Version (latest by date)](https://img.shields.io/docker/v/nicholaswilde/novnc)](https://hub.docker.com/r/nicholaswilde/novnc)
[![Docker Pulls](https://img.shields.io/docker/pulls/nicholaswilde/novnc)](https://hub.docker.com/r/nicholaswilde/novnc)
[![GitHub](https://img.shields.io/github/license/nicholaswilde/docker-novnc)](./LICENSE)
[![ci](https://github.com/nicholaswilde/docker-novnc/workflows/ci/badge.svg)](https://github.com/nicholaswilde/docker-novnc/actions?query=workflow%3Aci)
[![lint](https://github.com/nicholaswilde/docker-novnc/workflows/lint/badge.svg?branch=main)](https://github.com/nicholaswilde/docker-novnc/actions?query=workflow%3Alint)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

A multi-architecture Docker image for [noVNC](https://novnc.com/).

## Dependencies

* None

## Usage
### docker cli
```bash
$ docker run -d \
--name=novnc \
-e TZ=America/Los_Angeles `# optional` \
-e PUID=1000 `# optional` \
-e PGID=1000 `# optional` \
-e REMOTE_HOST=localhost `# optional` \
-e REMOTE_PORT=5900 `# optional` \
-p 6080:6080 \
--restart unless-stopped \
nicholaswilde/novnc
```
### docker-compose

See [docker-compose.yaml](./docker-compose.yaml).

## Development

See [docs](https://nicholaswilde.io/docker-docs/development/).

## Troubleshooting

See [docs](https://nicholaswilde.io/docker-docs/troubleshooting/).

## Pre-commit hook

If you want to automatically generate `README.md` files with a pre-commit hook, make sure you
[install the pre-commit binary](https://pre-commit.com/#install), and add a [.pre-commit-config.yaml file](./.pre-commit-config.yaml)
to your project. Then run:

```bash
pre-commit install
pre-commit install-hooks
```
Currently, this only works on `amd64` systems.

## License

[Apache 2.0 License](./LICENSE)

## Author
This project was started in 2020 by [Nicholas Wilde](https://github.com/nicholaswilde/).