<titledata-rh="true">Getting Started with zrok | 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://zrok.io/docs/getting-started"><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 zrok | Zrok"><metadata-rh="true"name="description"content="zrok is a next-generation sharing platform built on top of OpenZiti, a programmable zero trust network overlay. zrok is an OpenZiti Native Application."><metadata-rh="true"property="og:description"content="zrok is a next-generation sharing platform built on top of OpenZiti, a programmable zero trust network overlay. zrok is an OpenZiti Native Application."><linkdata-rh="true"rel="icon"href="/img/space-ziggy.png"><linkdata-rh="true"rel="canonical"href="https://zrok.io/docs/getting-started"><linkdata-rh="true"rel="alternate"href="https://zrok.io/docs/getting-started"hreflang="en"><linkdata-rh="true"rel="alternate"href="https://zrok.io/docs/getting-started"hreflang="x-default"><linkrel="alternate"type="application/rss+xml"href="/blog/rss.xml"title="Zrok RSS Feed">
<linkrel="alternate"type="application/atom+xml"href="/blog/atom.xml"title="Zrok Atom Feed"><linkrel="stylesheet"href="/assets/css/styles.defabb8e.css">
<imgloading="lazy"alt="Share Details"src="/assets/images/zrok_web_console_share_detail-9c3f99ededaba7d1225cacd5ec81a06d.png"width="1556"height="1229"class="img_ev3q"></p><p>If we click on the <em>frontend endpoint</em> a new browser tab opens and we see the content of our share:
<imgloading="lazy"alt="Share Frontend"src="/assets/images/zrok_web_console_share_frontend-d36b169cea46f834e74af4aa456d0b89.png"width="1556"height="1229"class="img_ev3q"></p><p>If we click on the environment in the explorer, we're shown all of the shares for that environment (including our new share), along with a spark line that shows the activity:</p><p><imgloading="lazy"alt="Environment Spark Line"src="/assets/images/zrok_web_console_environment_spark-eeea921884089d320f4b9b2ba2038a1d.png"width="1556"height="1229"class="img_ev3q"></p><p>And as soon as I terminate the <code>zrok share</code> client, the resources are removed from the <code>zrok</code> environment.</p><p>If we try to reload the frontend endpoing in our web browser, we'll see:</p><p><imgloading="lazy"alt="Not Found"src="/assets/images/zrok_not_found-fa3415937c341eb10e1eb98c9b063583.png"width="1556"height="1229"class="img_ev3q"></p><h3class="anchor anchorWithStickyNavbar_LWe7"id="private-shares">Private Shares<aclass="hash-link"href="#private-shares"title="Direct link to heading"></a></h3><p><code>zrok</code> also provides a powerful <em>private</em> sharing model. If I execute the following command:</p><divclass="codeBlockContainer_Ckt0 theme-code-block"style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><divclass="codeBlockContent_biex"><pretabindex="0"class="prism-code language-text codeBlock_bY9V thin-scrollbar"><codeclass="codeBlockLines_e6Vv"><spanclass="token-line"style="color:#F8F8F2"><spanclass="token plain">$ zrok share private http://localhost:8080</span><br></span></code></pre><divclass="buttonGroup__atx"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_eSgA"aria-hidden="true"><svgclass="copyButtonIcon_y97N"viewBox="0 0 24 24"><pathd="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svgclass="copyButtonSuccessIcon_LjdS"viewBox="0 0 24 24"><pathd="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The <code>zrok</code> service will respond with the following:</p><divclass="codeBlockContainer_Ckt0 theme-code-block"style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><divclass="codeBlockContent_biex"><pretabindex="0"class="prism-code language-text codeBlock_bY9V thin-scrollbar"><codeclass="codeBlockLines_e6Vv"><spanclass="token-line"style="color:#F8F8F2"><spanclass="token plain">access your share with: zrok access private wvszln4dyz9q</span><br></span></code></pre><divclass="buttonGroup__atx"><buttontype="button"aria-label="Copy code to clipboard"title="Copy"class="clean-btn"><spanclass="copyButtonIcons_eSgA"aria-hidden="true"><svgclass="copyButtonIcon_y97N"viewBox="0 0 24 24"><pathd="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svgclass="copyButtonSuccessIcon_LjdS"viewBox="0 0 24 24"><pathd="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Rather than allowing access to your service through a public frontend, a <em>private</em> share is only exposed to the underlying OpenZiti network, and can only be accessed using the <code>zrok access</code> command.</p><p>The <code>zrok access private wvszln4dyz9q</code> command can be run by any <code>zrok</code> user, allowing them to create and bind a local HTTP listener, that allows for private access to your shared resources.</p><h3class="anchor anchorWithStickyNavbar_LWe7"id="proxy-backend-mode">Proxy Backend Mode<aclass="hash-link"href="#proxy-backend-mode"title="Direct link to heading"></a></h3><p>Without specifying a <em>backend mode</em>, the <code>zrok share</code> command will assume that you're trying to share a <code>proxy</code> resource. A <code>proxy</code> resource is usually some private HTTP/HTTPS endpoint (like a development
