Document actual defaults of REMOVE_OLD_MODS_INCLUDE and REMOVE_OLD_MODS_DEPTH (#4375)

This commit is contained in:
spa77k authored and GitHub committed 2026-11-04 07:10:07 -06:00
1 parent 0e124927f7
commit 67e4e8bb72
1 file changed
+3 -3
+3 -3
View File
@@ -60,9 +60,9 @@ There are optional volume paths that can be attached to supply content to be cop
By default, the [environment variable processing](../configuration/interpolating.md) is performed on synchronized files that match the expected suffixes in `REPLACE_ENV_SUFFIXES` (by default "yml,yaml,txt,cfg,conf,properties,hjson,json,tml,toml") and are not excluded by `REPLACE_ENV_VARIABLES_EXCLUDES` and `REPLACE_ENV_VARIABLES_EXCLUDE_PATHS`. This processing can be disabled by setting `REPLACE_ENV_DURING_SYNC` to `false`.
If you want old mods/plugins to be removed before the content is brought over from those attach points, then add `-e REMOVE_OLD_MODS=TRUE`. You can fine tune the removal process by specifying the `REMOVE_OLD_MODS_INCLUDE` and `REMOVE_OLD_MODS_EXCLUDE` variables, which are comma separated lists of file glob patterns. If a directory is excluded, then it and all of its contents are excluded. By default, only jars are removed.
If you want old mods/plugins to be removed before the content is brought over from those attach points, then add `-e REMOVE_OLD_MODS=TRUE`. You can fine tune the removal process by specifying the `REMOVE_OLD_MODS_INCLUDE` and `REMOVE_OLD_MODS_EXCLUDE` variables, which are comma separated lists of file glob patterns. If a directory is excluded, then it and all of its contents are excluded. By default, `REMOVE_OLD_MODS_INCLUDE` is `*.jar,*-version.json`, so jars and the `*-version.json` files are removed.
You can also specify the `REMOVE_OLD_MODS_DEPTH` (default is 16) variable to only delete files up to a certain level.
You can also specify the `REMOVE_OLD_MODS_DEPTH` (default is 1) variable to only delete files up to a certain level. With the default, only files directly inside the `plugins/` or `mods/` directory are removed.
For example: `-e REMOVE_OLD_MODS=TRUE -e REMOVE_OLD_MODS_INCLUDE="*.jar" -e REMOVE_OLD_MODS_DEPTH=1` will remove all old jar files that are directly inside the `plugins/` or `mods/` directory.
@@ -301,4 +301,4 @@ docker run -d -e REMOVE_OLD_MODS=TRUE -e MODPACK=http://www.example.com/mods/mod
!!! danger
All content of the `mods` or `plugins` directory will be deleted before unpacking new content from the MODPACK or MODS.
Files in the `mods` and `plugins` directories that match `REMOVE_OLD_MODS_INCLUDE` (by default, jars and `*-version.json` files directly inside them) will be deleted before unpacking new content from the MODPACK or MODS.