</span></code></pre></div><p>And then add it to the <code>DOCKER_MODS_EXTRA_HOSTS</code> env using the full protocol and port, separating multiple servers with a pipe (<code>|</code>), e.g.</p><divclass="language-yaml highlight"><pre><span></span><code><spanid=__span-1-1><aid=__codelineno-1-1name=__codelineno-1-1href=#__codelineno-1-1></a><spanclass=w></span><spanclass="p p-Indicator">-</span><spanclass=w></span><spanclass="l l-Scalar l-Scalar-Plain">DOCKER_MODS_EXTRA_HOSTS=tcp://host1.example.com:2375|tcp://host2.example.com:2375|tcp://192.168.0.5:2375</span>
</span></code></pre></div><p>As above you will need to mount the <code>/modcache</code> folder on your remote host(s), ensuring it is mapped for all participating containers.</p><h2id=usage>Usage<aclass=headerlinkhref=#usagetitle="Permanent link">¶</a></h2><p>To help you get started creating a container from this image you can either use docker compose or the docker cli.</p><blockquote><p>[!NOTE] Unless a parameter is flaged as 'optional', it is <em>mandatory</em> and a value must be provided.</p></blockquote><h3id=docker-compose-recommended-click-here-for-more-info>docker compose (recommended, <ahref=https://docs.linuxserver.io/general/docker-compose>click here for more info</a>)<aclass=headerlinkhref=#docker-compose-recommended-click-here-for-more-infotitle="Permanent link">¶</a></h3><divclass="language-yaml highlight"><pre><span></span><code><spanid=__span-2-1><aid=__codelineno-2-1name=__codelineno-2-1href=#__codelineno-2-1></a><spanclass=nn>---</span>
</span></code></pre></div><h3id=docker-cli-click-here-for-more-info>docker cli (<ahref=https://docs.docker.com/engine/reference/commandline/cli/>click here for more info</a>)<aclass=headerlinkhref=#docker-cli-click-here-for-more-infotitle="Permanent link">¶</a></h3><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-3-1><aid=__codelineno-3-1name=__codelineno-3-1href=#__codelineno-3-1></a>docker<spanclass=w></span>run<spanclass=w></span>-d<spanclass=w></span><spanclass=se>\</span>
</span></code></pre></div><h2id=parameters>Parameters<aclass=headerlinkhref=#parameterstitle="Permanent link">¶</a></h2><p>Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <code><external>:<internal></code> respectively. For example, <code>-p 8080:80</code> would expose port <code>80</code> from inside the container to be accessible from the host's IP on port <code>8080</code> outside the container.</p><table><thead><tr><thstyle="text-align: center;">Parameter</th><th>Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>-e DOCKER_MODS=</code></td><td>Pipe-delimited (<code>\|</code>) list of mods to download</td></tr><tr><tdstyle="text-align: center;"><code>-e DOCKER_HOST=</code></td><td>Specify the docker endpoint to use if not using the docker.sock</td></tr><tr><tdstyle="text-align: center;"><code>-e DOCKER_MODS_EXTRA_HOSTS=</code></td><td>Pipe-delimited (<code>\|</code>) list of additional hosts to query & download mods for. See app setup section for details.</td></tr><tr><tdstyle="text-align: center;"><code>-v /modcache</code></td><td>Modmanager mod storage.</td></tr><tr><tdstyle="text-align: center;"><code>-v /var/run/docker.sock:ro</code></td><td>Mount the host docker socket into the container.</td></tr></tbody></table><h2id=support-info>Support Info<aclass=headerlinkhref=#support-infotitle="Permanent link">¶</a></h2><ul><li>Shell access whilst the container is running:</li></ul><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-4-1><aid=__codelineno-4-1name=__codelineno-4-1href=#__codelineno-4-1></a>docker<spanclass=w></span><spanclass=nb>exec</span><spanclass=w></span>-it<spanclass=w></span>modmanager<spanclass=w></span>/bin/sh
</span></code></pre></div><ul><li>To monitor the logs of the container in realtime:</li></ul><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-5-1><aid=__codelineno-5-1name=__codelineno-5-1href=#__codelineno-5-1></a>docker<spanclass=w></span>logs<spanclass=w></span>-f<spanclass=w></span>modmanager
</span></code></pre></div><ul><li>Container version number:</li></ul><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-6-1><aid=__codelineno-6-1name=__codelineno-6-1href=#__codelineno-6-1></a>docker<spanclass=w></span>inspect<spanclass=w></span>-f<spanclass=w></span><spanclass=s1>'{{ index .Config.Labels "build_version" }}'</span><spanclass=w></span>modmanager
</span></code></pre></div><ul><li>Image version number:</li></ul><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-7-1><aid=__codelineno-7-1name=__codelineno-7-1href=#__codelineno-7-1></a>docker<spanclass=w></span>inspect<spanclass=w></span>-f<spanclass=w></span><spanclass=s1>'{{ index .Config.Labels "build_version" }}'</span><spanclass=w></span>lscr.io/linuxserver/modmanager:latest
</span></code></pre></div><h2id=updating-info>Updating Info<aclass=headerlinkhref=#updating-infotitle="Permanent link">¶</a></h2><p>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 <ahref=#application-setup>Application Setup</a> section above to see if it is recommended for the image.</p><p>Below are the instructions for updating containers:</p><h3id=via-docker-compose>Via Docker Compose<aclass=headerlinkhref=#via-docker-composetitle="Permanent link">¶</a></h3><ul><li>Update images:</li><li>All images:</li></ul><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-8-1><aid=__codelineno-8-1name=__codelineno-8-1href=#__codelineno-8-1></a>docker<spanclass=w></span>compose<spanclass=w></span>pull
</span></code></pre></div><ul><li>You can also remove the old dangling images:</li></ul><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-12-1><aid=__codelineno-12-1name=__codelineno-12-1href=#__codelineno-12-1></a>docker<spanclass=w></span>image<spanclass=w></span>prune
</span></code></pre></div><h3id=via-docker-run>Via Docker Run<aclass=headerlinkhref=#via-docker-runtitle="Permanent link">¶</a></h3><ul><li>Update the image:</li></ul><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-13-1><aid=__codelineno-13-1name=__codelineno-13-1href=#__codelineno-13-1></a>docker<spanclass=w></span>pull<spanclass=w></span>lscr.io/linuxserver/modmanager:latest
</span></code></pre></div><ul><li>Stop the running container:</li></ul><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-14-1><aid=__codelineno-14-1name=__codelineno-14-1href=#__codelineno-14-1></a>docker<spanclass=w></span>stop<spanclass=w></span>modmanager
</span></code></pre></div><ul><li>Delete the container:</li></ul><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-15-1><aid=__codelineno-15-1name=__codelineno-15-1href=#__codelineno-15-1></a>docker<spanclass=w></span>rm<spanclass=w></span>modmanager
</span></code></pre></div><ul><li>You can also remove the old dangling images:</li></ul><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-16-1><aid=__codelineno-16-1name=__codelineno-16-1href=#__codelineno-16-1></a>docker<spanclass=w></span>image<spanclass=w></span>prune
</span></code></pre></div><h3id=image-update-notifications-diun-docker-image-update-notifier>Image Update Notifications - Diun (Docker Image Update Notifier)<aclass=headerlinkhref=#image-update-notifications-diun-docker-image-update-notifiertitle="Permanent link">¶</a></h3><blockquote><p>[!TIP] We recommend <ahref=https://crazymax.dev/diun/>Diun</a> for update notifications. Other tools that automatically update containers unattended are not recommended or supported.</p></blockquote><h2id=building-locally>Building locally<aclass=headerlinkhref=#building-locallytitle="Permanent link">¶</a></h2><p>If you want to make local modifications to these images for development purposes or just to customize the logic:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-17-1><aid=__codelineno-17-1name=__codelineno-17-1href=#__codelineno-17-1></a>git<spanclass=w></span>clone<spanclass=w></span>https://github.com/linuxserver/docker-modmanager.git
</span></code></pre></div><p>The ARM variants can be built on x86_64 hardware and vice versa using <code>lscr.io/linuxserver/docker-qemu-static</code></p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-18-1><aid=__codelineno-18-1name=__codelineno-18-1href=#__codelineno-18-1></a>docker<spanclass=w></span>run<spanclass=w></span>--rm<spanclass=w></span>--privileged<spanclass=w></span>lscr.io/linuxserver/docker-qemu-static<spanclass=w></span>--reset
