You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-3Lines changed: 7 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,10 @@ The dockercraft project turns the official Minecraft client into a docker client
7
7
## What is it not?
8
8
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).
9
9
10
+
> WARNING: Please use voxel-dockerclient on your local machine only.
11
+
> It currently doesn't support authentication.
12
+
> Every player should be considered a root user!
13
+
10
14
## How to run voxel-dockerclient
11
15
### Using the docker image
12
16
The easiest way is to pull the docker image, and run from that. The steps are as follows:
@@ -19,7 +23,7 @@ The easiest way is to pull the docker image, and run from that. The steps are as
19
23
2. Run it with:
20
24
21
25
```
22
-
docker run --name vdc1 -p 5000:8080 -v /var/run/docker.sock:/var/run/docker.sock rajchaudhuri/voxel-dockerclient
26
+
docker run -d --name vdc1 -p 5000:8080 -v /var/run/docker.sock:/var/run/docker.sock rajchaudhuri/voxel-dockerclient
23
27
```
24
28
25
29
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.
@@ -71,11 +75,11 @@ Open the command console, and try the commands. Currently, the following command
71
75
72
76
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>`.
73
77
74
-
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.
78
+
When the command console is closed, pressing the **I** key will invoke the `inspect` command. If the player is exactly next to a container, that container will be inspected.
75
79
76
80
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.
77
81
78
-
Activity performed in other clients, such as the official docker client, will not reflect automatically in voxel-dockerclient. Use the `refresh` command periodincally.
82
+
Activity performed in other clients, such as the official docker client, will not reflect automatically in voxel-dockerclient. Use the `refresh` command periodically.
79
83
80
84
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.
0 commit comments