Skip to content

Commit

Permalink
docs: updated to describe ALLOW_LIST_USERS (#345)
Browse files Browse the repository at this point in the history
  • Loading branch information
itzg authored Aug 7, 2023
1 parent b626ba5 commit 086a116
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,16 +144,18 @@ are also printed to the log when a player joins. There are 3 levels of permissio
-e VISITORS "1234567890,0987654321"
```

## Whitelist
## Allowlist

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.
There are two ways to handle a whitelist:

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.

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.

```shell
-e WHITE_LIST_USERS="player1,player2,player3"
-e ALLOW_LIST_USERS="player1,player2,player3"
```

> Starting with 1.16.230.50, `ALLOW_LIST`, `ALLOW_LIST_USERS`, and the file `allowlist.json` will be used instead.

## Mods Addons

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/)
Expand Down

0 comments on commit 086a116

Please sign in to comment.