theasp / docker-novnc Goto Github PK

noVNC Display Container for Docker

License: MIT License

Shell 33.18% Dockerfile 66.82%

docker-novnc's Introduction

noVNC Display Container

This image is intended to be used for displaying X11 applications from other containers in a browser. A stand-alone demo as well as a Version 2 composition.

Image Contents

Xvfb - X11 in a virtual framebuffer
x11vnc - A VNC server that scrapes the above X11 server
noNVC - A HTML5 canvas vnc viewer
Fluxbox - a small window manager
xterm - to demo that it works
supervisord - to keep it all running

Usage

Variables

You can specify the following variables:

DISPLAY_WIDTH=<width> (1024)
DISPLAY_HEIGHT=<height> (768)
RUN_XTERM={yes|no} (yes)
RUN_FLUXBOX={yes|no} (yes)

Stand-alone Demo

Run:

$ docker run --rm -it -p 8080:8080 theasp/novnc

Open a browser and see the xterm demo at http://<server>:8080/vnc.html

V2 Composition

A version of the V2 docker-compose example is shown below to illustrate how this image can be used to greatly simplify the use of X11 applications in other containers. With just docker-compose up -d, your favorite IDE can be accessed via a browser.

Some notable features:

An x11 network is defined to link the IDE and novnc containers
The IDE DISPLAY environment variable is set using the novnc container name
The screen size is adjustable to suit your preferences via environment variables
The only exposed port is for HTTP browser connections

version: '2'
services:
  ide:
    image: psharkey/intellij:latest
#    image: psharkey/netbeans-8.1:latest
    environment:
      - DISPLAY=novnc:0.0
    depends_on:
      - novnc
    networks:
      - x11
  novnc:
    image: theasp/novnc:latest
    environment:
      # Adjust to your screen size
      - DISPLAY_WIDTH=1600
      - DISPLAY_HEIGHT=968
      - RUN_XTERM=no
    ports:
      - "8080:8080"
    networks:
      - x11
networks:
  x11:

If the IDE fails to start simply run docker-compose restart <container-name>.

On DockerHub / GitHub

DockerHub theasp/novnc
GitHub theasp/docker/novnc

Thanks

This is based on the alpine container by @psharkey: https://github.com/psharkey/docker/tree/master/novnc Based on wine-x11-novnc-docker and octave-x11-novnc-docker.

docker-novnc's People

Contributors

Stargazers

Watchers

Forkers

wix-alex davidftv andysjtu ademus4 decinho13 agsuy sakurai-youhei jorgesece zoutepopcorn xianren78 haxwithaxe mettbrot uzemalik sleongmgi dchandlerp cloudqq x2rohanm fnaticron jeremykuhnash jreusch cybersumeet samukhin panoramichq li7r tmrpj you2996 ayunami2000 leshk0de ahojaho botdevai cyh-ustc dtinth xanthronz katterkelly dashamoolam eldarock eeferfef pkrpq4 alimeerutech mcicolella matthijs12310 scottesandiego suchipi chris3081 bisesdb kincl lincolnthedev bzdula jvsouto loochao aviskumar phamtienvietnam jkonowitch tylerhunt54 janicecouch hyson666 kaylynarseu phamtienvnne kembawright tang4 phibenz xblogd o2br cheuerde yh56789 l00ke3 o-siman animeabcxyz wisconsinautonomous ebeechsrc gladiopeace zl1271 astrolox n4cwbstra km-robotics olegjakushkin ama50academic yogesh9630 qforger huyun0 qtvhao misorobotics loesterfranco xbcsl cutec-chris tboucher204 activitar michael-riha kingofnetflix darrick rockylucky enabled-robotics tnnd bigg01 314257smcag2 demingry nicolasdonato almo7aya rgov aodecipher

docker-novnc's Issues

Problem: Second Container does not detect the display

Hi, first i have to mention that I am a docker starter.

I tried to run firefox that runs in a different container.
But I always receive the following error message:
Unable to init server: Broadway display type not supported: novnc:0.0

Error: cannot open display: novnc:0.0

Use novnc with `network_mode: host`

If I set
network_mode: host
in docker-compose file, the http://localhost:8080/vnc.html does not work anymore
here is my setup

version: '2'
services:
  ide:
    image: psharkey/intellij:latest
    network_mode: host
    environment:
      - DISPLAY=novnc:0.0
    depends_on:
      - novnc
  novnc:
    image: theasp/novnc:latest
    network_mode: host
    environment:
      # Adjust to your screen size
      - DISPLAY_WIDTH=1600
      - DISPLAY_HEIGHT=968
      - RUN_XTERM=no

Publish for multiple architectures?

There isn't a NoVNC container image published to Docker Hub that supports arm64 (e.g., new Macs or Raspberry Pis). (The treehouse/novnc image is completely, and honestly quite impressively, broken.)

I was able to build yours and run it just fine on a Raspberry Pi 4. It would be great if you could publish the images for multiple platforms so it doesn't have to be rebuilt.

You would need to tweak your CircleCI config to use docker buildx build, something like this:

docker buildx build --platform linux/amd64,linux/arm64 --push -t theasp/novnc:latest -f Dockerfile .

The downside is that you have to build and push in a single step. And you probably need to figure out how to configure qemu-user-static and binfmt_msc -- not sure how easy that is to do on CircleCI.

[Question] Setting up password on NoVNC

Hi,

How can I set password while accessing the novnc through browser? Right not directly clicking connect works.

Also, I'm trying to set this up on heroku.

having trouble getting the example working

Start Failed: Failed to initialize graphics environment

java.awt.AWTError: Can't connect to X11 window server using 'novnc:0.0' as the value of the DISPLAY variable.

I am using the example docker compose. Any ideas?