Skip to content

Commit 06190ef

Browse files
authored
Added support for FOLIA_CHANNEL (#3029)
1 parent 1c780ff commit 06190ef

File tree

2 files changed

+19
-3
lines changed

2 files changed

+19
-3
lines changed

docs/types-and-platforms/server-types/paper.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -65,13 +65,19 @@ Extra variables:
6565

6666
### Folia
6767

68-
Enable Folia server mode by adding a `-e TYPE=FOLIA` to your command-line.
68+
A [Folia server](https://papermc.io/software/folia) can be used by setting the environment variable `TYPE` to "FOLIA".
6969

70-
By default, the container will run the latest build of [Folia server](https://papermc.io/downloads), but you can also choose to run a specific build with `-e FOLIABUILD=26`.
70+
By default, the container will run the latest experimental build of [Folia server](https://papermc.io/downloads), but you can also choose to run a specific build with `-e FOLIABUILD=26`. The release channel can be changed with the variable `FOLIA_CHANNEL`; however, only experimental builds are available at this time.
7171

72+
!!! example
73+
74+
Using `docker run`
75+
76+
```
7277
docker run -d -v /path/on/host:/data \
7378
-e TYPE=FOLIA \
7479
-p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
80+
```
7581

7682
If you are hosting your own copy of Folia you can override the download URL with `FOLIA_DOWNLOAD_URL=<url>`.
7783

scripts/start-deployFolia

+11-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
#!/bin/bash
22

3+
: "${FOLIA_CHANNEL:=experimental}"
4+
5+
# shellcheck source=start-utils
6+
. "${SCRIPTS:-/}start-utils"
7+
set -o pipefail
8+
handleDebugMode
9+
310
if [[ $FOLIA_DOWNLOAD_URL ]]; then
411
export PAPER_DOWNLOAD_URL="$FOLIA_DOWNLOAD_URL"
512
fi
@@ -8,4 +15,7 @@ if [[ $FOLIABUILD ]]; then
815
export PAPERBUILD="$FOLIABUILD"
916
fi
1017

11-
PAPER_PROJECT="folia" PAPER_NAME="FoliaMC" exec "${SCRIPTS:-/}start-deployPaper" "$@"
18+
PAPER_PROJECT="folia" \
19+
PAPER_NAME="FoliaMC" \
20+
PAPER_CHANNEL="${FOLIA_CHANNEL}" \
21+
exec "${SCRIPTS:-/}start-deployPaper" "$@"

0 commit comments

Comments
 (0)