</span></code></pre></div><h2id=parameters>Parameters<aclass=headerlinkhref=#parameterstitle="Permanent link">¶</a></h2><p>Docker images 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><h3id=ports-p>Ports (<code>-p</code>)<aclass=headerlinkhref=#ports-ptitle="Permanent link">¶</a></h3><table><thead><tr><thstyle="text-align: center;">Parameter</th><thstyle="text-align: left;">Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>5060</code></td><tdstyle="text-align: left;">The port for the Cardigann webinterface</td></tr></tbody></table><h3id=environment-variables-e>Environment Variables (<code>-e</code>)<aclass=headerlinkhref=#environment-variables-etitle="Permanent link">¶</a></h3><table><thead><tr><thstyle="text-align: center;">Env</th><thstyle="text-align: left;">Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>PUID=1000</code></td><tdstyle="text-align: left;">for UserID - see below for explanation</td></tr><tr><tdstyle="text-align: center;"><code>PGID=1000</code></td><tdstyle="text-align: left;">for GroupID - see below for explanation</td></tr><tr><tdstyle="text-align: center;"><code>SOCKS_PROXY=IP:PORT</code></td><tdstyle="text-align: left;">for using a socks proxy (optional)</td></tr><tr><tdstyle="text-align: center;"><code>HTTP_PROXY=IP:PORT</code></td><tdstyle="text-align: left;">for using a HTTP proxy (optional)</td></tr></tbody></table><h3id=volume-mappings-v>Volume Mappings (<code>-v</code>)<aclass=headerlinkhref=#volume-mappings-vtitle="Permanent link">¶</a></h3><table><thead><tr><thstyle="text-align: center;">Volume</th><thstyle="text-align: left;">Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>/config</code></td><tdstyle="text-align: left;">Cardigann config</td></tr></tbody></table><h2id=user-group-identifiers>User / Group Identifiers<aclass=headerlinkhref=#user-group-identifierstitle="Permanent link">¶</a></h2><p>When using volumes (<code>-v</code> flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user <code>PUID</code> and group <code>PGID</code>.</p><p>Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.</p><p>In this instance <code>PUID=1000</code> and <code>PGID=1000</code>, to find yours use <code>id user</code> as below:</p><divclass="language-text highlight"><pre><span></span><code><spanid=__span-2-1><aid=__codelineno-2-1name=__codelineno-2-1href=#__codelineno-2-1></a> $ id username
</span></code></pre></div><h2id=application-setup>Application Setup<aclass=headerlinkhref=#application-setuptitle="Permanent link">¶</a></h2><p>Access the webui at <code><your-ip>:5060</code>, for more information check out <ahref=https://github.com/cardigann/cardigann>Cardigann</a>.</p><p>By adding a variable to the run command, <code>SOCKS_PROXY</code> or <code>HTTP_PROXY</code> cardigann can be used with a proxy, <em>eg</em><code>-e SOCKS_PROXY=localhost:1080</code></p><p>The folder <code>/config/definitions</code> can be used to add additional tracker definitions (for more info see <ahref=https://github.com/cardigann/cardigann#definitions>Additional definitions</a> ).</p><h2id=support-info>Support Info<aclass=headerlinkhref=#support-infotitle="Permanent link">¶</a></h2><ul><li>Shell access whilst the container is running:</li><li><code>docker exec -it cardigann /bin/bash</code></li><li>To monitor the logs of the container in realtime:</li><li><code>docker logs -f cardigann</code></li><li>Container version number</li><li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' cardigann</code></li><li>Image version number</li><li><code>docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/cardigann</code></li></ul><h2id=versions>Versions<aclass=headerlinkhref=#versionstitle="Permanent link">¶</a></h2><ul><li><strong>23.03.19:</strong> - Switching to new Base images, shift to arm32v7 tag.</li><li><strong>01.02.19:</strong> - Multi arch images and pipeline build logic</li><li><strong>14.01.19:</strong> - Add multi arch and pipeline logic</li><li><strong>22.08.18:</strong> - Rebase to alpine 3.8</li><li><strong>06.05.18:</strong> - Use buildstage in Dockerfile</li><li><strong>06.12.17:</strong> - Rebase to alpine 3.7</li><li><strong>12.08.17:</strong> - Add npm install to build stage</li><li><strong>25.05.17:</strong> - Rebase to alpine 3.6</li><li><strong>07.02.17:</strong> - Rebase to alpine 3.5</li><li><strong>03.11.16:</strong> - Compiled using <ahref=https://github.com/sstamoulis>sstamoulis'</a> method</li><li><strong>01.11.16:</strong> - Initial Release</li></ul><asideclass=md-source-file><spanclass=md-source-file__fact><spanclass=md-icontitle="Last update"><svgxmlns=http://www.w3.org/2000/svgviewbox="0 0 24 24"><pathd="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.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 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.2v1.8Z"/></svg></span><spanclass="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 14, 2023</span></span><spanclass=md-source-file__fact><spanclass=md-icontitle=Created><svgxmlns=http://www.w3.org/2000/svgviewbox="0 0 24 24"><pathd="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-3h-2Z"/></svg></span><spanclass="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">February 6, 2019</span></span></aside></article></div><script>vartarget=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script></div><buttontype=buttonclass="md-top md-icon"data-md-component=tophidden><svgxmlns=http://www.w3.org/2000/svgviewbox="0 0 24 24"><pathd="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg> Back to top </button></main><footerclass=md-footer><navclass="md-footer__inner md-grid"aria-label=Footer><ahref=../docker-booksonic/class="md-footer__link md-footer__link--prev"aria-label="Previous: booksonic"><divclass="md-footer__buttonmd-
