</span></code></pre></div><p> </p><h2id=parameters>Parameters<aclass=headerlinkhref=#parameterstitle="Permanent link">¶</a></h2><p>The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.</p><table><thead><tr><thstyle="text-align: center;">Parameter</th><th>Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>-e DOCKERHUB_USERNAME</code></td><td>your dockerhub username</td></tr><tr><tdstyle="text-align: center;"><code>-e DOCKERHUB_PASSWORD</code></td><td>your dockerhub password</td></tr><tr><tdstyle="text-align: center;"><code>-e GIT_REPOSITORY</code></td><td>github repository, i.e. linuxserver/docker-readme-sync</td></tr><tr><tdstyle="text-align: center;"><code>-e DOCKER_REPOSITORY</code></td><td>dockerhub repository, i.e. lsiodev/docker-readme-sync</td></tr><tr><tdstyle="text-align: center;"><code>-e GIT_BRANCH</code></td><td>github repository branch, optional (default: master)</td></tr></tbody></table><p> It is based on alpine and is not meant to run as a service. The sync is performed and the command exits. </p><h2id=versions>Versions<aclass=headerlinkhref=#versionstitle="Permanent link">¶</a></h2><table><thead><tr><thstyle="text-align: center;">Date</th><th>Changes</th></tr></thead><tbody><tr><tdstyle="text-align: center;">13.01.21</td><td>Use ghcr baseimages. Fall back to <code>external</code> folder for readme lite.</td></tr><tr><tdstyle="text-align: center;">28.07.20</td><td>Rebase to alpine 3.12.</td></tr><tr><tdstyle="text-align: center;">20.08.18</td><td>Rebase to alpine 3.8.</td></tr><tr><tdstyle="text-align: center;">28.02.18</td><td>convert repo to use node.js implementation.</td></tr><tr><tdstyle="text-align: center;">17.11.17</td><td>add github branch support.</td></tr><tr><tdstyle="text-align: center;">16.10.16</td><td>merge ruby app.</td></tr><tr><tdstyle="text-align: center;">11.10.16</td><td>Initial development release.</td></tr></tbody></table><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">February 21, 2024</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">July 28, 2020</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 </