Modmanager

Docker

This container needs special attention. Please check https://hub.docker.com/r/linuxserver/modmanager for details.

Image details

Pulls: 513k

Architectures: amd64, arm64

Image size: 22 MB

User: linuxserverci

Created: Jan 04, 2025

Updated: 1 day ago

Status: active

Configuration

Type

Container

Platform

linux

Image

linuxserver/modmanager:latest

Ports

80:80/tcp

Volumes

/config : /srv/lsio/modmanager/config

Env vars

PUID=1000PGID=1000TZ=Etc/UTC

Restart

unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/modmanager/config

Installation

Ensure both Docker and Portainer are installed, and up-to-date
Log into your Portainer web UI
Under Settings → App Templates, paste the below URL
Head to Home → App Templates, and the list of apps will show up
Select the app you wish to deploy, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json

Show Me

docker run -d --name Modmanager \
  -p 80:80/tcp \
  -e 'PUID=1000' \
  -e 'PGID=1000' \
  -e 'TZ=Etc/UTC' \
  -v /srv/lsio/modmanager/config:/config \
  --restart=unless-stopped \
  linuxserver/modmanager:latest

Save this file as compose.yaml and run docker compose up -d
Use this only as a guide.

services:
  modmanager:
    image: linuxserver/modmanager:latest
    ports:
      - 80:80/tcp
    volumes:
      - /srv/lsio/modmanager/config:/config
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
    restart: unless-stopped

Save this file as modmanager-stack.yml, then from a manager node, run docker stack deploy -c modmanager-stack.yml modmanager

version: '3.8'
services:
  modmanager:
    image: linuxserver/modmanager:latest
    ports:
      - 80:80/tcp
    volumes:
      - /srv/lsio/modmanager/config:/config
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
    deploy:
      restart_policy:
        condition: any

Save each file below into a folder, then run kubectl apply -f .
Written for k3s, but works on any cluster: bind mounts use hostPath, named volumes get a persistent volume claim, and ports are exposed via a LoadBalancer service.

`modmanager-deployment.yaml`

apiVersion: apps/v1
kind: Deployment
metadata:
  name: modmanager
  labels:
    app: modmanager
spec:
  replicas: 1
  selector:
    matchLabels:
      app: modmanager
  template:
    metadata:
      labels:
        app: modmanager
    spec:
      containers:
        - name: modmanager
          image: linuxserver/modmanager:latest
          env:
            - name: PUID
              value: '1000'
            - name: PGID
              value: '1000'
            - name: TZ
              value: Etc/UTC
          ports:
            - containerPort: 80
              protocol: TCP
          volumeMounts:
            - name: modmanager-data-0
              mountPath: /config
      volumes:
        - name: modmanager-data-0
          hostPath:
            path: /srv/lsio/modmanager/config

`modmanager-service.yaml`

apiVersion: v1
kind: Service
metadata:
  name: modmanager
spec:
  type: LoadBalancer
  selector:
    app: modmanager
  ports:
    - name: 80-tcp
      port: 80
      targetPort: 80
      protocol: TCP

Save this file as ~/.config/containers/systemd/modmanager.container

[Unit]
Description=Modmanager

[Container]
Image=linuxserver/modmanager:latest
ContainerName=modmanager
PublishPort=80:80/tcp
Environment=PUID=1000
Environment=PGID=1000
Environment=TZ=Etc/UTC
Volume=/srv/lsio/modmanager/config:/config

[Service]
Restart=always

[Install]
WantedBy=default.target

Then reload systemd and start the service:

systemctl --user daemon-reload
systemctl --user start modmanager

For a system-wide service, use /etc/containers/systemd/ and drop --user.

For more installation options, see the Documentation in our GitHub repo

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.
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-\ | | arm64 | ✅ | arm64v8-\ |

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 the built-in DOCKER_HOST environment variable). Whichever option you choose the appropriate DOCKER_MODS environment variable must still be present on the containers that need to install them.
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.
Modmanager is only supported for use with Linuxserver images built after 2025-01-01, while it may work with 3rd party containers using our images as a base we will not provide support for them.

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 therefore also have root access on the host. The docker API has no built-in way to set limitations on access, however, you can use a proxy for docker.sock via a solution like our docker socket proxy, which adds the ability to limit API access to specific endpoints.

