2025-01-16 13:25:44 +00:00
<!doctype html> < html lang = en class = no-js > < head > < meta charset = utf-8 > < meta name = viewport content = "width=device-width,initial-scale=1" > < meta name = description content = "Welcome to the home of the LinuxServer.io documentation!" > < meta name = author content = LinuxServer.io > < link href = https://docs.linuxserver.io/general/container-customization/ rel = canonical > < link href = ../running-our-containers/ rel = prev > < link href = ../docker-compose/ rel = next > < link rel = icon href = ../../assets/favicon.ico > < meta name = generator content = "mkdocs-1.6.1, mkdocs-material-9.5.49" > < title > Customizing LinuxServer Containers - LinuxServer.io< / title > < link rel = stylesheet href = ../../assets/stylesheets/main.6f8fc17f.min.css > < link rel = stylesheet href = ../../assets/stylesheets/palette.06af60db.min.css > < link rel = preconnect href = https://fonts.gstatic.com crossorigin > < link rel = stylesheet href = "https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback" > < style > : root { --md-text-font : "Roboto" ; --md-code-font : "Roboto Mono" } < / style > < link rel = stylesheet href = ../../assets/stylesheets/mkdocs_d2_plugin.css > < script > _ _md _scope = new URL ( "../.." , location ) , _ _md _hash = e => [ ... e ] . reduce ( ( ( e , _ ) => ( e << 5 ) - e + _ . charCodeAt ( 0 ) ) , 0 ) , _ _md _get = ( e , _ = localStorage , t = _ _md _scope ) => JSON . parse ( _ . getItem ( t . pathname + "." + e ) ) , _ _md _set = ( e , _ , t = localStorage , a = _ _md _scope ) => { try { t . setItem ( a . pathname + "." + e , JSON . stringify ( _ ) ) } catch ( e ) { } } < / script > < / head > < body dir = ltr data-md-color-scheme = default data-md-color-primary = purple data-md-color-accent = indigo > < input class = md-toggle data-md-toggle = drawer type = checkbox id = __drawer autocomplete = off > < input class = md-toggle data-md-toggle = search type = checkbox id = __search autocomplete = off > < label class = md-overlay for = __drawer > < / label > < div data-md-component = skip > < a href = #customizing-linuxserver-containers class = md-skip > Skip to content < / a > < / div > < div data-md-component = announce > < / div > < header class = md-header data-md-component = header > < nav class = "md-header__inner md-grid" aria-label = Header > < a href = ../.. title = LinuxServer.io class = "md-header__button md-logo" aria-label = LinuxServer.io data-md-component = logo > < img src = ../../assets/icon.svg alt = logo > < / a > < label class = "md-header__button md-icon" for = __drawer > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z" / > < / svg > < / label > < div class = md-header__title data-md-component = header-title > < div class = md-header__ellipsis > < div class = md-header__topic > < span class = md-ellipsis > LinuxServer.io < / span > < / div > < div class = md-header__topic data-md-component = header-topic > < span class = md-ellipsis > Customizing LinuxServer Containers < / span > < / div > < / div > < / div > < form class = md-header__option data-md-component = palette > < input class = md-option data-md-color-media = "(prefers-color-scheme: light)" data-md-color-scheme = default data-md-color-primary = purple data-md-color-accent = indigo aria-label = "Switch to dark mode" type = radio name = __palette id = __palette_0 > < label class = "md-header__button md-icon" title = "Switch to dark mode" for = __palette_1 hidden > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z" / > < / svg > < / label > < input class = md-option data-md-color-media = "(prefers-color-scheme: dark)" data-md-color-scheme = slate data-md-color-primary = purple data-md-color-accent = indigo aria-label = "Switch to light mode" type = radio name = __palette id = __palette_1 > < label class = "md-header__button md-icon" title = "Switch to light mode" for = __palette_0 hidden > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z" / > < / svg > < / label > < / form > < script > v a r p a l e t t e = _ _ m d _ g e t ( " _ _ p a l e t t e " ) ; i f ( p a l e t t e & & p a l e t t e . c o l o r )
2023-08-02 18:13:08 +00:00
< / span > < span id = __span-0-2 > < a id = __codelineno-0-2 name = __codelineno-0-2 href = #__codelineno-0-2 > < / a > < span class = w > < / span > < span class = nt > bar< / span > < span class = p > :< / span >
< / span > < span id = __span-0-3 > < a id = __codelineno-0-3 name = __codelineno-0-3 href = #__codelineno-0-3 > < / a > < span class = w > < / span > < span class = nt > volumes< / span > < span class = p > :< / span >
< / span > < span id = __span-0-4 > < a id = __codelineno-0-4 name = __codelineno-0-4 href = #__codelineno-0-4 > < / a > < span class = w > < / span > < span class = "p p-Indicator" > -< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > /home/foo/appdata/bar:/config< / span >
< / span > < span id = __span-0-5 > < a id = __codelineno-0-5 name = __codelineno-0-5 href = #__codelineno-0-5 > < / a > < span class = w > < / span > < span class = "p p-Indicator" > -< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > /home/foo/appdata/my-custom-files:/custom-cont-init.d:ro< / span >
< / span > < / code > < / pre > < / div > < p > if using compose. Where possible, to improve security, we recommend mounting them read-only (< code > :ro< / code > ) so that container processes cannot write to the location.< / p > < p > One example use case is our Piwigo container has a plugin that supports video, but requires ffmpeg to be installed. No problem. Add this bad boy into a script file (can be named anything) and you're good to go.< / p > < div class = "language-shell highlight" > < pre > < span > < / span > < code > < span id = __span-1-1 > < a id = __codelineno-1-1 name = __codelineno-1-1 href = #__codelineno-1-1 > < / a > < span class = ch > #!/bin/bash< / span >
< / span > < span id = __span-1-2 > < a id = __codelineno-1-2 name = __codelineno-1-2 href = #__codelineno-1-2 > < / a >
< / span > < span id = __span-1-3 > < a id = __codelineno-1-3 name = __codelineno-1-3 href = #__codelineno-1-3 > < / a > < span class = nb > echo< / span > < span class = w > < / span > < span class = s2 > " **** installing ffmpeg ****" < / span >
< / span > < span id = __span-1-4 > < a id = __codelineno-1-4 name = __codelineno-1-4 href = #__codelineno-1-4 > < / a > apk< span class = w > < / span > add< span class = w > < / span > --no-cache< span class = w > < / span > ffmpeg
2023-10-25 22:06:42 +00:00
< / span > < / code > < / pre > < / div > < div class = "admonition note" > < p class = admonition-title > Note< / p > < p > The folder < code > /custom-cont-init.d< / code > needs to be owned by root! If this is not the case, this folder will be renamed and a new (empty) folder will be created. This is to prevent remote code execution by putting scripts in the aforementioned folder.< / p > < / div > < h2 id = custom-services > Custom Services< a class = headerlink href = #custom-services title = "Permanent link" > ¶ < / a > < / h2 > < p > There might also be a need to run an additional service in a container alongside what we already package. Similarly to the custom scripts, just create a new directory at < code > /custom-services.d< / code > . The files in this directory should be named after the service they will be running. Similar to with custom scripts you will need to mount this folder like any other volume if you wish to make use of it. e.g. < code > -v /home/foo/appdata/my-custom-services:/custom-services.d< / code > if using the Docker CLI or< / p > < div class = "language-yaml highlight" > < pre > < span > < / span > < code > < span id = __span-2-1 > < a id = __codelineno-2-1 name = __codelineno-2-1 href = #__codelineno-2-1 > < / a > < span class = nt > services< / span > < span class = p > :< / span >
2023-08-02 18:13:08 +00:00
< / span > < span id = __span-2-2 > < a id = __codelineno-2-2 name = __codelineno-2-2 href = #__codelineno-2-2 > < / a > < span class = w > < / span > < span class = nt > bar< / span > < span class = p > :< / span >
< / span > < span id = __span-2-3 > < a id = __codelineno-2-3 name = __codelineno-2-3 href = #__codelineno-2-3 > < / a > < span class = w > < / span > < span class = nt > volumes< / span > < span class = p > :< / span >
< / span > < span id = __span-2-4 > < a id = __codelineno-2-4 name = __codelineno-2-4 href = #__codelineno-2-4 > < / a > < span class = w > < / span > < span class = "p p-Indicator" > -< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > /home/foo/appdata/bar:/config< / span >
< / span > < span id = __span-2-5 > < a id = __codelineno-2-5 name = __codelineno-2-5 href = #__codelineno-2-5 > < / a > < span class = w > < / span > < span class = "p p-Indicator" > -< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > /home/foo/appdata/my-custom-services:/custom-services.d:ro< / span >
< / span > < / code > < / pre > < / div > < p > if using compose. Where possible, to improve security, we recommend mounting them read-only (< code > :ro< / code > ) so that container processes cannot write to the location.< / p > < p > Running cron in our containers is now as simple as a single file. Drop this script in < code > /custom-services.d/cron< / code > and it will run automatically in the container:< / p > < div class = "language-shell highlight" > < pre > < span > < / span > < code > < span id = __span-3-1 > < a id = __codelineno-3-1 name = __codelineno-3-1 href = #__codelineno-3-1 > < / a > < span class = ch > #!/usr/bin/with-contenv bash< / span >
< / span > < span id = __span-3-2 > < a id = __codelineno-3-2 name = __codelineno-3-2 href = #__codelineno-3-2 > < / a >
< / span > < span id = __span-3-3 > < a id = __codelineno-3-3 name = __codelineno-3-3 href = #__codelineno-3-3 > < / a > /usr/sbin/crond< span class = w > < / span > -f< span class = w > < / span > -S< span class = w > < / span > -l< span class = w > < / span > < span class = m > 0< / span > < span class = w > < / span > -c< span class = w > < / span > /etc/crontabs
2023-10-25 22:06:42 +00:00
< / span > < / code > < / pre > < / div > < div class = "admonition note" > < p class = admonition-title > Note< / p > < p > With this example, you will most likely need to have cron installed via a custom script using the technique in the previous section, and will need to populate the crontab.< / p > < / div > < div class = "admonition note" > < p class = admonition-title > Note< / p > < p > The folder < code > /custom-services.d< / code > needs to be owned by root! If this is not the case, this folder will be renamed and a new (empty) folder will be created. This is to prevent remote code execution by putting scripts in the aforementioned folder.< / p > < / div > < h2 id = docker-mods > Docker Mods< a class = headerlink href = #docker-mods title = "Permanent link" > ¶ < / a > < / h2 > < p > In most cases if you needed to write some kind of custom logic to get a plugin to work or to use some kind of popular external service you will not be the only one that finds this logic useful.< / p > < p > If you would like to publish and support your hard work we provide a system for a user to pass a single environment variable to the container to ingest your custom modifications.< / p > < p > We consume Mods from Dockerhub and in order to publish one following our guide, you only need a Github Account and a Dockerhub account. < a href = https://github.com/linuxserver/docker-mods > (Our guide and example code can be found here)< / a > < / p > < p > Essentially it is a system that stashes a tarball of scripts and any other files you need in an image layer on Dockerhub. When we spin up the container we will download this tarball and extract it to /.< / p > < p > This allows community members to publish a relatively static pile of logic that will always be applied to an end user's up to date Linuxserver.io container.< / p > < p > An example of how this logic can be used to greatly expand the functionality of our base containers would be to add VPN support to a Transmission container:< / p > < div class = "language-shell highlight" > < pre > < span > < / span > < code > < span id = __span-4-1 > < a id = __codelineno-4-1 name = __codelineno-4-1 href = #__codelineno-4-1 > < / a > docker< span class = w > < / span > create< span class = w > < / span > < span class = se > \< / span >
2023-08-02 18:13:08 +00:00
< / span > < span id = __span-4-2 > < a id = __codelineno-4-2 name = __codelineno-4-2 href = #__codelineno-4-2 > < / a > < span class = w > < / span > --name< span class = o > =< / span > transmission< span class = w > < / span > < span class = se > \< / span >
< / span > < span id = __span-4-3 > < a id = __codelineno-4-3 name = __codelineno-4-3 href = #__codelineno-4-3 > < / a > < span class = w > < / span > --cap-add< span class = o > =< / span > NET_ADMIN< span class = w > < / span > < span class = se > \< / span >
< / span > < span id = __span-4-4 > < a id = __codelineno-4-4 name = __codelineno-4-4 href = #__codelineno-4-4 > < / a > < span class = w > < / span > -e< span class = w > < / span > < span class = nv > PUID< / span > < span class = o > =< / span > < span class = m > 1000< / span > < span class = w > < / span > < span class = se > \< / span >
< / span > < span id = __span-4-5 > < a id = __codelineno-4-5 name = __codelineno-4-5 href = #__codelineno-4-5 > < / a > < span class = w > < / span > -e< span class = w > < / span > < span class = nv > PGID< / span > < span class = o > =< / span > < span class = m > 1000< / span > < span class = w > < / span > < span class = se > \< / span >
< / span > < span id = __span-4-6 > < a id = __codelineno-4-6 name = __codelineno-4-6 href = #__codelineno-4-6 > < / a > < span class = w > < / span > -e< span class = w > < / span > < span class = nv > DOCKER_MODS< / span > < span class = o > =< / span > taisun/config-mods:pia< span class = w > < / span > < span class = se > \< / span >
< / span > < span id = __span-4-7 > < a id = __codelineno-4-7 name = __codelineno-4-7 href = #__codelineno-4-7 > < / a > < span class = w > < / span > -e< span class = w > < / span > < span class = nv > PIAUSER< / span > < span class = o > =< / span > pmyuser< span class = w > < / span > < span class = se > \< / span >
< / span > < span id = __span-4-8 > < a id = __codelineno-4-8 name = __codelineno-4-8 href = #__codelineno-4-8 > < / a > < span class = w > < / span > -e< span class = w > < / span > < span class = nv > PIAPASS< / span > < span class = o > =< / span > mypassword< span class = w > < / span > < span class = se > \< / span >
< / span > < span id = __span-4-9 > < a id = __codelineno-4-9 name = __codelineno-4-9 href = #__codelineno-4-9 > < / a > < span class = w > < / span > -e< span class = w > < / span > < span class = nv > PIAENDPOINT< / span > < span class = o > =< / span > < span class = s2 > " US New York City" < / span > < span class = w > < / span > < span class = se > \< / span >
< / span > < span id = __span-4-10 > < a id = __codelineno-4-10 name = __codelineno-4-10 href = #__codelineno-4-10 > < / a > < span class = w > < / span > -e< span class = w > < / span > < span class = nv > TZ< / span > < span class = o > =< / span > US/Eastern< span class = w > < / span > < span class = se > \< / span >
< / span > < span id = __span-4-11 > < a id = __codelineno-4-11 name = __codelineno-4-11 href = #__codelineno-4-11 > < / a > < span class = w > < / span > -p< span class = w > < / span > < span class = m > 9091< / span > :9091< span class = w > < / span > < span class = se > \< / span >
< / span > < span id = __span-4-12 > < a id = __codelineno-4-12 name = __codelineno-4-12 href = #__codelineno-4-12 > < / a > < span class = w > < / span > -p< span class = w > < / span > < span class = m > 51413< / span > :51413< span class = w > < / span > < span class = se > \< / span >
< / span > < span id = __span-4-13 > < a id = __codelineno-4-13 name = __codelineno-4-13 href = #__codelineno-4-13 > < / a > < span class = w > < / span > -p< span class = w > < / span > < span class = m > 51413< / span > :51413/udp< span class = w > < / span > < span class = se > \< / span >
< / span > < span id = __span-4-14 > < a id = __codelineno-4-14 name = __codelineno-4-14 href = #__codelineno-4-14 > < / a > < span class = w > < / span > -v< span class = w > < / span > path< span class = w > < / span > to< span class = w > < / span > data:/config< span class = w > < / span > < span class = se > \< / span >
< / span > < span id = __span-4-15 > < a id = __codelineno-4-15 name = __codelineno-4-15 href = #__codelineno-4-15 > < / a > < span class = w > < / span > -v< span class = w > < / span > path< span class = w > < / span > to< span class = w > < / span > downloads:/downloads< span class = w > < / span > < span class = se > \< / span >
< / span > < span id = __span-4-16 > < a id = __codelineno-4-16 name = __codelineno-4-16 href = #__codelineno-4-16 > < / a > < span class = w > < / span > -v< span class = w > < / span > path< span class = w > < / span > to< span class = w > < / span > watch< span class = w > < / span > folder:/watch< span class = w > < / span > < span class = se > \< / span >
< / span > < span id = __span-4-17 > < a id = __codelineno-4-17 name = __codelineno-4-17 href = #__codelineno-4-17 > < / a > < span class = w > < / span > --restart< span class = w > < / span > unless-stopped< span class = w > < / span > < span class = se > \< / span >
< / span > < span id = __span-4-18 > < a id = __codelineno-4-18 name = __codelineno-4-18 href = #__codelineno-4-18 > < / a > < span class = w > < / span > linuxserver/transmission
2025-01-15 20:09:05 +00:00
< / span > < / code > < / pre > < / div > < p > The source code for this mod can be found < a href = https://github.com/Taisun-Docker/config-mods/tree/master/pia > here< / a > .< / p > < div class = "admonition note" > < p class = admonition-title > Note< / p > < p > When pulling in logic from external sources practice caution and trust the sources/community you get them from, as there are extreme security implications to consuming files from sources outside of our control.< / p > < / div > < h2 id = we-are-here-to-help > We are here to help< a class = headerlink href = #we-are-here-to-help title = "Permanent link" > ¶ < / a > < / h2 > < p > If you are interested in writing custom logic and possibly sharing it with the community in the form of a < a href = https://github.com/linuxserver/docker-mods > Docker Mod< / a > we are always available to help you out.< / p > < p > Our < a href = https://discord.gg/YWrKVTn > Discord server< / a > is best for quick direct contact and our < a href = https://discourse.linuxserver.io/ > Forum< / a > for a longer running project.< / p > < p > There is zero barrier to entry for these levels of container customization and you are in complete control.< / p > < p > We are looking forward to your next creation.< / p > < aside class = md-source-file > < span class = md-source-file__fact > < span class = md-icon title = "Last update" > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z" / > < / svg > < / span > < span class = "git-revision-date-localized-plugin git-revision-date-localized-plugin-date" > October 17, 2023< / span > < / span > < span class = md-source-file__fact > < span class = md-icon title = Created > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z" / > < / svg > < / span > < span class = "git-revision-date-localized-plugin git-revision-date-localized-plugin-date" > April 22, 2022< / span > < / span > < / aside > < / article > < / div > < script > var target = document . getElementById ( location . hash . slice ( 1 ) ) ; target && target . name && ( target . checked = target . name . startsWith ( "__tabbed_" ) ) < / script > < / div > < button type = button class = "md-top md-icon" data-md-component = top hidden > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z" / > < / svg > Back to top < / button > < / main > < footer class = md-footer > < nav class = "md-footer__inner md-grid" aria-label = Footer > < a href = ../running-our-containers/ class = "md-footer__link md-footer__link--prev" aria-label = "Previous: Running LinuxServer Containers" > < div class = "md-footer__button md-icon" > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z" / > < / svg > < / div > < div class = md-footer__title > < span class = md-footer__direction > Previous < / span > < div class = md-ellipsis > Running LinuxServer Containers < / div > < / div > < / a > < a href = ../docker-compose/ class = "md-footer__link md-footer__link--next" aria-label = "Next: Docker Compose" > < div class = md-footer__title > < span class = md-footer__direction > Next < / span > < div class = md-ellipsis > Docker Compose < / div > < / div > < div class = "md-footer__button md-icon" > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z" / > < / svg > < / div > < / a > < / nav > < div class = "md-footer-meta md-typeset" > < div class = "md-footer-meta__inner md-grid" > < div class = md-copyright > < div class = md-copyright__highlight > Copyright © 2024 LinuxServer.io < / div > Made with < a href = https://squidfunk.github.io/mkdocs-material/ target = _blank rel = noopener > Material for MkDocs <
