Skip to content

Commit

Permalink
Add xterm.js Docker image to documentation
Browse files Browse the repository at this point in the history
Closes #1295
  • Loading branch information
parisk committed Mar 7, 2018
1 parent 6e546c0 commit 1f113b1
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ version: "3"

services:
web:
image: xtermjs/xterm.js:latest
build: .
volumes:
- ./:/usr/src/app
Expand Down

0 comments on commit 1f113b1

Please sign in to comment.