</span></code></pre></div><p>If you prefer to install it system-wide you can use <code>/usr/local/lib/docker/cli-plugins</code> instead of <code>$HOME/.docker/cli-plugins</code></p><p>Assuming you already have docker (or at the very least docker-cli) installed, preferably from the official docker repos, running <code>docker compose version</code> should display the compose version.</p><h4id=v1x-compatibility>v1.x compatibility<aclass=headerlinkhref=#v1x-compatibilitytitle="Permanent link">¶</a></h4><p>As v2 runs as a plugin instead of a standalone binary, it is invoked by <code>docker compose args</code> instead of <code>docker-compose args</code>. To make migration easier, Docker released a replacement binary for <code>docker-compose</code> on x86_64 and aarch64 platforms. More info on that can be found at the <ahref=https://github.com/docker/compose-switch>upstream repo</a>.</p><h2id=single-service-usage>Single service Usage<aclass=headerlinkhref=#single-service-usagetitle="Permanent link">¶</a></h2><p>Here's a basic example for deploying a Linuxserver container with docker compose:</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=nt>version</span><spanclass=p>:</span><spanclass=w></span><spanclass=s>"2.1"</span>
</span></code></pre></div><p>If you save the above snippet in a file named <code>compose.yml</code>, you can simply run <code>docker compose up -d</code> from within the same folder and the heimdall image will be automatically pulled, and a container will be created and started. <code>up</code> means bring the services up, and <code>-d</code> means do it in the background.</p><p>If you want to do it from a different folder or if you named the yaml file differently, ie. <code>heimdall.yml</code>, then you can define it in the command with <code>-f</code>: <code>docker compose -f /path/to/heimdall.yml up -d</code></p><p>To bring down the services, simply do <code>docker compose down</code> or <code>docker compose -f /path/to/heimdall.yml down</code> and all containers defined by the yml will be stopped and destroyed.</p><h2id=multiple-service-usage>Multiple Service Usage<aclass=headerlinkhref=#multiple-service-usagetitle="Permanent link">¶</a></h2><p>You can have multiple services managed by a single compose yaml. Copy the contents below the <code>services:</code> line in any of our readme yaml samples into the same yaml file and the <code>docker compose up/down</code> commands will apply to all services at once.</p><p>Let's say you have the following in a yaml file named <code>compose.yml</code>:</p><divclass="language-yaml highlight"><pre><span></span><code><spanid=__span-2-1><aid=__codelineno-2-1name=__codelineno-2-1href=#__codelineno-2-1></a><spanclass=nt>version</span><spanclass=p>:</span><spanclass=w></span><spanclass=s>"2.1"</span>
</span></code></pre></div><p>You now have 3 services defined in there: <code>heimdall</code>, <code>nginx</code> and <code>mariadb</code>. When you do a <code>docker compose up -d</code>, it will first download the images for all three if they don't exist (if they exist, they are not updated) and it will create all three containers and start them. <code>docker compose down</code> will bring all three services down and destroy the containers (persistent data will remain).</p><h2id=updates>Updates<aclass=headerlinkhref=#updatestitle="Permanent link">¶</a></h2><p>If you want to update the images and recreate the containers with the same vars, it's extremely easy with docker compose. First we tell it to update all images via <code>docker compose pull</code>. Then we issue <code>docker compose up -d</code> and it will automatically recreate the containers (as necessary) based on the updated images. If a container's image is already the latest and there was no update, it remains untouched.</p><p>Similarly, if you edit the contents of the yaml file and re-issue <code>docker compose up -d</code>, only the containers affected by the changes to the yaml file will be recreated, others will be untouched.</p><p>Defining the containers running on your server as code is a core tenet of a "Devops" approach to the world. Constructing elaborate <code>docker run</code> commands and then forgetting which variables you passed is a thing of the past when using <code>docker compose</code>.</p><h2id=support-requests>Support Requests<aclass=headerlinkhref=#support-requeststitle="Permanent link">¶</a></h2><p>If you would like to request support, you can do so on <ahref=https://discord.gg/linuxserver>our discord server</a> or <ahref=https://discourse.linuxserver.io/>our forum</a>. When you do so, please provide all the necessary information like the server and platform info, docker container log and the compose yaml.</p><p>If your compose yaml makes use of .env files, please post an output of <code>docker compose config</code> or <code>docker compose config -f /path/to/compose.yml</code> for the entire yaml, or <code>docker compose config <service name></code> for a single service, as it will automatically replace the environment variables with their actual values.</p><p>There are multiple ways to see the logs of your containers. In some instances, using <code>docker logs</code> is preferable to <code>docker compose logs</code>. By default <code>docker logs</code> will not run unless you define which service the logs are coming from. The <code>docker compose logs</code> will pull all of the logs for the services defined in the <code>compose.yml</code> file.</p><p>When asking for help, you should post your logs or be ready to provide logs if someone requests it. If you are running multiple containers in your <code>compose.yml</code> file, it is not helpful to submit <strong>all</strong> of the logs. If you are experiencing issues with a single service, say Heimdall, then you would want to get your logs using <code>docker logs heimdall</code> or <code>docker compose logs heimdall</code>. The bash_alias for <code>dclogs</code> can be used if you define your service after you've typed the alias. Likewise, the bash_alias <code>detail</code> will not run without defining the service after it.</p><h2id=common-gotchas>Common Gotchas<aclass=headerlinkhref=#common-gotchastitle="Permanent link">¶</a></h2><h3id=quoting-variables>Quoting variables<aclass=headerlinkhref=#quoting-variablestitle="Permanent link">¶</a></h3><p>In compose yamls, the environment variables can be defined in a couple of different styles. For the style we use in our readme samples, wrapping the variables in quotes is not required unless the variables contain spaces. When it's necessary, you can wrap them in quotes as described below.</p><ul><li>Style 1 (our readme recommended style):</li></ul><divclass="language-yaml highlight"><pre><span></span><code><spanid=__span-3-1><aid=__codelineno-3-1name=__codelineno-3-1href=#__
</span></code></pre></div><p>This method requires the entire line wrapped in quotes, including the key and the value.</p><ul><li>Style 2:</li></ul><divclass="language-yaml highlight"><pre><span></span><code><spanid=__span-4-1><aid=__codelineno-4-1name=__codelineno-4-1href=#__codelineno-4-1></a><spanclass=nt>environment</span><spanclass=p>:</span>
</span></code></pre></div><p>With this method, you can wrap just the value in quotes.</p><h3id=escaping-signs>Escaping $ signs<aclass=headerlinkhref=#escaping-signstitle="Permanent link">¶</a></h3><p>Docker compose interprets values that follow a <code>$</code> as a variable and it will <ahref=https://docs.docker.com/compose/compose-file/12-interpolation/>interpolate at runtime</a>. If your environment variables contain the <code>$</code> character as part of the value and it needs to be treated literally, you need to escape it with another <code>$</code> sign.</p><p>For example, if you want the variable <code>key</code> to have the value <code>real$value</code> exactly, you need to set <code>- 'key=real$$value'</code> in the compose yaml.</p><h2id=tips-tricks>Tips & Tricks<aclass=headerlinkhref=#tips-trickstitle="Permanent link">¶</a></h2><p><code>docker compose</code> expects a <code>compose.yml</code> file in the current directory and if one isn't present it will complain. In order to improve your quality of life we suggest the use of bash aliases. The file path for the aliases below assumes that the <code>compose.yml</code> file is being kept in the folder <code>/opt</code>. If your compose file is kept somewhere else, like in a home directory, then the path will need to be changed.</p><p>Create or open the file <code>~/.bash_aliases</code> and populate with the following content:</p><divclass="language-shell highlight"><pre><span></span><code><spanid=__span-5-1><aid=__codelineno-5-1name=__codelineno-5-1href=#__codelineno-5-1></a><spanclass=nb>alias</span><spanclass=w></span><spanclass=nv>dcup</span><spanclass=o>=</span><spanclass=s1>'docker compose -f /opt/compose.yml up -d'</span><spanclass=w></span><spanclass=c1>#brings up all containers if one is not defined after dcup</span>
</span><spanid=__span-5-2><aid=__codelineno-5-2name=__codelineno-5-2href=#__codelineno-5-2></a><spanclass=nb>alias</span><spanclass=w></span><spanclass=nv>dcdown</span><spanclass=o>=</span><spanclass=s1>'docker compose -f /opt/compose.yml stop'</span><spanclass=w></span><spanclass=c1>#brings down all containers if one is not defined after dcdown</span>
</span><spanid=__span-5-3><aid=__codelineno-5-3name=__codelineno-5-3href=#__codelineno-5-3></a><spanclass=nb>alias</span><spanclass=w></span><spanclass=nv>dcpull</span><spanclass=o>=</span><spanclass=s1>'docker compose -f /opt/compose.yml pull'</span><spanclass=w></span><spanclass=c1>#pulls all new images is specified after dcpull</span>
</span></code></pre></div><p>If the <code>compose.yml</code> file is in a home directory, the following can be put in the <code>~/.bash_aliases</code> file.</p><divclass="language-shell highlight"><pre><span></span><code><spanid=__span-6-1><aid=__codelineno-6-1name=__codelineno-6-1href=#__codelineno-6-1></a><spanclass=nb>alias</span><spanclass=w></span><spanclass=nv>dcup</span><spanclass=o>=</span><spanclass=s1>'docker compose -f ~/compose.yml up -d'</span><spanclass=w></span><spanclass=c1>#brings up all containers if one is not defined after dcup</span>
</span><spanid=__span-6-2><aid=__codelineno-6-2name=__codelineno-6-2href=#__codelineno-6-2></a><spanclass=nb>alias</span><spanclass=w></span><spanclass=nv>dcdown</span><spanclass=o>=</span><spanclass=s1>'docker compose -f ~/compose.yml stop'</span><spanclass=w></span><spanclass=c1>#brings down all containers if one is not defined after dcdown</span>
</span><spanid=__span-6-3><aid=__codelineno-6-3name=__codelineno-6-3href=#__codelineno-6-3></a><spanclass=nb>alias</span><spanclass=w></span><spanclass=nv>dcpull</span><spanclass=o>=</span><spanclass=s1>'docker compose -f ~/compose.yml pull'</span><spanclass=w></span><spanclass=c1>#pulls all new images unless one is specified</span>
</span></code></pre></div><p>Some distributions, like Ubuntu, already have the code snippet below in the <code>~/.bashrc</code> file. If it is not included, you'll need to add the following to your <code>~/.bashrc</code> file in order for the aliases file to be picked up:</p><divclass="language-shell highlight"><pre><span></span><code><spanid=__span-7-1><aid=__codelineno-7-1name=__codelineno-7-1href=#__codelineno-7-1></a><spanclass=k>if</span><spanclass=w></span><spanclass=o>[</span><spanclass=w></span>-f<spanclass=w></span>~/.bash_aliases<spanclass=w></span><spanclass=o>]</span><spanclass=p>;</span><spanclass=w></span><spanclass=k>then</span>