Multiple Hosts

>!NOTE >Make sure you fully understand what you're doing before you try and set this up as there are lots of ways it can go wrong if you're just guessing.
Modmanager can query & download mods for remote hosts, as well as the one on which it is installed. At a very basic level if you're just using the DOCKER_MODS env and not docker discovery, simply mount the /modcache folder on your remote host(s), ensuring it is mapped for all participating containers.
If you are using docker discovery, our only supported means for connecting to remote hosts is our socket proxy container. Run an instance on each remote host:
>!WARNING >DO NOT expose a socket proxy to your LAN if it allows any write operations (POST=1, ALLOW_RESTART=1, etc) or exposes any API elements that are not absolutely necessary. NEVER expose a socket proxy to your WAN.

modmanager-dockerproxy:
  image: lscr.io/linuxserver/socket-proxy:latest
  container_name: modmanager-dockerproxy
  environment:
    - CONTAINERS=1
    - POST=0
  volumes:
    - /var/run/docker.sock:/var/run/docker.sock:ro
  tmpfs:
    - /run
  ports:
    - 2375:2375
  restart: unless-stopped
  read_only: true

And then add it to the DOCKER_MODS_EXTRA_HOSTS env using the full protocol and port, separating multiple servers with a pipe (|), e.g.

- DOCKER_MODS_EXTRA_HOSTS=tcp://host1.example.com:2375|tcp://host2.example.com:2375|tcp://192.168.0.5:2375

As above you will need to mount the /modcache folder on your remote host(s), ensuring it is mapped for all participating containers.

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`
      - DOCKER_MODS_EXTRA_HOSTS= `#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` \
  -e DOCKER_MODS_EXTRA_HOSTS= `#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 | | -e DOCKER_MODS_EXTRA_HOSTS= | Pipe-delimited (\|) list of additional hosts to query & download mods for. See app setup section for details. | | -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:
```bash docker compose pull ```
Single image:
```bash docker compose pull modmanager ```

Update containers:

All containers:
```bash docker compose up -d ```
Single container:
```bash 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 x8664 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
05.07.26: - Rebase to Alpine 3.24.
28.12.25: - Rebase to Alpine 3.23.
05.07.25: - Rebase to Alpine 3.22.
05.01.25: - Support multiple hosts.
22.12.24: - Initial Release.

Serve Modmanager on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxy Domain App port Upstream

Proxying modmanager.example.com to http://Modmanager:80

Add this to your Caddyfile

modmanager.example.com {
	reverse_proxy http://Modmanager:80
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

In Portainer, go to Containers, click the container, then Logs. Or run docker logs Modmanager
Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:80 failed: port is already allocated", something else on your server is using that port.

Find what's using it: sudo ss -tlnp | grep :80
Stop the other service, or pick a different host port. In 80:80 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

Use your server's real IP: http://your-server-ip:80. The 0.0.0.0 link Portainer shows isn't a real address.
Give it a minute after first deploy, Modmanager can take a while to initialise.
Make sure your firewall allows the port, e.g. sudo ufw allow 80

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/modmanager/config
Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/modmanager:latest

"manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
"toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
"no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

This image supports: amd64, arm64
Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

Check the logs right after a restart, the last few lines before it died are the useful ones.
Get the exit code with docker inspect Modmanager --format '{{.State.ExitCode}}'
Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

Bug within the app: Open an issue within Modmanager's repo
Template not working: Open an issue on technorabilia/portainer-templates
This website not working: Open an issue on lissy93/portainer-templates

Similar apps

Docker Container Stats Docker Lazytainer Docker

Qemu-static Docker

Registry Docker

Registry (cache) Docker

Socket-proxy Docker

Watchtower {shmolf} Docker