Skip to content

Commit 086a116

Browse files
authored
docs: updated to describe ALLOW_LIST_USERS (#345)
1 parent b626ba5 commit 086a116

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -144,16 +144,18 @@ are also printed to the log when a player joins. There are 3 levels of permissio
144144
-e VISITORS "1234567890,0987654321"
145145
```
146146

147-
## Whitelist
147+
## Allowlist
148148

149-
There are two ways to handle a whitelist. The first is to set the `WHITE_LIST` environment variable to true and map in [a whitelist.json](https://minecraft.gamepedia.com/Whitelist.json) that is custom-crafted to the container. The other is to use the `WHITE_LIST_USERS` environment variable to list users that should be whitelisted. This list is player names. The server will look up the names and add in the XUID to match the player.
149+
There are two ways to handle a whitelist:
150+
151+
The first is to set the `ALLOW_LIST` environment variable to true and map in an [allowlist.json](https://minecraft.gamepedia.com/Whitelist.json) file (previously known as "whitelist.json") that is custom-crafted to the container.
152+
153+
The other is to set the `ALLOW_LIST_USERS` environment variable to a comma-separated list of gamer tag usernames that should be allowed. The server will look up the names and add in the XUID to match the player.
150154

151155
```shell
152-
-e WHITE_LIST_USERS="player1,player2,player3"
156+
-e ALLOW_LIST_USERS="player1,player2,player3"
153157
```
154158

155-
> Starting with 1.16.230.50, `ALLOW_LIST`, `ALLOW_LIST_USERS`, and the file `allowlist.json` will be used instead.
156-
157159
## Mods Addons
158160

159161
Also known as behavior or resource packs, in order to add mods into your server you can follow these steps, tested with [OPS (One Player Sleep)](https://foxynotail.com/addons/ops/) and [bedrocktweaks](https://bedrocktweaks.net/resource-packs/)

0 commit comments

Comments
 (0)