Skip to content

Commit fcbb276

Browse files
Document bedrock docker image in vitepress docs (#598)
* docs: Clarify JRE image variant for Bedrock support Co-authored-by: robin.braemer <robin.braemer@web.de> * Fix: Update Bedrock Edition links to use relative paths Co-authored-by: robin.braemer <robin.braemer@web.de> * Refactor Bedrock Docker setup documentation Co-authored-by: robin.braemer <robin.braemer@web.de> * Refactor Bedrock Docker Compose documentation for clarity Co-authored-by: robin.braemer <robin.braemer@web.de> --------- Co-authored-by: Cursor Agent <cursoragent@cursor.com>
1 parent 549c8e5 commit fcbb276

2 files changed

Lines changed: 77 additions & 4 deletions

File tree

.web/docs/guide/bedrock.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ Manual setup requires careful coordination of configurations, startup order, and
363363

364364
### Docker Compose Setup
365365

366-
For containerized deployments:
366+
This example shows a **custom Geyser deployment** where Geyser runs in a separate container. For **managed mode** (Geyser runs inside Gate), use the JRE variant (`ghcr.io/minekube/gate/jre:latest`) instead. See the [Docker installation guide](install/docker#image-variants) for details.
367367

368368
:::: code-group
369369

.web/docs/guide/install/docker.md

Lines changed: 76 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,27 @@ You can use specific version tags instead of the latest. Every commit to the `ma
1414
the `latest` tag as well as the commit's short SHA
1515
like [`6d3671c`](https://github.com/minekube/gate/pkgs/container/gate/50952923?tag=6d3671c).
1616

17+
## Image Variants
18+
19+
Gate provides two Docker image variants:
20+
21+
### Standard Image (`ghcr.io/minekube/gate:latest`)
22+
23+
The standard Gate image is based on a minimal distroless base image. This is the recommended image for most use cases as it has a smaller footprint and enhanced security.
24+
25+
### JRE Variant (`ghcr.io/minekube/gate/jre:latest`)
26+
27+
The JRE variant includes Java Runtime Environment (JRE) and is **required for [Bedrock Edition support](../bedrock)**. This image is based on `eclipse-temurin:25-jre-alpine` and includes Java necessary to run Geyser for Bedrock cross-play.
28+
29+
::: tip When to Use the JRE Variant
30+
Use `ghcr.io/minekube/gate/jre:latest` if you:
31+
- Need [Bedrock Edition support](../bedrock) (cross-play with mobile, console, and Windows Bedrock players)
32+
- Are using Gate's managed Geyser mode
33+
- Require Java runtime in your container
34+
35+
For all other use cases, use the standard `ghcr.io/minekube/gate:latest` image.
36+
:::
37+
1738
## `docker run`
1839

1940
```sh console
@@ -30,38 +51,71 @@ This command will pull and run the latest Gate image.
3051

3152
A complete config is located in repo [config.yml](https://github.com/minekube/gate/blob/master/config.yml).
3253

33-
```sh console
54+
:::: code-group
55+
56+
```sh [Standard Image]
3457
docker run -it --rm \
3558
-v PATH-TO-CONFIG/config.yml:/config.yml \
3659
ghcr.io/minekube/gate:latest
3760
```
3861

62+
```sh [JRE Variant (Bedrock Support)]
63+
docker run -it --rm \
64+
-v PATH-TO-CONFIG/config.yml:/config.yml \
65+
ghcr.io/minekube/gate/jre:latest
66+
```
67+
68+
::::
69+
3970
This command will pull and run the latest Gate image.
4071

4172
- `-v PATH-TO-CONFIG/config.yml:/config.yml` - Mounts the config file from the host system into the container.
73+
- Use the **JRE variant** if you need [Bedrock Edition support](../bedrock).
4274

4375
### Mounting a config file and Minekube Connect token
4476

4577
#### Using an environment variable for the token
4678

47-
```sh{3} console
79+
:::: code-group
80+
81+
```sh [Standard Image]
4882
docker run -it --rm \
4983
-v PATH-TO-CONFIG/config.yml:/config.yml \
5084
-e CONNECT_TOKEN=YOUR-TOKEN \
5185
ghcr.io/minekube/gate:latest
5286
```
5387

88+
```sh [JRE Variant (Bedrock Support)]
89+
docker run -it --rm \
90+
-v PATH-TO-CONFIG/config.yml:/config.yml \
91+
-e CONNECT_TOKEN=YOUR-TOKEN \
92+
ghcr.io/minekube/gate/jre:latest
93+
```
94+
95+
::::
96+
5497
**Note:** The `CONNECT_TOKEN` environment variable takes precedence over the `connect.json` file, so if both are provided, the token from the environment variable will be used instead.
5598

5699
#### Using a volume for the token
57100

58-
```sh{3} console
101+
:::: code-group
102+
103+
```sh [Standard Image]
59104
docker run -it --rm \
60105
-v PATH-TO-CONFIG/config.yml:/config.yml \
61106
-v PATH-TO-CONFIG/connect.json:/connect.json \
62107
ghcr.io/minekube/gate:latest
63108
```
64109

110+
```sh [JRE Variant (Bedrock Support)]
111+
docker run -it --rm \
112+
-v PATH-TO-CONFIG/config.yml:/config.yml \
113+
-v PATH-TO-CONFIG/connect.json:/connect.json \
114+
ghcr.io/minekube/gate/jre:latest
115+
```
116+
117+
::::
118+
65119
A [Minekube Connect](https://connect.minekube.com/) token json file can be automatically generated by running Gate with `connect.enable: true` in the config.
66120

67121
```json connect.json
@@ -99,6 +153,25 @@ docker-compose up
99153
The files of the two servers are located in the `serverdata*` directories.
100154
You can join at `localhost:25565` and use `/server` to switch between the servers.
101155

156+
### Using the JRE Variant for Bedrock Support
157+
158+
If you need [Bedrock Edition support](../bedrock), use the JRE variant image:
159+
160+
```yaml docker-compose.yaml
161+
version: '3.9'
162+
163+
services:
164+
gate:
165+
image: ghcr.io/minekube/gate/jre:latest
166+
container_name: gate
167+
restart: unless-stopped
168+
network_mode: host
169+
volumes:
170+
- PATH-TO-CONFIG/config.yml:/config.yml
171+
```
172+
173+
The JRE variant includes Java Runtime Environment required for Geyser to run. See the [Bedrock Edition guide](../bedrock) for complete Bedrock setup instructions.
174+
102175
## Troubleshooting
103176
104177
If you see the following error:

0 commit comments

Comments
 (0)