mirror
/
docker-documentation
kopia lustrzana https://github.com/linuxserver/docker-documentation
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność
docker-documentation/images/docker-readme-sync/index.html

8 wiersze
52 KiB
HTML
Czysty Zwykły widok Historia

Deployed f5274cb5 with MkDocs version: 1.5.3
2023-10-02 03:54:38 +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/images/docker-readme-sync/ rel=canonical><link href=../docker-readarr/ rel=prev><link href=../docker-remmina/ rel=next><link rel=icon href=../../assets/favicon.ico><meta name=generator content="mkdocs-1.5.3, mkdocs-material-9.4.2"><title>readme-sync - LinuxServer.io</title><link rel=stylesheet href=../../assets/stylesheets/main.d451bc0e.min.css><link rel=stylesheet href=../../assets/stylesheets/palette.a5377069.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><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> <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script> <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=#contact-information- class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <header class="md-header md-header--shadow" 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 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></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> readme-sync </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_1> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_2 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 12 20 8.69Z"/></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_2> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_1 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 12c0-2.42-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 12
Deployed fa360962 with MkDocs version: 1.5.2
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> -e DOCKERHUB_USERNAME=&lt;USERNAME&gt; \
</span><span id=__span-0-3><a id=__codelineno-0-3 name=__codelineno-0-3 href=#__codelineno-0-3></a> -e DOCKERHUB_PASSWORD=&lt;PASSWORD&gt; \
</span><span id=__span-0-4><a id=__codelineno-0-4 name=__codelineno-0-4 href=#__codelineno-0-4></a> -e GIT_REPOSITORY=&lt;GITHUB REPO&gt; \
</span><span id=__span-0-5><a id=__codelineno-0-5 name=__codelineno-0-5 href=#__codelineno-0-5></a> -e DOCKER_REPOSITORY=&lt;DOCKERHUB REPO&gt; \
</span><span id=__span-0-6><a id=__codelineno-0-6 name=__codelineno-0-6 href=#__codelineno-0-6></a> -e GIT_BRANCH=&lt;GITHUB BRANCH&gt; \
</span><span id=__span-0-7><a id=__codelineno-0-7 name=__codelineno-0-7 href=#__codelineno-0-7></a> lsiodev/readme-sync bash -c &#39;node sync&#39;
Deployed 19e84ba5 with MkDocs version: 1.5.3
2023-10-06 18:07:37 +00:00
</span></code></pre></div> <p>&nbsp;</p> <h2 id=parameters>Parameters<a class=headerlink href=#parameters title="Permanent link">&para;</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> <th style="text-align: center;">Parameter</th> <th>Function</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;"><code>-e DOCKERHUB_USERNAME</code></td> <td>your dockerhub username</td> </tr> <tr> <td style="text-align: center;"><code>-e DOCKERHUB_PASSWORD</code></td> <td>your dockerhub password</td> </tr> <tr> <td style="text-align: center;"><code>-e GIT_REPOSITORY</code></td> <td>github repository, i.e. linuxserver/docker-readme-sync</td> </tr> <tr> <td style="text-align: center;"><code>-e DOCKER_REPOSITORY</code></td> <td>dockerhub repository, i.e. lsiodev/docker-readme-sync</td> </tr> <tr> <td style="text-align: center;"><code>-e GIT_BRANCH</code></td> <td>github repository branch, optional (default: master)</td> </tr> </tbody> </table> <p>&nbsp; It is based on alpine and is not meant to run as a service. The sync is performed and the command exits. &nbsp;</p> <h2 id=versions>Versions<a class=headerlink href=#versions title="Permanent link">&para;</a></h2> <table> <thead> <tr> <th style="text-align: center;">Date</th> <th>Changes</th> </tr> </thead> <tbody> <tr> <td style="text-align: center;">13.01.21</td> <td>Use ghcr baseimages. Fall back to <code>external</code> folder for readme lite.</td> </tr> <tr> <td style="text-align: center;">28.07.20</td> <td>Rebase to alpine 3.12.</td> </tr> <tr> <td style="text-align: center;">20.08.18</td> <td>Rebase to alpine 3.8.</td> </tr> <tr> <td style="text-align: center;">28.02.18</td> <td>convert repo to use node.js implementation.</td> </tr> <tr> <td style="text-align: center;">17.11.17</td> <td>add github branch support.</td> </tr> <tr> <td style="text-align: center;">16.10.16</td> <td>merge ruby app.</td> </tr> <tr> <td style="text-align: center;">11.10.16</td> <td>Initial development release.</td> </tr> </tbody> </table> <hr> <div class=md-source-file> <small> Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 31, 2023</span> <br> Created: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 28, 2020</span> </small> </div> </article> </div> </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 8v12Z"/></svg> Back to top </button> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../docker-readarr/ class="md-footer__link md-footer__link--prev" aria-label="Previous: readarr"> <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 11h12Z"/></svg> </div> <div class=md-footer__title> <span class=md-footer__direction> Previous </span> <div class=md-ellipsis> readarr </div> </div> </a> <a href=../docker-remmina/ class="md-footer__link md-footer__link--next" aria-label="Next: remmina"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> remmina </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 11H4Z"/></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__highl