Skip to content

Add purpur support for ServerLibraryCleaner #4133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
itzg merged 2 commits into from
Jun 25, 2026
+18 −6
Merged

Add purpur support for ServerLibraryCleaner #4133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c243dce
docs(serverLibraryCleanupPurpur): Add purpur support to documentation
harrisonablack Jun 25, 2026
d55005c
feat(serverLibraryCleanupPaper): Add clean libraries for purpur install
harrisonablack Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/configuration/misc-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,10 @@ docker run -d --pull=always \

By default, supported server types remove stale server libraries during installation by setting `CLEAN_SERVER_LIBRARIES` to `true`. Set `CLEAN_SERVER_LIBRARIES` to `false` to disable this cleanup if it causes unexpected behavior.

Currently, library cleanup is supported by `TYPE=PAPER`. Other server jar types are not yet supported.
Currently, library cleanup is supported by

- `TYPE=PAPER`
- `TYPE=PURPUR`

## Running as alternate user/group ID

Expand Down Expand Up @@ -244,4 +247,4 @@ To also include the timestamp with each log, set `LOG_TIMESTAMP` to "true". The

```
[init] 2022-02-05 16:58:33+00:00 Starting the Minecraft server...
```
```
17 changes: 13 additions & 4 deletions scripts/start-deployPurpur
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ IFS=$'\n\t'
: "${PURPUR_BUILD:=LATEST}"
: "${PURPUR_DOWNLOAD_URL:=}"
: "${PURPUR_CONFIG_REPO:=}"
: "${CLEAN_SERVER_LIBRARIES:=true}"

# shellcheck source=start-utils
. "$(dirname "$0")/start-utils"
Expand All @@ -13,10 +14,15 @@ isDebugging && set -x
resultsFile=/data/.purpur.env

if [[ $PURPUR_DOWNLOAD_URL ]]; then
if ! mc-image-helper install-purpur \
--output-directory=/data \
--results-file="$resultsFile" \
--url="${PURPUR_DOWNLOAD_URL}"; then
args=(
--output-directory=/data
--results-file="$resultsFile"
--url="${PURPUR_DOWNLOAD_URL}"
)
if isTrue "$CLEAN_SERVER_LIBRARIES"; then
args+=(--clean-libraries)
fi
if ! mc-image-helper install-purpur "${args[@]}"; then
logError "Failed to download from custom Purpur URL"
exit 1
fi
Expand All @@ -29,6 +35,9 @@ else
if [[ $PURPUR_BUILD ]]; then
args+=(--build="$PURPUR_BUILD")
fi
if isTrue "$CLEAN_SERVER_LIBRARIES"; then
args+=(--clean-libraries)
fi
if ! mc-image-helper install-purpur "${args[@]}"; then
logError "Failed to download Purpur"
exit 1
Expand Down
Loading