This interactive script builds desired images, creating local volumes as needed:
burp_sharevolume holds the JAR file as well as project and user configuration options.
novnc_sharevolume holds TLS certificates for the
novnc_servercontainers for GUI display.
This interactive script runs desired images according to supplied parameters.
Note: to display
docker runcommands without executing them, issue
Runs Burp Suite.
- If the docker host is your local machine, this image is all you need. You'll be able to access files through the local
- If the docker host is a remote machine, you will need the
sshdimage in order to access files. The
burp_sharevolume will be mounted to
- If the docker host is your local machine, and your local machine is running the X server with a unix socket at
/tmp/.X11-unix/X0, this image is all you need. Use
run.shto run the image, and the script will set up the necessary mounts.
- If the docker host is your local machine, but your local machine is not running the X server, you will need the
novnc_serverimages. Files can be accessed through the
- If the docker host is a remote machine, you will need all other images. The
novnc_sharevolumes will be mounted to
Note: when using the
novnc_serverimages, you must establish the VNC connection prior to running the
burpimage. Otherwise, the required X socket will not be available and Burp will fail to start.
Runs an SSH service with volume mounts for remote file management.
Building this image requires an
authorized_keys file containing allowed public keys for SSH connections.
novnc_share volumes will be mounted to
~/novnc_share on this image, respectively.
Runs an Apache web server to provide a noVNC client.
By default, it will generate a self-signed certificate. To supply your own certificate and keys, use the
Connecting to the
- Visit the address where
novnc_clientis running; e.g.,
- Click on the settings icon (the little gear).
- Click Advanced to expand that section.
- Click WebSocket to expand that section.
- Enter the address where
novnc_serveris running; e.g.,
- Finally, click the Connect button in the middle of the page.
With a self-signed certificate
When using a self-signed certificate for the
novnc_server image, you must first configure your browser to accept the certificate and proceed with the connection.
To do so, simply visit
6080 as appropriate, if your
novnc_server instance is running remotely, or on a different socket.
Your browser will then display a warning, and provide the option to accept the self-signed certificate and proceed with the connection.
Upon doing so, you will receive an HTTP 405 response with the following content:
Error code 405.
Message: Method Not Allowed.
Error code explanation: 405 = Specified method is invalid for this resource..
This is expected and can be ignored. You can now follow the connection steps above.
websockify to provide a VNC connection over WebSockets.
By default, it will generate a self-signed certificate for
websockify. To supply your own certificate and keys, use the
To aid in troubleshooting, the
entrypoint.sh scripts for the
novnc_server images accept a
--shell parameter which causes the image to drop into
bash upon execution.
While this repository is MIT-Licensed, additional licensing considerations apply for the
novnc_client image. See its included
LICENSE.txt file for details.