<titledata-rh="true">Getting Started with Docker | Zrok</title><metadata-rh="true"name="viewport"content="width=device-width,initial-scale=1"><metadata-rh="true"name="twitter:card"content="summary_large_image"><metadata-rh="true"property="og:url"content="https://docs.zrok.io/docs/guides/docker-share/"><metadata-rh="true"property="og:locale"content="en"><metadata-rh="true"name="docusaurus_locale"content="en"><metadata-rh="true"name="docsearch:language"content="en"><metadata-rh="true"name="docusaurus_version"content="current"><metadata-rh="true"name="docusaurus_tag"content="docs-default-current"><metadata-rh="true"name="docsearch:version"content="current"><metadata-rh="true"name="docsearch:docusaurus_tag"content="docs-default-current"><metadata-rh="true"property="og:title"content="Getting Started with Docker | Zrok"><metadata-rh="true"name="description"content="Overview"><metadata-rh="true"property="og:description"content="Overview"><linkdata-rh="true"rel="icon"href="/img/space-ziggy.png"><linkdata-rh="true"rel="canonical"href="https://docs.zrok.io/docs/guides/docker-share/"><linkdata-rh="true"rel="alternate"href="https://docs.zrok.io/docs/guides/docker-share/"hreflang="en"><linkdata-rh="true"rel="alternate"href="https://docs.zrok.io/docs/guides/docker-share/"hreflang="x-default"><linkdata-rh="true"rel="preconnect"href="https://CO73R59OLO-dsn.algolia.net"crossorigin="anonymous"><linkrel="preconnect"href="https://www.googletagmanager.com">
<script>!function(){functiont(t){document.documentElement.setAttribute("data-theme",t)}vare=function(){try{returnnewURLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{returnlocalStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"dark")}(),function(){try{constc=newURLSearchParams(window.location.search).entries();for(var[t,e]ofc)if(t.startsWith("docusaurus-data-")){vara=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><divid="__docusaurus"><divrole="region"aria-label="Skip to main content"><aclass="skipToContent_fXgn"href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><navaria-label="Main"class="navbar navbar--fixed-top"><divclass="navbar__inner"><divclass="navbar__items"><buttonaria-label="Toggle navigation bar"aria-expanded="false"class="navbar__toggle clean-btn"type="button"><svgwidth="30"height="30"viewBox="0 0 30 30"aria-hidden="true"><pathstroke="currentColor"stroke-linecap="round"stroke-miterlimit="10"stroke-width="2"d="M4 7h22M4 15h22M4 23h22"></path></svg></button><ahref="https://zrok.io"target="_self"rel="noopener noreferrer"class="navbar__brand"><divclass="navbar__logo"><imgsrc="/img/space-ziggy.png"alt="Ziggy Goes to Space"class="themedComponent_mlkZ themedComponent--light_NVdE"><imgsrc="/img/space-ziggy.png"alt="Ziggy Goes to Space"class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><bclass="navbar__title text--truncate">zrok</b></a></div><divclass="navbar__items navbar__items--right"><aaria-current="page"class="navbar__item navbar__link navbar__link--active"href="/docs/getting-started/">Docs</a><ahref="https://github.com/orgs/openziti/projects/16"target="_blank"rel="noopener noreferrer"class="navbar__item navbar__link">Roadmap<svgwidth="13.5"height="13.5"aria-hidden="true"viewBox="0 0 24 24"class="iconExternalLink_nPIU"><pathfill="currentColor"d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><ahref="https://github.com/openziti/zrok"target="_blank"rel="noopener noreferrer"class="navbar__item navbar__link">GitHub<svgwidth="13.5"height="13.5"aria-hidden="true"viewBox="0 0 24 24"class="iconExternalLink_nPIU"><pathfill="currentColor"d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><divclass="toggle_vylO colorModeToggle_DEke"><buttonclass="clean-btn toggleButton_gllP toggleButtonDisabled_aARS"type="button"disabled=""title="Switch between dark and light mode (currently dark mode)"aria-label="Switch between dark and light mode (currently dark mode)"aria-live="polite"><svgviewBox="0 0 24 24"width="24"height="24"class="lightToggleIcon_pyhR"><pathfill="currentColor"d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svgviewBox="0 0 24 24"width="24"height="24"class="darkToggleIcon_wfgR"><pathfill="currentColor"d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0
<p>To follow the guides in this section you will need <ahref="https://docs.docker.com/get-docker/"target="_blank"rel="noopener noreferrer">Docker</a>.</p>
<p>You have the option to enable a <code>zrok</code> account on the Docker host and mount it on the container or you can use the provided Docker Compose project files (<code>compose.yml</code>) to enable a separate <code>zrok</code> environment for each project.</p>
<p>This page provides <code>docker</code> and <code>docker compose</code> examples of mounting the host's <code>zrok</code> environment on the container. You'll need to first <ahref="/docs/getting-started/#installing-the-zrok-command">enable zrok on the Docker host</a> to use this approach.</p>
<h2class="anchor anchorWithStickyNavbar_LWe7"id="permanent-public-share">Permanent Public Share<ahref="#permanent-public-share"class="hash-link"aria-label="Direct link to Permanent Public Share"title="Direct link to Permanent Public Share"></a></h2>
<p>Let's say you have a <code>compose.yml</code> file that defines a web app known within the project's bridge network as <code>https://myapp:8080</code> and you want to publish it as a reliable, public site.</p>
<ol>
<li>
<p>Reserve a subdomain by running <code>zrok reserve public --unique-name "myapp" https://myapp:8080</code> on the Docker host.</p>
</li>
<li>
<p>Merge this YAML with <code>compose.yml</code> or save it in the same directory as <code>compose.override.yml</code> to let <code>docker compose up</code> merge it for you.</p>
<p>The reserved share will be available at <code>https://myapp.share.zrok.io</code> each time the <code>zrok</code> container starts up.</p>
<h2class="anchor anchorWithStickyNavbar_LWe7"id="temporary-public-share">Temporary Public Share<ahref="#temporary-public-share"class="hash-link"aria-label="Direct link to Temporary Public Share"title="Direct link to Temporary Public Share"></a></h2>
<p>Let's say you have a web server running on the host's private network at <code>https://10.11.12.13:8080</code>. With one additional <code>docker</code> command, you can share the web server publicly as long as the <code>zrok</code> container stays running.</p>
<p>The public share URL appears near the beginning of the container's log.</p>
<p>Let's break down those options and arguments.</p>
<ol>
<li><code>--rm</code> don't save this container because it's providing a temporary public share that's destroyed when the container stops</li>
<li><code>--network=host</code> shares the host's network with the container so that the container can reach the web server directly. This is always necessary when the web server is listening only on the host's loopback interface, e.g., <code>https://::1:8080</code>, and may not be strictly necessary if the target is routeable from the default Docker bridge.</li>
<li><code>--volume ~/.zrok:/.zrok</code> mounts the <code>zrok</code> configuration from the Docker host into the container.</li>
<li><code>--user "${UID}:${GID}"</code> sets the container's user to the current user on the Docker host to avoid permission issues with reading the mounted <code>zrok</code> configuration.</li>
<li><code>openziti/zrok</code> is the <code>zrok</code> Docker image.</li>
<li><code>share public</code> is the <code>zrok</code> command to share the target publicly until zrok exits.</li>
<li><code>--headless</code> runs the <code>zrok</code> command without the interactive terminal UI.</li>
<li><code>https://10.11.12.13:8080</code> is the target web server to share.</li>
