Skip to content

Commit f5e511e

Browse files
authored
docs: clarify that ICON can be a container path (#3371)
1 parent 2a859d6 commit f5e511e

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

docs/configuration/server-properties.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -197,14 +197,34 @@ New to [22W42A](https://www.minecraft.net/en-us/article/minecraft-snapshot-22w42
197197

198198
### Server icon
199199

200-
A server icon can be configured using the `ICON` variable. The image will be automatically
201-
downloaded, scaled, and converted from any other image format:
200+
A server icon can be configured by setting the `ICON` variable to a URL to download or a container path. The image will be automatically downloaded (if a URL), scaled, and converted from any other image format:
202201

203-
docker run -d -e ICON=http://..../some/image.png ...
202+
!!! example
204203

205-
The server icon which has been set doesn't get overridden by default. It can be changed and overridden by setting `OVERRIDE_ICON` to `TRUE`.
204+
Using `docker run`:
205+
206+
```
207+
docker run -d -e ICON=http://..../some/image.png ...
208+
```
209+
210+
In compose file:
211+
212+
```yaml
213+
environment:
214+
ICON: http://..../some/image.png
215+
```
216+
217+
Using a file from host filesystem:
218+
219+
```yaml
220+
environment:
221+
ICON: /icon.png
222+
OVERRIDE_ICON: true
223+
volumes:
224+
./icon.png:/icon.png
225+
```
206226

207-
docker run -d -e ICON=http://..../some/other/image.png -e OVERRIDE_ICON=TRUE...
227+
By default an existing `server-icon.png` file will not be replaced, that can be changed by setting `OVERRIDE_ICON` to "true".
208228

209229
### RCON
210230

@@ -502,4 +522,4 @@ When using `docker run` from a bash shell, the entries must be quoted with the `
502522
| LOG_IPS | log-ips |
503523
| REGION_FILE_COMPRESSION | region-file-compression |
504524
| BUG_REPORT_LINK | bug-report-link |
505-
| PAUSE_WHEN_EMPTY_SECONDS | pause-when-empty-seconds |
525+
| PAUSE_WHEN_EMPTY_SECONDS | pause-when-empty-seconds |

0 commit comments

Comments
 (0)