README.md

The LinuxServer.io team brings you another container release.

Find us at:

• Blog - all the things you can do with our containers including How-To guides, opinions and much more!
• Discord - realtime support / chat with the community and the team.
• Discourse - post on our community forum.
• Fleet - an online web interface which displays all of our maintained images.
• GitHub - view the source for all of our repositories.
• Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/modmanager

Modmanager is a centralised tool for downloading and updating docker mods for all your other Linuxserver containers.

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/modmanager:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64v8-<version tag>
armhf	❌

Application Setup

You can specify mods to download via the DOCKER_MODS environment variable like any other container, or allow discovery through docker by mounting the docker socket into the container (or configuring a suitable alternative endpoint via DOCKER_HOST).

The Modmanager container will download all needed mods on startup and then check for updates every 6 hours; if you're using docker discovery it will automatically pick up any new mods.

You can then mount your /modcache path into any other Linuxserver container and they will pull their mods from there rather than downloading them each time.

If a mod requires additional packages to be installed, each container will still need to download them each time it is recreated.

Note that the Modmanager container itself does not support applying mods or custom files/services.

Security considerations

Mapping docker.sock is a potential security liability because docker has root access on the host and any process that has full access to docker.sock would also have root access on the host. Docker api has no built-in way to set limitations on access, however, you can use a proxy for the docker.sock via a solution like our docker socket proxy, which adds the ability to limit access. Then you would just set DOCKER_HOST= environment variable to point to the proxy address.

Usage

To help you get started creating a container from this image you can either use docker compose or the docker cli.

Note

Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.

docker compose (recommended, click here for more info)

---
services:
  modmanager:
    image: lscr.io/linuxserver/modmanager:latest
    container_name: modmanager
    environment:
      - DOCKER_MODS= `#optional`
      - DOCKER_HOST= `#optional`
    volumes:
      - /path/to/modcache:/modcache
      - /var/run/docker.sock:/var/run/docker.sock:ro `#optional`
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=modmanager \
  -e DOCKER_MODS= `#optional` \
  -e DOCKER_HOST= `#optional` \
  -v /path/to/modcache:/modcache \
  -v /var/run/docker.sock:/var/run/docker.sock:ro `#optional` \
  --restart unless-stopped \
  lscr.io/linuxserver/modmanager:latest

Parameters

Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Parameter	Function
-e DOCKER_MODS=	Pipe-delimited (|) list of mods to download
-e DOCKER_HOST=	Specify the docker endpoint to use if not using the docker.sock
-v /modcache	Modmanager mod storage.
-v /var/run/docker.sock:ro	Mount the host docker socket into the container.

Support Info

• Shell access whilst the container is running:

docker exec -it modmanager /bin/sh

• To monitor the logs of the container in realtime:

docker logs -f modmanager

• Container version number:

docker inspect -f '{{ index .Config.Labels "build_version" }}' modmanager

• Image version number:

docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/modmanager:latest

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose

• Update images:

  • All images:

  docker compose pull

  • Single image:

  docker compose pull modmanager

• Update containers:

  • All containers:

  docker compose up -d

  • Single container:

  docker compose up -d modmanager

• You can also remove the old dangling images:

docker image prune

Via Docker Run

• Update the image:

docker pull lscr.io/linuxserver/modmanager:latest

• Stop the running container:

docker stop modmanager

• Delete the container:

docker rm modmanager

• You can also remove the old dangling images:

docker image prune

Image Update Notifications - Diun (Docker Image Update Notifier)

Tip

We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-modmanager.git
cd docker-modmanager
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/modmanager:latest .

The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/docker-qemu-static

docker run --rm --privileged lscr.io/linuxserver/docker-qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

• 22.12.24: - Initial Release.