Skip to content

Commit 636a16b

Browse files
committed
Updated README with current status and badges
1 parent c439172 commit 636a16b

File tree

1 file changed

+13
-44
lines changed

1 file changed

+13
-44
lines changed

README.md

Lines changed: 13 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# voxel-dockerclient
22
An experimental Minecraft-like docker client, built using [voxel.js](http://voxeljs.com/). Inspired by [dockercraft](https://github.com/docker/dockercraft).
33

4+
[![Docker Pulls](https://img.shields.io/docker/pulls/rajchaudhuri/voxel-dockerclient "Number of times the voxel-dockerclient image was pulled from the Docker Hub")](https://hub.docker.com/r/rajchaudhuri/voxel-dockerclient)
5+
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/rajch/voxel-dockerclient?include_prereleases)](https://github.com/rajch/voxel-dockerclient/releases)
6+
47
> [!IMPORTANT]
58
> This software is dependent, indirectly, on a version of [three.js](https://threejs.org/) that has known vulnerabilities. For a number of reasons, this dependency **cannot** currently be updated. So, this software is now in maintenance mode.
69
>
@@ -23,7 +26,7 @@ The easiest way:
2326

2427
[![Try in PWD](https://raw.githubusercontent.com/play-with-docker/stacks/master/assets/images/button.png)](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/rajch/voxel-dockerclient/master/stack.yml)
2528

26-
### Using the docker image
29+
### Use the published docker image
2730
The next easiest way is to pull the docker image, and run from that. The steps are as follows:
2831

2932
1. Pull the docker image with
@@ -43,45 +46,10 @@ The next easiest way is to pull the docker image, and run from that. The steps a
4346
> The container needs this to proxy a subset of the Docker remote API to voxel-dockerclient.
4447
> If you leave this out by mistake, voxel-dockerclient will not work.
4548
46-
3. Point your browser to the container. If you run docker directly on your Linux machine, browse to: `http://localhost:8080`.
47-
If you use docker-machine (for example, with the Docker Toolbox on Windows), find the IP address of your docker machine with
48-
49-
```
50-
docker-machine ip default
51-
```
52-
and then browse to that IP address using the port that you mapped in step 2. E.g.: `http://192.17.22.1:8080`
53-
54-
### Building with node.js and golang
55-
Alternatively, if you have node.js (>=v12.19.0) and golang (>=go1.16.4) installed on your docker host, you can clone the github repository, and build and run voxel-dockerclient yourself. The steps are:
56-
57-
1. Clone the github repository into your Go workspace with:
58-
59-
```
60-
git clone https://github.com/rajch/voxel-dockerclient.git
61-
```
62-
2. Change to the cloned directory and run
63-
64-
```
65-
npm install
66-
```
67-
3. Run
68-
69-
```
70-
npm run build
71-
npm run run-docker
72-
```
73-
or, if you are on Linux, or OSX, or WSL:
74-
```
75-
make
76-
make run-docker
77-
```
78-
4. Browse to `http://localhost:8080`
49+
3. Browse to: `http://localhost:8080`.
7950

80-
Your logged-in user needs to be a member of the `docker` group for this to work.
81-
82-
### Building using docker only
83-
Finally, if you have docker 17.05 or above, you can clone the github repository and use the multi-stage-build Dockerfile
84-
that is included. This will pull relevant node and golang images, and perform the build using those. The steps are:
51+
### Build the docker image locally
52+
Finally, you can clone the github repository and use the multi-stage Dockerfile that is included. This will pull relevant node and golang images, and perform the build using those. The steps are:
8553

8654
1. Clone the github repository with:
8755

@@ -101,7 +69,7 @@ docker run -d -v /var/run/docker.sock:/var/run/docker.sock -p 8080:8080 voxel-do
10169
Or, you could use the provided docker compose manifest file, by running:
10270

10371
```
104-
docker-compose up -d
72+
docker compose up -d
10573
```
10674

10775
Your logged-in user needs to be a member of the `docker` group for this to work.
@@ -117,7 +85,7 @@ I intend to add the following capabilities quickly:
11785
* ~~`docker logs` equivalent~~ ** DONE
11886
* ~~`docker attach` equivalent~~ ** DONE
11987
* `docker pull` equivalent
120-
* A better interface for the `create` command
88+
* ~~A better interface for the `create` command~~ ** DONE
12189
* ~~*Some* security~~ ** DONE
12290

12391
~~In the pipeline, further down, are:~~
@@ -136,7 +104,7 @@ This project is now in maintenance mode. See the [How does it work](#how-does-it
136104

137105
The voxel-dockerclient server is a tiny golang program, which serves the client HTML/CSS/javascript, and provides a proxy for the docker API. At the moment, it proxies the full API with ~~no~~ some authorization. ~~This will change.~~
138106

139-
On the client, it uses the brilliant [voxeljs](http://voxeljs.com/) family of node modules to render the UI, and the ~~[axios](https://github.com/mzabriskie/axios) node module~~fetch API to communicate with the proxied API.
107+
On the client, it uses the brilliant [voxeljs](http://voxeljs.com/) family of node modules to render the UI, and the ~~[axios](https://github.com/mzabriskie/axios) node module~~ fetch API to communicate with the proxied API.
140108

141109
I have used an older flavour of the main voxeljs module, voxel-engine. I had to fork it because of some incompatibilities with later modules. The original is [here](https://github.com/maxogden/voxel-engine), and my forked version [here](https://github.com/rajch/voxel-engine).
142110
The same treatment had to be given for a voxeljs plugin called voxel-keys. The original is [here](https://github.com/voxel/voxel-keys), and my fork [here](https://github.com/rajch/voxel-keys).
@@ -150,7 +118,8 @@ The code is open source, under the MIT license. I would love contribution, in th
150118

151119
## Acknowledgements
152120
I would like to thank:
121+
153122
* The fine folk of @docker, for Docker
154-
* The fine folk behind the voxeljs family of modules. @github/maxogden, @github/kumavis, @github/deathcap, @github/substack et al. These are really nice.
155-
* The authors of the dockerode and axios modules, although I'm not using dockerode any more.
123+
* The fine folk behind the voxeljs family of modules: @github/maxogden, @github/kumavis, @github/deathcap, @github/substack et al
124+
* The authors of the dockerode and axios modules, although those modules are no longer used in this project
156125
* My partner, Chitra Raghavan (@github/chitradoc), for contributing the player model, testing, and bearing with me while I was building this

0 commit comments

Comments
 (0)