From 1f113b1d29c507bfc40ee9f747f5037d6dc3cfff Mon Sep 17 00:00:00 2001 From: Paris Kasidiaris Date: Wed, 7 Mar 2018 12:28:44 +0200 Subject: [PATCH] Add xterm.js Docker image to documentation Closes #1295 --- README.md | 14 +++++++++++++- docker-compose.yml | 1 + 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cdaf0d71..a2a50372 100644 --- a/README.md +++ b/README.md @@ -144,7 +144,19 @@ Then open your project's [Public URL](https://help.sourcelair.com/projects/the-p ### Docker -First, make sure you have Docker Engine 1.13.0 (or newer) and Docker Compose 1.10.0 (or newer). To run the demo and builder in parallel, run the following command in your terminal: +First, make sure you have Docker Engine 1.13.0 (or newer) and Docker Compose 1.10.0 (or newer). + +Xterm.js [provides a pre-built Docker image](https://hub.docker.com/r/xtermjs/xterm.js/) to help run the demo easily (Git tags are built as [tagged Docker images](https://hub.docker.com/r/xtermjs/xterm.js/tags/) too). + +To run the just demo (with no editing access). run the following command in your terminal: + +``` +docker run -p 3000:3000 xtermjs/xterm.js +``` + +Then open http://0.0.0.0:3000 in a web browser to access the demo. + +To run the demo and builder in parallel, run the following command in your terminal: ``` docker-compose up diff --git a/docker-compose.yml b/docker-compose.yml index effd975c..8e6a2f46 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -2,6 +2,7 @@ version: "3" services: web: + image: xtermjs/xterm.js:latest build: . volumes: - ./:/usr/src/app