Skip to content

Commit a7f0a78

Browse files
authored
Update README.md
1 parent 8fa4e22 commit a7f0a78

File tree

1 file changed

+37
-31
lines changed

1 file changed

+37
-31
lines changed

README.md

Lines changed: 37 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,55 +2,61 @@
22
An experimental Minecraft-like docker client, built using [voxel.js](http://voxeljs.com/). Inspired by [dockercraft](https://github.com/docker/dockercraft).
33

44
## What is it?
5-
The @docker/dockercraft project turns the official Minecraft client into a docker client. voxel-dockerclient is a pure-javascript, browser-only docker client that provides a similar experiance.
5+
The dockercraft project turns the official Minecraft client into a docker client. voxel-dockerclient is a pure-javascript, browser-only docker client that provides a similar experiance.
66

77
## What is it not?
88
voxel-dockerclient is not a serious tool for working with docker. It's a fun project (which may grow up to be a teaching aid someday).
99

1010
## How to run voxel-dockerclient
1111
### Using the docker image
1212
The easiest way is to pull the docker image, and run from that. The steps are as follows:
13+
1314
1. Pull the docker image with
14-
```
15-
docker pull rajchaudhuri/voxel-dockerclient
16-
```
15+
16+
```
17+
docker pull rajchaudhuri/voxel-dockerclient
18+
```
1719
2. Run it with:
18-
```
19-
docker run --name vdc1 -p 5000:8080 -v /var/run/docker.sock:/var/run/docker.sock rajchaudhuri/voxel-dockerclient
20-
```
21-
The `-v /var/run/docker.sock:/var/run/docker.sock` is *very important*. This makes the UNIX socket, which the docker daemon
22-
listens to by default, available to the container. The container needs this to proxy a subset of the Docker remote API to
23-
voxel-dockerclient. If you leave this out by mistake, voxel-dockerclient will not work.
20+
21+
```
22+
docker run --name vdc1 -p 5000:8080 -v /var/run/docker.sock:/var/run/docker.sock rajchaudhuri/voxel-dockerclient
23+
```
24+
25+
The `-v /var/run/docker.sock:/var/run/docker.sock` is *very important*. This makes the UNIX socket, which the docker daemon listens to by default, available to the container. The container needs this to proxy a subset of the Docker remote API to voxel-dockerclient. If you leave this out by mistake, voxel-dockerclient will not work.
2426
3. Point your browser to the container. If you run docker directly on your Linux machine, browse to: `http://localhost:5000`.
25-
If you use docker-machine (for example, with the Docker Toolbox on Windows), find the IP address of your docker machine with
26-
```
27-
docker-machine ip default
28-
```
29-
and then browse to that IP address using the port that you mapped in step 2. E.g.:
30-
`http://192.17.22.1:5000`
27+
If you use docker-machine (for example, with the Docker Toolbox on Windows), find the IP address of your docker machine with
28+
29+
```
30+
docker-machine ip default
31+
```
32+
and then browse to that IP address using the port that you mapped in step 2. E.g.: `http://192.17.22.1:5000`
3133

3234
### Running with node.js
3335
Alternatively, if you have node.js installed on your docker host, you can clone the github repository, and run voxel-dockerclient yourself. The steps are:
36+
3437
1. Clone the github repository with
35-
```
36-
git clone https://github.com/rajch/voxel-dockerclient.git
37-
```
38+
39+
```
40+
git clone https://github.com/rajch/voxel-dockerclient.git
41+
```
3842
2. Run
39-
```
40-
npm install
41-
```
43+
44+
```
45+
npm install
46+
```
4247
3. Run
43-
```
44-
npm start
45-
```
48+
49+
```
50+
npm start
51+
```
4652
4. Browse to `http://localhost:8080`
4753

4854
Your logged-in user needs to be a member of the `docker` group for this to work.
4955

5056
## How to use voxel-dockerclient
5157
This is the opening screen of voxel-dockerclient.
5258

53-
![Opening screen](https://raw.githubusercontent.com/rajch/voxel-dockerclient/master/docs/img/openingscreen.png)
59+
![Opening screen](docs/img/openingscreen.png)
5460

5561
Press the **\`** key to close the dialog. The same key can be used to open and close the command console, and to close any dialog.
5662

@@ -63,15 +69,15 @@ While flying, the space bar takes the player higher, and the shift key lower. On
6369
Open the command console, and try the commands. Currently, the following commands are available:
6470
<table><thead><tr><th>Command</th><th>Description</th></tr></thead><tbody><tr><td>help</td><td>Shows all available commands</td></tr><tr><td>inspect</td><td>Inspects a container</td></tr><tr><td>top</td><td>Shows processes running in a container</td></tr><tr><td>start</td><td>Starts a container</td></tr><tr><td>stop</td><td>Stops a container</td></tr><tr><td>go</td><td>Takes player to a container, or to the first or last container. Type go home if you get lost.</td></tr><tr><td>remove</td><td>Deletes a container</td></tr><tr><td>create</td><td>Creates a container</td></tr><tr><td>welcome</td><td>Shows the welcome message</td></tr><tr><td>refresh</td><td>Re-fetches container list</td></tr><tr><td>restart</td><td>Restarts voxel-dockerclient. Use as a last resort.</td></tr></tbody></table>
6571

66-
Of these, the container-related commands like `start`, `stop`, `top`, `remove` and `inspect` can be invoked in two ways: either by using the `\<command\> \<containername\>` syntax, or by positioning the player exactly next to a container, and using just `\<command\>`.
72+
Of these, the container-related commands like `start`, `stop`, `top`, `remove` and `inspect` can be invoked in two ways: either by using the `<command> <containername>` syntax, or by positioning the player exactly next to a container, and using just `<command>`.
6773

6874
When the command console is closed, pressing the **I** key will invoke the `inpect` command. If the player is exactly next to a container, that container will be inspected.
6975

7076
The `create` command allows you to create new containers. Currently, you can only use images already on your docker host. Image pulling will be added in a later release.
7177

7278
Activity performed in other clients, such as the official docker client, will not reflect automatically in voxel-dockerclient. Use the `refresh` command periodincally.
7379

74-
The `go` command can be used to teleport the player to a particular container, using the syntax `go \<containername\>`. `go home` will teleport to the first (oldest) container. `go nextslot` will teleport to the spot where the next new container will appear.
80+
The `go` command can be used to teleport the player to a particular container, using the syntax `go <containername>`. `go home` will teleport to the first (oldest) container. `go nextslot` will teleport to the spot where the next new container will appear.
7581

7682
## Browser compatibility
7783
voxel-dockerclient has been tested using recent Chrome and Firefox browsers, on Linux and Windows. Regrettably (*I mean it. I actually like that old browser*), it does not work with Internet Explorer.
@@ -103,7 +109,7 @@ The code is open source, under the MIT license. I would love contribution, in th
103109

104110
## Acknowledgements
105111
I would like to thank:
106-
* The fine folk of @docker, for Docker
107-
* The fine folk behind the voxeljs family of modules. @maxogden, @kumavis, @deathcap, @substack et al. These are really nice.
112+
* The fine folk of Docker, for Docker
113+
* The fine folk behind the voxeljs family of modules. github/maxogden, github/kumavis, github/deathcap, github/substack et al. These are really nice.
108114
* The authors of the dockerode and axios modules
109-
* My partner, Chitra Raghavan, for contributing the player model, testing, and bearing with me while I was building this
115+
* My partner, Chitra Raghavan, for contributing the player model, testing, and bearing with me while I was building this

0 commit comments

Comments
 (0)