Skip to content

Conversation

Crafter-Y
Copy link
Contributor

Related to: #3658

This PR aims to provide a way to download configs or other files before server startup in order to patch them.

With this change, files can be downloaded by using the DOWNLOAD_EXTRA_CONFIGS environment variable.

For example:

DOWNLOAD_EXTRA_CONFIGS: "plugins/test<https://raw.githubusercontent.com/itzg/docker-minecraft-server/refs/heads/master/.editorconfig,plugins/WorldEdit<https://raw.githubusercontent.com/itzg/docker-minecraft-server/refs/heads/master/Dockerfile"

or

DOWNLOAD_EXTRA_CONFIGS: |
  plugins/test<https://raw.githubusercontent.com/itzg/docker-minecraft-server/refs/heads/master/.editorconfig
  plugins/WorldEdit<https://raw.githubusercontent.com/itzg/docker-minecraft-server/refs/heads/master/Dockerfile

The backend mc-image-helper function mcopy was enhanced by itzg/mc-image-helper#641

There is currently no option to provide file listings like with MODRINTH_PROJECTS since mcopy needs an extra flag for that.

I also did not try to integrate the existing downloading of config files into this, because I feel like it should stay seperate.

I haven't documented the change yet, because I don't know where to put it best. Maybe the /configuration/misc-options/ ?

@itzg
Copy link
Owner

itzg commented Sep 30, 2025

I haven't documented the change yet, because I don't know where to put it best. Maybe the /configuration/misc-options/ ?

I see what you mean that there's not a perfect spot for it. I think I prefer the one you found. Another that might be ok is the top level https://docker-minecraft-server.readthedocs.io/en/latest/mods-and-plugins/ since it mentions /config mount.

Copy link
Owner

@itzg itzg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code changes look good

@Crafter-Y
Copy link
Contributor Author

I don't know why CI fails. Docs are good like that?

@itzg
Copy link
Owner

itzg commented Sep 30, 2025

I don't know why CI fails. Docs are good like that?

I'll re-run. I think it was just waiting for my approval.

Copy link
Owner

@itzg itzg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs look great. I'll see what the build thinks 😉

@itzg itzg merged commit b7859d7 into itzg:master Oct 1, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants