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: .web/docs/guide/bedrock.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -363,7 +363,7 @@ Manual setup requires careful coordination of configurations, startup order, and
363
363
364
364
### Docker Compose Setup
365
365
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.
Copy file name to clipboardExpand all lines: .web/docs/guide/install/docker.md
+76-3Lines changed: 76 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,27 @@ You can use specific version tags instead of the latest. Every commit to the `ma
14
14
the `latest` tag as well as the commit's short SHA
15
15
like [`6d3671c`](https://github.com/minekube/gate/pkgs/container/gate/50952923?tag=6d3671c).
16
16
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.
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
+
17
38
## `docker run`
18
39
19
40
```sh console
@@ -30,38 +51,71 @@ This command will pull and run the latest Gate image.
30
51
31
52
A complete config is located in repo [config.yml](https://github.com/minekube/gate/blob/master/config.yml).
32
53
33
-
```sh console
54
+
:::: code-group
55
+
56
+
```sh [Standard Image]
34
57
docker run -it --rm \
35
58
-v PATH-TO-CONFIG/config.yml:/config.yml \
36
59
ghcr.io/minekube/gate:latest
37
60
```
38
61
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
+
39
70
This command will pull and run the latest Gate image.
40
71
41
72
-`-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).
42
74
43
75
### Mounting a config file and Minekube Connect token
44
76
45
77
#### Using an environment variable for the token
46
78
47
-
```sh{3} console
79
+
:::: code-group
80
+
81
+
```sh [Standard Image]
48
82
docker run -it --rm \
49
83
-v PATH-TO-CONFIG/config.yml:/config.yml \
50
84
-e CONNECT_TOKEN=YOUR-TOKEN \
51
85
ghcr.io/minekube/gate:latest
52
86
```
53
87
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
+
54
97
**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.
55
98
56
99
#### Using a volume for the token
57
100
58
-
```sh{3} console
101
+
:::: code-group
102
+
103
+
```sh [Standard Image]
59
104
docker run -it --rm \
60
105
-v PATH-TO-CONFIG/config.yml:/config.yml \
61
106
-v PATH-TO-CONFIG/connect.json:/connect.json \
62
107
ghcr.io/minekube/gate:latest
63
108
```
64
109
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
+
65
119
A [Minekube Connect](https://connect.minekube.com/) token json file can be automatically generated by running Gate with `connect.enable: true` in the config.
66
120
67
121
```json connect.json
@@ -99,6 +153,25 @@ docker-compose up
99
153
The files of the two servers are located in the `serverdata*` directories.
100
154
You can join at `localhost:25565` and use `/server` to switch between the servers.
101
155
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.
0 commit comments