mirror of
https://github.com/openziti/zrok.git
synced 2025-08-17 19:31:12 +02:00
deploy: a622b967fd
This commit is contained in:
dovholuknf
1
assets/js/8a9ffb5d.80d71e8d.js
Normal file
1
assets/js/8a9ffb5d.80d71e8d.js
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
1
assets/js/f888b719.f8dd5afa.js
Normal file
1
assets/js/f888b719.f8dd5afa.js
Normal file
File diff suppressed because one or more lines are too long
1
assets/js/ff8b6dc7.5ce08dea.js
Normal file
1
assets/js/ff8b6dc7.5ce08dea.js
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -37,6 +37,6 @@ was run from.</p>
|
||||
<div class="language-html codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-html codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token tag" style="color:rgb(255, 121, 198)">html</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token tag" style="color:rgb(255, 121, 198)">body</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token tag" style="color:rgb(255, 121, 198)">h1</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token plain">Hello </span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token tag" style="color:rgb(255, 121, 198)">code</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token plain">zrok</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"></</span><span class="token tag" style="color:rgb(255, 121, 198)">code</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"></</span><span class="token tag" style="color:rgb(255, 121, 198)">h1</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"></</span><span class="token tag" style="color:rgb(255, 121, 198)">html</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><br></span></code></pre></div></div>
|
||||
<p>Sharing the directory will result in the following when you access the share in a web browser:</p>
|
||||
<p><img decoding="async" loading="lazy" alt="zrok_share_web_website" src="/assets/images/zrok_share_web_website-5d4c550374b118d1992e488bb319e230.png" width="952" height="723" class="img_ev3q"></p>
|
||||
<p><code>zrok</code> contains a built-in web server, which you can use to serve static websites as a share.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/files.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/concepts/tunnels/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Sharing TCP and UDP Servers</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/concepts/opensource/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Open Source</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p><code>zrok</code> contains a built-in web server, which you can use to serve static websites as a share.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/files.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/concepts/tunnels/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Sharing TCP and UDP Servers</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/concepts/opensource/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Open Source</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -27,6 +27,6 @@ also freely available as open source software hosted by GitHub under a very perm
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="managed-service">Managed Service<a href="#managed-service" class="hash-link" aria-label="Direct link to Managed Service" title="Direct link to Managed Service"></a></h2>
|
||||
<p><code>zrok</code> is also offered as a cloud service, making it instantly accessible to a large population immediately.
|
||||
NetFoundry provides a manged version of <code>zrok</code> at <a href="https://zrok.io" target="_blank" rel="noopener noreferrer">https://zrok.io</a>. This provides the easy-to-use,
|
||||
quick to demonstrate features of <code>zrok</code> without needing to deploy and host <code>zrok</code> yourself.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/hosting.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/concepts/opensource/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Open Source</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/category/guides/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Guides</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#self-hosted" class="table-of-contents__link toc-highlight">Self-Hosted</a></li><li><a href="#managed-service" class="table-of-contents__link toc-highlight">Managed Service</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
quick to demonstrate features of <code>zrok</code> without needing to deploy and host <code>zrok</code> yourself.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/hosting.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/concepts/opensource/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Open Source</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/category/guides/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Guides</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#self-hosted" class="table-of-contents__link toc-highlight">Self-Hosted</a></li><li><a href="#managed-service" class="table-of-contents__link toc-highlight">Managed Service</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -28,6 +28,6 @@
|
||||
<p>When you execute this command, you'll get a <code>zrok</code> bridge like the following:</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">╭───────────────────────────────────────────────────────────────╮╭────────────────╮</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ http://cht7gj4g5pjf.share.zrok.io ││[PUBLIC] [PROXY]│</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╰───────────────────────────────────────────────────────────────╯╰────────────────╯</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╭─────────────────────────────────────────────────────────────────────────────────╮</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╰────────────────────────── ───────────────────────────────────────────────────────╯</span><br></span></code></pre></div></div>
|
||||
<p>The URL shown at the top of the bridge shows the address where you can access your <code>public</code> share.</p>
|
||||
<p>Hit <code>CTRL-C</code> or <code>q</code> in the bridge to exit it and delete the <code>public</code> share.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/http.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/concepts/sharing-reserved/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Reserved Shares</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/concepts/tunnels/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Sharing TCP and UDP Servers</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>Hit <code>CTRL-C</code> or <code>q</code> in the bridge to exit it and delete the <code>public</code> share.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/http.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/concepts/sharing-reserved/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Reserved Shares</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/concepts/tunnels/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Sharing TCP and UDP Servers</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -24,6 +24,6 @@
|
||||
<p><code>zrok</code> was designed to make sharing local resources both secure and easy. In this section of the <code>zrok</code> documentation, we'll tour through all of the most important features.</p>
|
||||
<p>Sharing with <code>zrok</code> can be either <a href="/docs/0.4/concepts/sharing-public/"><code>public</code></a> or <a href="/docs/0.4/concepts/sharing-private/"><code>private</code></a>.
|
||||
Naturally, regular web-based resources can be shared but <code>zrok</code> also includes support for sharing raw <a href="/docs/0.4/concepts/tunnels/">TCP</a> and <a href="/docs/0.4/concepts/tunnels/">UDP</a> network connections, and also includes a <a href="/docs/0.4/concepts/files/">website and file sharing</a> feature.</p>
|
||||
<p>Learn about <code>zrok</code> <a href="/docs/0.4/concepts/hosting/">hosting here</a>, including instructions on how to <a href="/docs/0.4/guides/self-hosting/linux/">install your own <code>zrok</code> instance</a>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/index.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/getting-started/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Getting Started</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/concepts/sharing-private/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Private Shares</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>Learn about <code>zrok</code> <a href="/docs/0.4/concepts/hosting/">hosting here</a>, including instructions on how to <a href="/docs/0.4/guides/self-hosting/linux/">install your own <code>zrok</code> instance</a>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/index.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/getting-started/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Getting Started</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/concepts/sharing-private/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Private Shares</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -32,6 +32,6 @@ project.</p>
|
||||
member of any organization. To enable <code>private</code> sharing, <code>zrok</code> was built on top of another excellent open source project named OpenZiti.</p>
|
||||
<p>OpenZiti is a secure overlay network focusing on bringing zero trust to applications. It is the <strong>backbone</strong> of <code>zrok</code>.
|
||||
In fact, <code>zrok</code> proudly proclaims itself as an Ziti <em>native</em> application.</p>
|
||||
<p>If you are interested in learning more about OpenZiti head over to <a href="https://docs.openziti.io/docs/learn/introduction/" target="_blank" rel="noopener noreferrer">the docs</a>, try the quickstart, and don't forget to star that project too. We couldn't build <code>zrok</code> without OpenZiti!</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/opensource.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/concepts/files/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Sharing Websites and Files</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/concepts/hosting/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Hosting</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#built-on-openziti" class="table-of-contents__link toc-highlight">Built on OpenZiti</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>If you are interested in learning more about OpenZiti head over to <a href="https://docs.openziti.io/docs/learn/introduction/" target="_blank" rel="noopener noreferrer">the docs</a>, try the quickstart, and don't forget to star that project too. We couldn't build <code>zrok</code> without OpenZiti!</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/opensource.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/concepts/files/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Sharing Websites and Files</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/concepts/hosting/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Hosting</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#built-on-openziti" class="table-of-contents__link toc-highlight">Built on OpenZiti</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -47,6 +47,6 @@ accessed on another user's system as if it were local to them. Privately sh
|
||||
<li><code>tcpTunnel</code>, <code>udpTunnel</code> modes forward the data payload to the target server (<a href="/docs/0.4/concepts/tunnels/">more</a>)</li>
|
||||
<li><code>socks</code> mode provides a SOCKS5 dynamic proxy on the private access bind port that tunnels TCP payloads to the share backend where they are forwarded to their destinations (<a href="https://blog.openziti.io/the-zrok-socks-backend" target="_blank" rel="noopener noreferrer">blog</a>)</li>
|
||||
<li><code>vpn</code> mode provides a network layer tunnel between the private access and the share backend (<a href="/docs/0.4/guides/vpn/">guide</a>)</li>
|
||||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/sharing-private.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/concepts/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Concepts</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/concepts/sharing-public/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Public Shares</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#peer-to-peer" class="table-of-contents__link toc-highlight">Peer to Peer</a></li><li><a href="#private-backend-modes" class="table-of-contents__link toc-highlight">Private Backend Modes</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/sharing-private.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/concepts/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Concepts</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/concepts/sharing-public/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Public Shares</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#peer-to-peer" class="table-of-contents__link toc-highlight">Peer to Peer</a></li><li><a href="#private-backend-modes" class="table-of-contents__link toc-highlight">Private Backend Modes</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -35,6 +35,6 @@
|
||||
<li><code>web</code> mode serves a target folder as a file index web page (<a href="/docs/concepts/files/">more</a>)</li>
|
||||
<li><code>drive</code> mode serves a target folder with WebDAV (<a href="/docs/guides/drives/">guide</a>)</li>
|
||||
<li><code>caddy</code> mode runs the built-in Caddy server with the targeted Caddyfile (<a href="/simple_reverse_proxy.Caddyfile" target="_blank" rel="noopener noreferrer">example</a>)</li>
|
||||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/sharing-public.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/concepts/sharing-private/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Private Shares</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/concepts/sharing-reserved/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Reserved Shares</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#peer-to-public" class="table-of-contents__link toc-highlight">Peer to Public</a></li><li><a href="#public-backend-modes" class="table-of-contents__link toc-highlight">Public Backend Modes</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/sharing-public.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/concepts/sharing-private/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Private Shares</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/concepts/sharing-reserved/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Reserved Shares</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#peer-to-public" class="table-of-contents__link toc-highlight">Peer to Public</a></li><li><a href="#public-backend-modes" class="table-of-contents__link toc-highlight">Public Backend Modes</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -31,6 +31,6 @@
|
||||
<p>This reserves public share token "myshare."</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_OeMC">Reserve with the Command Line</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok reserve public 80 --unique-name "myshare"</span><br></span></code></pre></div></div>
|
||||
<p>This shares <code>127.0.0.1:80</code> as <code>https://myshare.zrok.example.com</code> where <code>https://{token}.zrok.example.com</code> is the frontend's template.</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_OeMC">Share a Reserved Token</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok share reserved "myshare"</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/sharing-reserved.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/concepts/sharing-public/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Public Shares</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/concepts/http/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Sharing HTTP Servers</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#unique-names" class="table-of-contents__link toc-highlight">Unique Names</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_OeMC">Share a Reserved Token</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok share reserved "myshare"</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/sharing-reserved.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/concepts/sharing-public/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Public Shares</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/concepts/http/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Sharing HTTP Servers</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#unique-names" class="table-of-contents__link toc-highlight">Unique Names</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -37,6 +37,6 @@
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">╭──────────────────────────────────────────────────────────╮╭─────────────────────╮</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ access your share with: zrok access private 5adagwfl888k ││[PRIVATE] [TCPTUNNEL]│</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╰──────────────────────────────────────────────────────────╯╰─────────────────────╯</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╭─────────────────────────────────────────────────────────────────────────────────╮</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│Friday, 23-Jun-23 15:33:10 EDT ziti-edge-router │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│connId=2147483648, logical=ziti- │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│sdk[router=tls:ziti-lx:3022] -> ACCEPT 192.168.9.1:22 │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╰─────────────────────────────────────────────────────────────────────────────────╯</span><br></span></code></pre></div></div>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">╭─────────────────────────────────────────────────────────────────────────────────╮</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ tcp://127.0.0.1:9191 -> 5adagwfl888k │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╰─────────────────────────────────────────────────────────────────────────────────╯</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╭─────────────────────────────────────────────────────────────────────────────────╮</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│Friday, 23-Jun-23 15:33:10 EDT 127.0.0.1:42312 -> ACCEPT 5adagwfl888k │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╰─────────────────────────────────────────────────────────────────────────────────╯</span><br></span></code></pre></div></div>
|
||||
<p>Exit the <code>access</code> client to remove the local access to the shared TCP port. Exit the <code>share</code> client to disable further accesses to the shared resource.</p>
|
||||
<p>For UDP network resources just use the <code>zrok share private --backend-mode udpTunnel</code> instead of <code>tcpTunnel</code>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/tunnels.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/concepts/http/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Sharing HTTP Servers</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/concepts/files/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Sharing Websites and Files</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>For UDP network resources just use the <code>zrok share private --backend-mode udpTunnel</code> instead of <code>tcpTunnel</code>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/concepts/tunnels.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/concepts/http/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Sharing HTTP Servers</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/concepts/files/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Sharing Websites and Files</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -120,6 +120,6 @@
|
||||
</ol>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="cleaning-up">Cleaning Up<a href="#cleaning-up" class="hash-link" aria-label="Direct link to Cleaning Up" title="Direct link to Cleaning Up"></a></h2>
|
||||
<p>Run the "down" command in both Compose projects to destroy them when you're all done. This will stop the running containers and delete zrok environments' storage volumes. Then delete the selected zrok environment by clicking "Actions" in the web console.</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">docker compose down --remove-orphans --volumes</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/docker-share/docker_private_share_guide.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/docker-share/docker_public_share_guide/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Public Share</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/linux-user-share/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Linux User Share</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#goal" class="table-of-contents__link toc-highlight">Goal</a></li><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#walkthrough-video" class="table-of-contents__link toc-highlight">Walkthrough Video</a></li><li><a href="#how-it-works" class="table-of-contents__link toc-highlight">How it Works</a></li><li><a href="#before-you-begin" class="table-of-contents__link toc-highlight">Before You Begin</a></li><li><a href="#begin-sharing-privately-with-zrok-in-docker" class="table-of-contents__link toc-highlight">Begin Sharing Privately with zrok in Docker</a></li><li><a href="#access-the-private-share" class="table-of-contents__link toc-highlight">Access the Private Share</a></li><li><a href="#closed-permission-mode" class="table-of-contents__link toc-highlight">Closed Permission Mode</a></li><li><a href="#going-further-with-private-access" class="table-of-contents__link toc-highlight">Going Further with Private Access</a></li><li><a href="#cleaning-up" class="table-of-contents__link toc-highlight">Cleaning Up</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">docker compose down --remove-orphans --volumes</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/docker-share/docker_private_share_guide.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/docker-share/docker_public_share_guide/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Public Share</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/linux-user-share/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Linux User Share</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#goal" class="table-of-contents__link toc-highlight">Goal</a></li><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#walkthrough-video" class="table-of-contents__link toc-highlight">Walkthrough Video</a></li><li><a href="#how-it-works" class="table-of-contents__link toc-highlight">How it Works</a></li><li><a href="#before-you-begin" class="table-of-contents__link toc-highlight">Before You Begin</a></li><li><a href="#begin-sharing-privately-with-zrok-in-docker" class="table-of-contents__link toc-highlight">Begin Sharing Privately with zrok in Docker</a></li><li><a href="#access-the-private-share" class="table-of-contents__link toc-highlight">Access the Private Share</a></li><li><a href="#closed-permission-mode" class="table-of-contents__link toc-highlight">Closed Permission Mode</a></li><li><a href="#going-further-with-private-access" class="table-of-contents__link toc-highlight">Going Further with Private Access</a></li><li><a href="#cleaning-up" class="table-of-contents__link toc-highlight">Cleaning Up</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -104,6 +104,6 @@ post</a>.</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">docker compose logs zrok-share</span><br></span></code></pre></div></div>
|
||||
<div class="language-buttonless codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_OeMC">Output</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-buttonless codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">INFO: zrok public URL: https://88s803f2qvao.in.zrok.io/</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/docker-share/docker_public_share_guide.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/docker-share/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Getting Started with Docker</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/docker-share/docker_private_share_guide/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Private Share</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#goal" class="table-of-contents__link toc-highlight">Goal</a></li><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#walkthrough-video" class="table-of-contents__link toc-highlight">Walkthrough Video</a></li><li><a href="#how-it-works" class="table-of-contents__link toc-highlight">How it Works</a></li><li><a href="#create-the-docker-project" class="table-of-contents__link toc-highlight">Create the Docker Project</a></li><li><a href="#proxy-any-web-server" class="table-of-contents__link toc-highlight">Proxy Any Web Server</a></li><li><a href="#require-authentication" class="table-of-contents__link toc-highlight">Require Authentication</a><ul><li><a href="#oauth-email" class="table-of-contents__link toc-highlight">OAuth Email</a></li></ul></li><li><a href="#caddy-is-powerful" class="table-of-contents__link toc-highlight">Caddy is Powerful</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/docker-share/docker_public_share_guide.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/docker-share/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Getting Started with Docker</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/docker-share/docker_private_share_guide/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Private Share</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#goal" class="table-of-contents__link toc-highlight">Goal</a></li><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#walkthrough-video" class="table-of-contents__link toc-highlight">Walkthrough Video</a></li><li><a href="#how-it-works" class="table-of-contents__link toc-highlight">How it Works</a></li><li><a href="#create-the-docker-project" class="table-of-contents__link toc-highlight">Create the Docker Project</a></li><li><a href="#proxy-any-web-server" class="table-of-contents__link toc-highlight">Proxy Any Web Server</a></li><li><a href="#require-authentication" class="table-of-contents__link toc-highlight">Require Authentication</a><ul><li><a href="#oauth-email" class="table-of-contents__link toc-highlight">OAuth Email</a></li></ul></li><li><a href="#caddy-is-powerful" class="table-of-contents__link toc-highlight">Caddy is Powerful</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -53,6 +53,6 @@
|
||||
<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>
|
||||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/docker-share/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/permission-modes/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Permission Modes</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/docker-share/docker_public_share_guide/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Public Share</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#permanent-public-share" class="table-of-contents__link toc-highlight">Permanent Public Share</a></li><li><a href="#temporary-public-share" class="table-of-contents__link toc-highlight">Temporary Public Share</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/docker-share/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/permission-modes/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Permission Modes</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/docker-share/docker_public_share_guide/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Public Share</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#permanent-public-share" class="table-of-contents__link toc-highlight">Permanent Public Share</a></li><li><a href="#temporary-public-share" class="table-of-contents__link toc-highlight">Temporary Public Share</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -85,6 +85,6 @@
|
||||
<ul>
|
||||
<li>two-way synchronization between multiple hosts... allowing for shared "dropbox-like" usage scenarios between multiple environments</li>
|
||||
<li>better ergonomics for single-file destinations</li>
|
||||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/drives.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/self-service-invite/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Invitations</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/vpn/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">VPN</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#sharing-a-drive" class="table-of-contents__link toc-highlight">Sharing a Drive</a></li><li><a href="#working-with-a-private-drive-share" class="table-of-contents__link toc-highlight">Working with a Private Drive Share</a></li><li><a href="#working-with-public-shares" class="table-of-contents__link toc-highlight">Working with Public Shares</a></li><li><a href="#one-way-synchronization" class="table-of-contents__link toc-highlight">One-way Synchronization</a></li><li><a href="#drive-to-drive-copies-and-synchronization" class="table-of-contents__link toc-highlight">Drive-to-Drive Copies and Synchronization</a></li><li><a href="#copying-from-drives-to-the-local-filesystem" class="table-of-contents__link toc-highlight">Copying from Drives to the Local Filesystem</a></li><li><a href="#unique-names-and-reserved-shares" class="table-of-contents__link toc-highlight">Unique Names and Reserved Shares</a></li><li><a href="#future-enhancements" class="table-of-contents__link toc-highlight">Future Enhancements</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/drives.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/self-service-invite/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Invitations</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/vpn/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">VPN</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#sharing-a-drive" class="table-of-contents__link toc-highlight">Sharing a Drive</a></li><li><a href="#working-with-a-private-drive-share" class="table-of-contents__link toc-highlight">Working with a Private Drive Share</a></li><li><a href="#working-with-public-shares" class="table-of-contents__link toc-highlight">Working with Public Shares</a></li><li><a href="#one-way-synchronization" class="table-of-contents__link toc-highlight">One-way Synchronization</a></li><li><a href="#drive-to-drive-copies-and-synchronization" class="table-of-contents__link toc-highlight">Drive-to-Drive Copies and Synchronization</a></li><li><a href="#copying-from-drives-to-the-local-filesystem" class="table-of-contents__link toc-highlight">Copying from Drives to the Local Filesystem</a></li><li><a href="#unique-names-and-reserved-shares" class="table-of-contents__link toc-highlight">Unique Names and Reserved Shares</a></li><li><a href="#future-enhancements" class="table-of-contents__link toc-highlight">Future Enhancements</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -97,6 +97,6 @@
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="package-contents">Package Contents<a href="#package-contents" class="hash-link" aria-label="Direct link to Package Contents" title="Direct link to Package Contents"></a></h2>
|
||||
<p>The files included in the <code>zrok-share</code> package are sourced <a href="https://github.com/openziti/zrok/tree/main/nfpm" target="_blank" rel="noopener noreferrer">here in GitHub</a>.</p></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>On macOS and Windows, zrok frontdoor is implemented as a Docker Compose project which reserves a public subdomain for your website or service and manages a zrok environment that's separate from the Docker host. <a href="/docs/0.4/guides/docker-share/docker_public_share_guide/">Link to the Docker Public Share Guide</a></p></div></div></div>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="concepts">Concepts<a href="#concepts" class="hash-link" aria-label="Direct link to Concepts" title="Direct link to Concepts"></a></h2>
|
||||
<p>Overview of <a href="/docs/0.4/concepts/sharing-reserved/">zrok reserved shares</a></p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/frontdoor.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/install/windows/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Windows</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/permission-modes/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Permission Modes</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>Overview of <a href="/docs/0.4/concepts/sharing-reserved/">zrok reserved shares</a></p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/frontdoor.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/install/windows/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Windows</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/permission-modes/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Permission Modes</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -44,6 +44,6 @@
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok version</span><br></span></code></pre></div></div>
|
||||
<div class="language-buttonless codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_OeMC">Output</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-buttonless codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> _ </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> _____ __ ___ | | __</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">|_ / '__/ _ \| |/ /</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> / /| | | (_) | < </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">/___|_| \___/|_|\_\</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">v0.4.0 [c889005]</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/install/macos.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/install/linux/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Linux</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/install/windows/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Windows</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#homebrew" class="table-of-contents__link toc-highlight">Homebrew</a></li><li><a href="#darwin-binary" class="table-of-contents__link toc-highlight">Darwin Binary</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/install/macos.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/install/linux/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Linux</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/install/windows/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Windows</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#homebrew" class="table-of-contents__link toc-highlight">Homebrew</a></li><li><a href="#darwin-binary" class="table-of-contents__link toc-highlight">Darwin Binary</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -38,6 +38,6 @@
|
||||
</li>
|
||||
</ol>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="wintun-for-zrok-vpn">Wintun for zrok VPN<a href="#wintun-for-zrok-vpn" class="hash-link" aria-label="Direct link to Wintun for zrok VPN" title="Direct link to Wintun for zrok VPN"></a></h2>
|
||||
<p>On Windows, you must install Wintun to use zrok's VPN backend mode. See the <a href="/docs/0.4/guides/vpn/">VPN guide</a> for more details.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/install/windows.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/install/macos/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">macOS</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/frontdoor/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">frontdoor</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#windows-binary" class="table-of-contents__link toc-highlight">Windows Binary</a></li><li><a href="#wintun-for-zrok-vpn" class="table-of-contents__link toc-highlight">Wintun for zrok VPN</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>On Windows, you must install Wintun to use zrok's VPN backend mode. See the <a href="/docs/0.4/guides/vpn/">VPN guide</a> for more details.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/install/windows.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/install/macos/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">macOS</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/frontdoor/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">frontdoor</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#windows-binary" class="table-of-contents__link toc-highlight">Windows Binary</a></li><li><a href="#wintun-for-zrok-vpn" class="table-of-contents__link toc-highlight">Wintun for zrok VPN</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -45,6 +45,6 @@
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="check-the-user-share-journal">Check the User Share Journal<a href="#check-the-user-share-journal" class="hash-link" aria-label="Direct link to Check the User Share Journal" title="Direct link to Check the User Share Journal"></a></h2>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">journalctl --user -lfu zrok-share@${ZROK_INSTANCE}.service</span><br></span></code></pre></div></div>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="add-another-user-share">Add Another User Share<a href="#add-another-user-share" class="hash-link" aria-label="Direct link to Add Another User Share" title="Direct link to Add Another User Share"></a></h2>
|
||||
<p>To create another user share, choose another instance name, copy the <code>zrok-share.env</code> file, edit the configuration file, and start the service.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/linux-user-share/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/docker-share/docker_private_share_guide/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Private Share</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/category/self-hosting/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Self Hosting</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#install-the-linux-package" class="table-of-contents__link toc-highlight">Install the Linux Package</a></li><li><a href="#create-a-user-share-configuration-file" class="table-of-contents__link toc-highlight">Create a User Share Configuration File</a></li><li><a href="#edit-the-user-share-configuration-file" class="table-of-contents__link toc-highlight">Edit the User Share Configuration File</a></li><li><a href="#start-the-user-share-service" class="table-of-contents__link toc-highlight">Start the User Share Service</a></li><li><a href="#check-the-user-share-journal" class="table-of-contents__link toc-highlight">Check the User Share Journal</a></li><li><a href="#add-another-user-share" class="table-of-contents__link toc-highlight">Add Another User Share</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>To create another user share, choose another instance name, copy the <code>zrok-share.env</code> file, edit the configuration file, and start the service.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/linux-user-share/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/docker-share/docker_private_share_guide/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Private Share</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/category/self-hosting/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Self Hosting</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#install-the-linux-package" class="table-of-contents__link toc-highlight">Install the Linux Package</a></li><li><a href="#create-a-user-share-configuration-file" class="table-of-contents__link toc-highlight">Create a User Share Configuration File</a></li><li><a href="#edit-the-user-share-configuration-file" class="table-of-contents__link toc-highlight">Edit the User Share Configuration File</a></li><li><a href="#start-the-user-share-service" class="table-of-contents__link toc-highlight">Start the User Share Service</a></li><li><a href="#check-the-user-share-journal" class="table-of-contents__link toc-highlight">Check the User Share Journal</a></li><li><a href="#add-another-user-share" class="table-of-contents__link toc-highlight">Add Another User Share</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -43,6 +43,6 @@
|
||||
<p>And to remove the grant:</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ zrok modify share s4czjylwk7wa --remove-access-grant anotheruser@test.com</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">updated</span><br></span></code></pre></div></div>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="limitations">Limitations<a href="#limitations" class="hash-link" aria-label="Direct link to Limitations" title="Direct link to Limitations"></a></h2>
|
||||
<p>As of <code>v0.4.26</code> there is currently no way to <em>list</em> the current access grants. This will be addressed shortly in a subsequent update.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/permission-modes.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/frontdoor/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">frontdoor</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/docker-share/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Getting Started with Docker</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#creating-a-share-with-closed-permission-mode" class="table-of-contents__link toc-highlight">Creating a Share with Closed Permission Mode</a></li><li><a href="#adding-and-removing-access-grants-for-existing-shares" class="table-of-contents__link toc-highlight">Adding and Removing Access Grants for Existing Shares</a></li><li><a href="#limitations" class="table-of-contents__link toc-highlight">Limitations</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>As of <code>v0.4.26</code> there is currently no way to <em>list</em> the current access grants. This will be addressed shortly in a subsequent update.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/permission-modes.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/frontdoor/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">frontdoor</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/docker-share/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Getting Started with Docker</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#creating-a-share-with-closed-permission-mode" class="table-of-contents__link toc-highlight">Creating a Share with Closed Permission Mode</a></li><li><a href="#adding-and-removing-access-grants-for-existing-shares" class="table-of-contents__link toc-highlight">Adding and Removing Access Grants for Existing Shares</a></li><li><a href="#limitations" class="table-of-contents__link toc-highlight">Limitations</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -129,6 +129,6 @@
|
||||
<p>Check certificate status:</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain"># For Caddy</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">docker compose exec caddy curl -s "http://localhost:2019/certificates"</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"># For Traefik - view the ACME certificate file directly</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">docker compose exec traefik cat /etc/traefik/acme/acme.json | grep -A 5 "Certificates"</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/docker.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/personalized-frontend/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Personalized Frontend</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/kubernetes/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Kubernetes</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#docker-instance" class="table-of-contents__link toc-highlight">Docker Instance</a><ul><li><a href="#create-the-docker-compose-project" class="table-of-contents__link toc-highlight">Create the Docker Compose Project</a></li><li><a href="#basic-configuration-no-tls-localhost-only" class="table-of-contents__link toc-highlight">Basic Configuration (No TLS, Localhost Only)</a></li><li><a href="#expanded-configuration-with-tls-caddy-or-traefik" class="table-of-contents__link toc-highlight">Expanded Configuration with TLS (Caddy or Traefik)</a></li><li><a href="#set-up-a-user-account" class="table-of-contents__link toc-highlight">Set up a User Account</a></li><li><a href="#enable-the-user-environment" class="table-of-contents__link toc-highlight">Enable the User Environment</a></li><li><a href="#firewall-configuration" class="table-of-contents__link toc-highlight">Firewall Configuration</a></li><li><a href="#additional-configuration-options" class="table-of-contents__link toc-highlight">Additional Configuration Options</a></li><li><a href="#troubleshooting" class="table-of-contents__link toc-highlight">Troubleshooting</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/docker.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/personalized-frontend/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Personalized Frontend</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/kubernetes/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Kubernetes</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#docker-instance" class="table-of-contents__link toc-highlight">Docker Instance</a><ul><li><a href="#create-the-docker-compose-project" class="table-of-contents__link toc-highlight">Create the Docker Compose Project</a></li><li><a href="#basic-configuration-no-tls-localhost-only" class="table-of-contents__link toc-highlight">Basic Configuration (No TLS, Localhost Only)</a></li><li><a href="#expanded-configuration-with-tls-caddy-or-traefik" class="table-of-contents__link toc-highlight">Expanded Configuration with TLS (Caddy or Traefik)</a></li><li><a href="#set-up-a-user-account" class="table-of-contents__link toc-highlight">Set up a User Account</a></li><li><a href="#enable-the-user-environment" class="table-of-contents__link toc-highlight">Enable the User Environment</a></li><li><a href="#firewall-configuration" class="table-of-contents__link toc-highlight">Firewall Configuration</a></li><li><a href="#additional-configuration-options" class="table-of-contents__link toc-highlight">Additional Configuration Options</a></li><li><a href="#troubleshooting" class="table-of-contents__link toc-highlight">Troubleshooting</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -29,6 +29,6 @@
|
||||
<p>You can use the <code>zrok status</code> command to inspect the state of your local <em>environment</em>. <code>zrok</code> refers to each shell where you install and <code>enable</code> a copy of <code>zrok</code> as an <em>environment</em>.</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok status</span><br></span></code></pre></div></div>
|
||||
<div class="language-buttonless codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_OeMC">Output</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-buttonless codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">Config:</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> CONFIG VALUE SOURCE </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> apiEndpoint https://zrok.mydomain.com config </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">[WARNING]: Unable to load your local environment!</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">To create a local environment use the zrok enable command.</span><br></span></code></pre></div></div>
|
||||
<p>The <code>zrok status</code> command shows the configured API service that your environment is using, as well as the <code>SOURCE</code> where the setting was retrieved. In this case, <code>config</code> means that the setting was set into the environment using the <code>zrok config</code> command.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/instance-configuration.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/oauth/configuring-oauth/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">OAuth Public Frontend Configuration</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/self-service-invite/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Invitations</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>The <code>zrok status</code> command shows the configured API service that your environment is using, as well as the <code>SOURCE</code> where the setting was retrieved. In this case, <code>config</code> means that the setting was set into the environment using the <code>zrok config</code> command.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/instance-configuration.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/oauth/configuring-oauth/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">OAuth Public Frontend Configuration</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/self-service-invite/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Invitations</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -38,6 +38,6 @@
|
||||
<p>Typically the <code>user_agent_prefixes</code> list contains <code>Mozilla/5.0</code>, which matches all typical interactive mobile and desktop browsers. Setting a non-standard <code>User-Agent</code> in an interactive browser will bypass the interstitial pages for frontends configured with the usual <code>Mozilla/5.0</code> prefix.</p>
|
||||
<p>End users can offer an HTTP header of <code>skip_zrok_interstitial</code>, set to any value to bypass the interstitial page. Setting this header means that the user most likely understands what a zrok share is and will hopefully not fall for a phishing attack.</p>
|
||||
<p>The <code>skip_zrok_interstitial</code> header is especially useful for API clients (like <code>curl</code>) and other types of non-interactive clients.</p>
|
||||
<p>The <code>drive</code> backend mode does not currently support <code>GET</code> requests and cannot be accessed with a conventional web browser, so it bypasses the interstitial page requirement.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/interstitial-page.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/linux/nginx/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">NGINX TLS</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/organizations/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Organizations</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#bypassing-the-interstitial" class="table-of-contents__link toc-highlight">Bypassing the Interstitial</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>The <code>drive</code> backend mode does not currently support <code>GET</code> requests and cannot be accessed with a conventional web browser, so it bypasses the interstitial page requirement.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/interstitial-page.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/linux/nginx/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">NGINX TLS</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/organizations/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Organizations</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#bypassing-the-interstitial" class="table-of-contents__link toc-highlight">Bypassing the Interstitial</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -138,6 +138,6 @@
|
||||
<div class="language-buttonless codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_OeMC">Example output</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-buttonless codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok environment '2AS1WZ3Sz' enabled for 'SuGzRPjVDIcF'</span><br></span></code></pre></div></div>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok status --secrets</span><br></span></code></pre></div></div>
|
||||
<div class="language-buttonless codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_OeMC">Example output</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-buttonless codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">Config:</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> CONFIG VALUE SOURCE</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> apiEndpoint https://zrok.quigley.com env</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">Environment:</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> PROPERTY VALUE</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> Secret Token SuGzRPjVDIcF</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> Ziti Identity 2AS1WZ3Sz</span><br></span></code></pre></div></div>
|
||||
<p>Congratulations. You have a working <code>zrok</code> environment!</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/linux/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/category/self-hosting/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Self Hosting</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/linux/nginx/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">NGINX TLS</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#walkthrough-video" class="table-of-contents__link toc-highlight">Walkthrough Video</a></li><li><a href="#before-you-begin" class="table-of-contents__link toc-highlight">Before you Begin</a></li><li><a href="#openziti" class="table-of-contents__link toc-highlight">OpenZiti</a></li><li><a href="#install-zrok" class="table-of-contents__link toc-highlight">Install zrok</a></li><li><a href="#configure-the-controller" class="table-of-contents__link toc-highlight">Configure the Controller</a></li><li><a href="#environment-variables" class="table-of-contents__link toc-highlight">Environment Variables</a></li><li><a href="#bootstrap-openziti-for-zrok" class="table-of-contents__link toc-highlight">Bootstrap OpenZiti for zrok</a></li><li><a href="#run-zrok-controller" class="table-of-contents__link toc-highlight">Run zrok Controller</a></li><li><a href="#create-zrok-frontend" class="table-of-contents__link toc-highlight">Create zrok Frontend</a></li><li><a href="#configure-the-public-frontend" class="table-of-contents__link toc-highlight">Configure the Public Frontend</a></li><li><a href="#start-public-frontend" class="table-of-contents__link toc-highlight">Start Public Frontend</a></li><li><a href="#create-a-user-account" class="table-of-contents__link toc-highlight">Create a User Account</a></li><li><a href="#invite-additional-users" class="table-of-contents__link toc-highlight">Invite Additional Users</a></li><li><a href="#enable-your-environment" class="table-of-contents__link toc-highlight">Enable Your Environment</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>Congratulations. You have a working <code>zrok</code> environment!</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/linux/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/category/self-hosting/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Self Hosting</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/linux/nginx/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">NGINX TLS</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#walkthrough-video" class="table-of-contents__link toc-highlight">Walkthrough Video</a></li><li><a href="#before-you-begin" class="table-of-contents__link toc-highlight">Before you Begin</a></li><li><a href="#openziti" class="table-of-contents__link toc-highlight">OpenZiti</a></li><li><a href="#install-zrok" class="table-of-contents__link toc-highlight">Install zrok</a></li><li><a href="#configure-the-controller" class="table-of-contents__link toc-highlight">Configure the Controller</a></li><li><a href="#environment-variables" class="table-of-contents__link toc-highlight">Environment Variables</a></li><li><a href="#bootstrap-openziti-for-zrok" class="table-of-contents__link toc-highlight">Bootstrap OpenZiti for zrok</a></li><li><a href="#run-zrok-controller" class="table-of-contents__link toc-highlight">Run zrok Controller</a></li><li><a href="#create-zrok-frontend" class="table-of-contents__link toc-highlight">Create zrok Frontend</a></li><li><a href="#configure-the-public-frontend" class="table-of-contents__link toc-highlight">Configure the Public Frontend</a></li><li><a href="#start-public-frontend" class="table-of-contents__link toc-highlight">Start Public Frontend</a></li><li><a href="#create-a-user-account" class="table-of-contents__link toc-highlight">Create a User Account</a></li><li><a href="#invite-additional-users" class="table-of-contents__link toc-highlight">Invite Additional Users</a></li><li><a href="#enable-your-environment" class="table-of-contents__link toc-highlight">Enable Your Environment</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -52,6 +52,6 @@
|
||||
<p>List available frontends to obtain the token identifier of the frontend named "public". You may need to set <code>ZROK_ADMIN_TOKEN</code> or <code>ZROK_API_ENDPOINT</code> before running <code>zrok admin</code>.</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ zrok admin list frontends</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> TOKEN ZID PUBLIC NAME URL TEMPLATE CREATED AT UPDATED AT </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> 2NiDTRYUww18 7DsLh9DXG public http://{token}.zrok.quigley.com:8080 2023-01-19 05:29:20.793 +0000 UTC 2023-01-19 06:17:25 +0000 UTC </span><br></span></code></pre></div></div>
|
||||
<p>Update the URL template to use NGINX.</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ zrok admin update frontend 2NiDTRYUww18 --url-template https://{token}.zrok.quigley.com:443</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">[ 0.028] INFO main.(*adminUpdateFrontendCommand).run: updated global frontend '2NiDTRYUww18'</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/linux/nginx.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/linux/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Linux</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/interstitial-page/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Interstitial Pages</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#walkthrough-video" class="table-of-contents__link toc-highlight">Walkthrough Video</a></li><li><a href="#before-you-begin" class="table-of-contents__link toc-highlight">Before You Begin</a></li><li><a href="#choose-a-reverse-proxy-address" class="table-of-contents__link toc-highlight">Choose a Reverse Proxy Address</a></li><li><a href="#obtain-a-wildcard-server-certificate" class="table-of-contents__link toc-highlight">Obtain a Wildcard Server Certificate</a></li><li><a href="#install-nginx" class="table-of-contents__link toc-highlight">Install NGINX</a></li><li><a href="#configure-nginx" class="table-of-contents__link toc-highlight">Configure NGINX</a></li><li><a href="#restart-nginx" class="table-of-contents__link toc-highlight">Restart NGINX</a></li><li><a href="#check-the-firewall" class="table-of-contents__link toc-highlight">Check the Firewall</a></li><li><a href="#update-the-zrok-frontend" class="table-of-contents__link toc-highlight">Update the zrok Frontend</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ zrok admin update frontend 2NiDTRYUww18 --url-template https://{token}.zrok.quigley.com:443</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">[ 0.028] INFO main.(*adminUpdateFrontendCommand).run: updated global frontend '2NiDTRYUww18'</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/linux/nginx.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/linux/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Linux</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/interstitial-page/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Interstitial Pages</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#walkthrough-video" class="table-of-contents__link toc-highlight">Walkthrough Video</a></li><li><a href="#before-you-begin" class="table-of-contents__link toc-highlight">Before You Begin</a></li><li><a href="#choose-a-reverse-proxy-address" class="table-of-contents__link toc-highlight">Choose a Reverse Proxy Address</a></li><li><a href="#obtain-a-wildcard-server-certificate" class="table-of-contents__link toc-highlight">Obtain a Wildcard Server Certificate</a></li><li><a href="#install-nginx" class="table-of-contents__link toc-highlight">Install NGINX</a></li><li><a href="#configure-nginx" class="table-of-contents__link toc-highlight">Configure NGINX</a></li><li><a href="#restart-nginx" class="table-of-contents__link toc-highlight">Restart NGINX</a></li><li><a href="#check-the-firewall" class="table-of-contents__link toc-highlight">Check the Firewall</a></li><li><a href="#update-the-zrok-frontend" class="table-of-contents__link toc-highlight">Update the zrok Frontend</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -89,6 +89,6 @@
|
||||
<p>There are currently no administrative API endpoints (or corresponding CLI tools) to support creating and applying limit classes in the current release. The limits agent infrastructure was designed to support software integrations that directly manipulate the underlying database structures.</p>
|
||||
<p>A future release may provide API and CLI tooling to support the human administration of the limits agent.</p>
|
||||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="performance">Performance<a href="#performance" class="hash-link" aria-label="Direct link to Performance" title="Direct link to Performance"></a></h3>
|
||||
<p>Be sure to minimize the number of different periods used for specifying bandwidth limits. Specifying limits in multiple different periods can cause a multiplicity of queries to be executed against the metrics store (InfluxDB). Standardizing on a period like <code>24h</code> or <code>6h</code> and using that consistently is the best way to to manage the performance of the metrics store.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/metrics-and-limits/configuring-limits.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/metrics-and-limits/configuring-metrics/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Configuring Metrics</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/category/oauth/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">OAuth</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#understanding-the-zrok-limits-agent" class="table-of-contents__link toc-highlight">Understanding the zrok Limits Agent</a><ul><li><a href="#types-of-limits" class="table-of-contents__link toc-highlight">Types of Limits</a></li></ul></li><li><a href="#the-global-configuration" class="table-of-contents__link toc-highlight">The Global Configuration</a><ul><li><a href="#global-resouce-count-limits" class="table-of-contents__link toc-highlight">Global Resouce Count Limits</a></li><li><a href="#global-bandwidth-limits" class="table-of-contents__link toc-highlight">Global Bandwidth Limits</a></li></ul></li><li><a href="#limit-classes" class="table-of-contents__link toc-highlight">Limit Classes</a><ul><li><a href="#unscoped-resource-count-classes" class="table-of-contents__link toc-highlight">Unscoped Resource Count Classes</a></li><li><a href="#unscoped-bandwidth-classes" class="table-of-contents__link toc-highlight">Unscoped Bandwidth Classes</a></li><li><a href="#scoped-classes" class="table-of-contents__link toc-highlight">Scoped Classes</a></li></ul></li><li><a href="#limit-actions" class="table-of-contents__link toc-highlight">Limit Actions</a></li><li><a href="#unlimited-accounts" class="table-of-contents__link toc-highlight">Unlimited Accounts</a></li><li><a href="#experimental-limits-locking" class="table-of-contents__link toc-highlight">Experimental Limits Locking</a></li><li><a href="#caveats" class="table-of-contents__link toc-highlight">Caveats</a><ul><li><a href="#aggregate-bandwidth" class="table-of-contents__link toc-highlight">Aggregate Bandwidth</a></li><li><a href="#administration-through-sql" class="table-of-contents__link toc-highlight">Administration Through SQL</a></li><li><a href="#performance" class="table-of-contents__link toc-highlight">Performance</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>Be sure to minimize the number of different periods used for specifying bandwidth limits. Specifying limits in multiple different periods can cause a multiplicity of queries to be executed against the metrics store (InfluxDB). Standardizing on a period like <code>24h</code> or <code>6h</code> and using that consistently is the best way to to manage the performance of the metrics store.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/metrics-and-limits/configuring-limits.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/metrics-and-limits/configuring-metrics/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Configuring Metrics</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/category/oauth/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">OAuth</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#understanding-the-zrok-limits-agent" class="table-of-contents__link toc-highlight">Understanding the zrok Limits Agent</a><ul><li><a href="#types-of-limits" class="table-of-contents__link toc-highlight">Types of Limits</a></li></ul></li><li><a href="#the-global-configuration" class="table-of-contents__link toc-highlight">The Global Configuration</a><ul><li><a href="#global-resouce-count-limits" class="table-of-contents__link toc-highlight">Global Resouce Count Limits</a></li><li><a href="#global-bandwidth-limits" class="table-of-contents__link toc-highlight">Global Bandwidth Limits</a></li></ul></li><li><a href="#limit-classes" class="table-of-contents__link toc-highlight">Limit Classes</a><ul><li><a href="#unscoped-resource-count-classes" class="table-of-contents__link toc-highlight">Unscoped Resource Count Classes</a></li><li><a href="#unscoped-bandwidth-classes" class="table-of-contents__link toc-highlight">Unscoped Bandwidth Classes</a></li><li><a href="#scoped-classes" class="table-of-contents__link toc-highlight">Scoped Classes</a></li></ul></li><li><a href="#limit-actions" class="table-of-contents__link toc-highlight">Limit Actions</a></li><li><a href="#unlimited-accounts" class="table-of-contents__link toc-highlight">Unlimited Accounts</a></li><li><a href="#experimental-limits-locking" class="table-of-contents__link toc-highlight">Experimental Limits Locking</a></li><li><a href="#caveats" class="table-of-contents__link toc-highlight">Caveats</a><ul><li><a href="#aggregate-bandwidth" class="table-of-contents__link toc-highlight">Aggregate Bandwidth</a></li><li><a href="#administration-through-sql" class="table-of-contents__link toc-highlight">Administration Through SQL</a></li><li><a href="#performance" class="table-of-contents__link toc-highlight">Performance</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -56,6 +56,6 @@
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">[5339.658] INFO zrok/controller/metrics.(*influxWriter).Handle: share: 736z80mr4syu, circuit: Ad1V-6y48 backend {rx: 4.5 kB, tx: 4.6 kB} frontend {rx: 4.6 kB, tx: 4.5 kB}</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">[5349.652] INFO zrok/controller/metrics.(*influxWriter).Handle: share: 736z80mr4syu, circuit: Ad1V-6y48 backend {rx: 2.5 kB, tx: 2.6 kB} frontend {rx: 2.6 kB, tx: 2.5 kB}</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">[5354.657] INFO zrok/controller/metrics.(*influxWriter).Handle: share: 5a4u7lqxb7pa, circuit: iG1--6H4S backend {rx: 13.2 kB, tx: 13.3 kB} frontend {rx: 13.3 kB, tx: 13.2 kB}</span><br></span></code></pre></div></div>
|
||||
<p>The <code>zrok</code> web console should also be showing activity for your share(s) like the following:</p>
|
||||
<p><img decoding="async" loading="lazy" alt="zrok web console activity" src="/assets/images/zrok-console-activity-5e11ec1f9f3e58b54566c42a213e4ee5.png" width="1920" height="1230" class="img_ev3q"></p>
|
||||
<p>With metrics configured, you might be interested in <a href="/docs/0.4/guides/self-hosting/metrics-and-limits/configuring-limits/">configuring limits</a>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/metrics-and-limits/configuring-metrics.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/category/metrics-and-limits/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Metrics and Limits</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/metrics-and-limits/configuring-limits/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Configuring Limits</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#configuring-the-openziti-controller" class="table-of-contents__link toc-highlight">Configuring the OpenZiti Controller</a></li><li><a href="#configuring-the-zrok-metrics-bridge" class="table-of-contents__link toc-highlight">Configuring the zrok Metrics Bridge</a><ul><li><a href="#rabbitmq" class="table-of-contents__link toc-highlight">RabbitMQ</a></li></ul></li><li><a href="#configuring-zrok-metrics" class="table-of-contents__link toc-highlight">Configuring zrok Metrics</a></li><li><a href="#testing-metrics" class="table-of-contents__link toc-highlight">Testing Metrics</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>With metrics configured, you might be interested in <a href="/docs/0.4/guides/self-hosting/metrics-and-limits/configuring-limits/">configuring limits</a>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/metrics-and-limits/configuring-metrics.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/category/metrics-and-limits/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Metrics and Limits</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/metrics-and-limits/configuring-limits/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Configuring Limits</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#configuring-the-openziti-controller" class="table-of-contents__link toc-highlight">Configuring the OpenZiti Controller</a></li><li><a href="#configuring-the-zrok-metrics-bridge" class="table-of-contents__link toc-highlight">Configuring the zrok Metrics Bridge</a><ul><li><a href="#rabbitmq" class="table-of-contents__link toc-highlight">RabbitMQ</a></li></ul></li><li><a href="#configuring-zrok-metrics" class="table-of-contents__link toc-highlight">Configuring zrok Metrics</a></li><li><a href="#testing-metrics" class="table-of-contents__link toc-highlight">Testing Metrics</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -79,6 +79,6 @@
|
||||
<p>The <code>--oauth-email-address-patterns</code> flag accepts a single glob pattern that matches an authenticated email address that is allowed to access the share. Use this flag multiple times to allow different patterns.</p>
|
||||
<p>The <code>--oauth-check-interval</code> flag specifies how frequently the authentication must be checked.</p>
|
||||
<p>An example public share:</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok share public --backend-mode web --oauth-provider github --oauth-email-address-patterns '*@zrok.io' ~/public</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/oauth/configuring-oauth.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/category/oauth/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">OAuth</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/instance-configuration/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Instance Config</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#planning-for-the-oauth-frontend" class="table-of-contents__link toc-highlight">Planning for the OAuth Frontend</a></li><li><a href="#configuring-a-google-oauth-client-id" class="table-of-contents__link toc-highlight">Configuring a Google OAuth Client ID</a><ul><li><a href="#oauth-content-screen" class="table-of-contents__link toc-highlight">OAuth Content Screen</a></li><li><a href="#create-the-oauth-20-client-id" class="table-of-contents__link toc-highlight">Create the OAuth 2.0 Client ID</a></li></ul></li><li><a href="#configuring-a-github-client-id" class="table-of-contents__link toc-highlight">Configuring a GitHub Client ID</a></li><li><a href="#configuring-your-public-frontend" class="table-of-contents__link toc-highlight">Configuring your Public Frontend</a></li><li><a href="#enabling-oauth-on-a-public-share" class="table-of-contents__link toc-highlight">Enabling OAuth on a Public Share</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok share public --backend-mode web --oauth-provider github --oauth-email-address-patterns '*@zrok.io' ~/public</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/oauth/configuring-oauth.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/category/oauth/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">OAuth</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/instance-configuration/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Instance Config</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#planning-for-the-oauth-frontend" class="table-of-contents__link toc-highlight">Planning for the OAuth Frontend</a></li><li><a href="#configuring-a-google-oauth-client-id" class="table-of-contents__link toc-highlight">Configuring a Google OAuth Client ID</a><ul><li><a href="#oauth-content-screen" class="table-of-contents__link toc-highlight">OAuth Content Screen</a></li><li><a href="#create-the-oauth-20-client-id" class="table-of-contents__link toc-highlight">Create the OAuth 2.0 Client ID</a></li></ul></li><li><a href="#configuring-a-github-client-id" class="table-of-contents__link toc-highlight">Configuring a GitHub Client ID</a></li><li><a href="#configuring-your-public-frontend" class="table-of-contents__link toc-highlight">Configuring your Public Frontend</a></li><li><a href="#enabling-oauth-on-a-public-share" class="table-of-contents__link toc-highlight">Enabling OAuth on a Public Share</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -51,6 +51,6 @@
|
||||
<p>The <code>zrok organization admin overview</code> command is used to retrieve an overview of an organization member account. This is functionally equivalent to what the <code>zrok overview</code> command does, but it allows an organization admin to retrieve the overview for another zrok account.</p>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="end-user-organization-commands">End-user Organization Commands<a href="#end-user-organization-commands" class="hash-link" aria-label="Direct link to End-user Organization Commands" title="Direct link to End-user Organization Commands"></a></h2>
|
||||
<p>All zrok accounts can use the <code>zrok organization memberships</code> command to list the organizations they're a member of:</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ zrok organization memberships</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> ORGANIZATION TOKEN DESCRIPTION ADMIN? </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> gK1XRvthq7ci documentation false </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/organizations.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/interstitial-page/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Interstitial Pages</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/personalized-frontend/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Personalized Frontend</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#configuring-an-organization" class="table-of-contents__link toc-highlight">Configuring an Organization</a><ul><li><a href="#create-an-organization" class="table-of-contents__link toc-highlight">Create an Organization</a></li><li><a href="#list-organizations" class="table-of-contents__link toc-highlight">List Organizations</a></li><li><a href="#add-a-member-to-an-organization" class="table-of-contents__link toc-highlight">Add a Member to an Organization</a></li><li><a href="#list-members-of-an-organization" class="table-of-contents__link toc-highlight">List Members of an Organization</a></li><li><a href="#removing-organizations-and-members" class="table-of-contents__link toc-highlight">Removing Organizations and Members</a></li></ul></li><li><a href="#end-user-organization-administrator-commands" class="table-of-contents__link toc-highlight">End-user Organization Administrator Commands</a></li><li><a href="#end-user-organization-commands" class="table-of-contents__link toc-highlight">End-user Organization Commands</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ zrok organization memberships</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> ORGANIZATION TOKEN DESCRIPTION ADMIN? </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> gK1XRvthq7ci documentation false </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/organizations.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/interstitial-page/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Interstitial Pages</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/personalized-frontend/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Personalized Frontend</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#configuring-an-organization" class="table-of-contents__link toc-highlight">Configuring an Organization</a><ul><li><a href="#create-an-organization" class="table-of-contents__link toc-highlight">Create an Organization</a></li><li><a href="#list-organizations" class="table-of-contents__link toc-highlight">List Organizations</a></li><li><a href="#add-a-member-to-an-organization" class="table-of-contents__link toc-highlight">Add a Member to an Organization</a></li><li><a href="#list-members-of-an-organization" class="table-of-contents__link toc-highlight">List Members of an Organization</a></li><li><a href="#removing-organizations-and-members" class="table-of-contents__link toc-highlight">Removing Organizations and Members</a></li></ul></li><li><a href="#end-user-organization-administrator-commands" class="table-of-contents__link toc-highlight">End-user Organization Administrator Commands</a></li><li><a href="#end-user-organization-commands" class="table-of-contents__link toc-highlight">End-user Organization Commands</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -45,6 +45,6 @@
|
||||
<p>Your protected resources remain disconnected from the internet and are only reachable through your personalized endpoint.</p>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="privacy">Privacy<a href="#privacy" class="hash-link" aria-label="Direct link to Privacy" title="Direct link to Privacy"></a></h2>
|
||||
<p>When you use a public frontend (with a simple <code>zrok share public</code>) at a hosted zrok instance (like zrok.io), the operators of that service have some amount of visibility into what traffic you're sending to your shares. The load balancers in front of the public frontend maintain logs describing all of the URLs that were accessed, as well as other information (headers, etc.) that contain information about the resource you're sharing.</p>
|
||||
<p>If you create private shares using <code>zrok share private</code> and then run your own <code>zrok access private</code> from some other location, the operators of the zrok service instance only know that some amount of data moved between the environment running the <code>zrok share private</code> and the <code>zrok access private</code>. There is no other information available.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/personalized-frontend.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/organizations/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Organizations</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/docker/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Docker</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#privacy" class="table-of-contents__link toc-highlight">Privacy</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>If you create private shares using <code>zrok share private</code> and then run your own <code>zrok access private</code> from some other location, the operators of the zrok service instance only know that some amount of data moved between the environment running the <code>zrok share private</code> and the <code>zrok access private</code>. There is no other information available.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/personalized-frontend.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/organizations/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Organizations</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/self-hosting/docker/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Docker</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#privacy" class="table-of-contents__link toc-highlight">Privacy</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -42,6 +42,6 @@
|
||||
<p><img decoding="async" loading="lazy" alt="Web Login" src="/assets/images/zrok_web_login-a6161cc79e66932fab76994bdfb8f9c1.png" width="1791" height="1362" class="img_ev3q"></p>
|
||||
<p>After clicking the <code>Log In</code> button, you'll be brought into the <code>zrok</code> <em>web console</em>:</p>
|
||||
<p><img decoding="async" loading="lazy" alt="Web Console; Empty" src="/assets/images/zrok_web_console_empty-cce147eaf8e7bc83abe556336a4aea98.png" width="1791" height="1362" class="img_ev3q"></p>
|
||||
<p>Congratulations! Your <code>zrok</code> account is ready to go!</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/self-service-invite.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/instance-configuration/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Instance Config</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/drives/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Drives</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#the-self-service-user-experience" class="table-of-contents__link toc-highlight">The Self-Service User Experience</a></li><li><a href="#how-it-works" class="table-of-contents__link toc-highlight">How it Works</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>Congratulations! Your <code>zrok</code> account is ready to go!</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/self-hosting/self-service-invite.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/self-hosting/instance-configuration/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Instance Config</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/guides/drives/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Drives</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#the-self-service-user-experience" class="table-of-contents__link toc-highlight">The Self-Service User Experience</a></li><li><a href="#how-it-works" class="table-of-contents__link toc-highlight">How it Works</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -54,6 +54,6 @@ In the example above server is <code>hermes(10.122.0.1)</code> and client is <co
|
||||
All devices in the VPN can access one another by IP address.</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene@calculon ~ % ssh eugene@10.122.0.1</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">Welcome to Ubuntu 23.10 (GNU/Linux 6.5.0-27-generic x86_64)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> * Documentation: https://help.ubuntu.com</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> * Management: https://landscape.canonical.com</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> * Support: https://ubuntu.com/pro</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">0 updates can be applied immediately.</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">Last login: Tue Apr 16 09:27:13 2024 from 127.0.0.1</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene@hermes:~$ who am i</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene pts/8 2024-04-16 10:04 (10.122.0.3)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene@hermes:~$</span><br></span></code></pre></div></div>
|
||||
<p>You can also make a reverse(server-to-client) connection:</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene@hermes:~$ ssh 10.122.0.3</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">Last login: Tue Apr 16 09:57:28 2024</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene@calculon ~ % who am i</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene ttys008 Apr 16 10:06 (10.122.0.1)</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/vpn/vpn.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/drives/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Drives</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/category/myzrok/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">myzrok</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#operating-system-requirements" class="table-of-contents__link toc-highlight">Operating System Requirements</a><ul><li><a href="#windows" class="table-of-contents__link toc-highlight">Windows</a></li><li><a href="#linux" class="table-of-contents__link toc-highlight">Linux</a></li><li><a href="#macos" class="table-of-contents__link toc-highlight">macOS</a></li></ul></li><li><a href="#start-the-vpn-server" class="table-of-contents__link toc-highlight">Start the VPN Server</a></li><li><a href="#reserve-a-vpn-share-token" class="table-of-contents__link toc-highlight">Reserve a VPN Share Token</a></li><li><a href="#access-the-vpn-share" class="table-of-contents__link toc-highlight">Access the VPN Share</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene@hermes:~$ ssh 10.122.0.3</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">Last login: Tue Apr 16 09:57:28 2024</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene@calculon ~ % who am i</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene ttys008 Apr 16 10:06 (10.122.0.1)</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/guides/vpn/vpn.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/guides/drives/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Drives</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/0.4/category/myzrok/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">myzrok</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#operating-system-requirements" class="table-of-contents__link toc-highlight">Operating System Requirements</a><ul><li><a href="#windows" class="table-of-contents__link toc-highlight">Windows</a></li><li><a href="#linux" class="table-of-contents__link toc-highlight">Linux</a></li><li><a href="#macos" class="table-of-contents__link toc-highlight">macOS</a></li></ul></li><li><a href="#start-the-vpn-server" class="table-of-contents__link toc-highlight">Start the VPN Server</a></li><li><a href="#reserve-a-vpn-share-token" class="table-of-contents__link toc-highlight">Reserve a VPN Share Token</a></li><li><a href="#access-the-vpn-share" class="table-of-contents__link toc-highlight">Access the VPN Share</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -77,6 +77,6 @@ or update your environment configuration to use this new frontend by default.</p
|
||||
<p>You can set the custom frontend as the environment default by running:</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok config set defaultFrontend foo-example--goPIhgtJtz</span><br></span></code></pre></div></div>
|
||||
<p>To validate which frontend is being used, use the <code>zrok status</code> command, which will identify the default frontend being used:</p>
|
||||
<p><img decoding="async" loading="lazy" alt="zrok_status" src="/assets/images/zrok_status-0ce131c6d8bba0df50b0f2a577707f0a.png" width="404" height="220" class="img_ev3q"></p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/myzrok/custom-domains/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/category/myzrok/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">myzrok</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a><ul><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a></li><li><a href="#create-your-custom-domain" class="table-of-contents__link toc-highlight">Create Your Custom Domain</a></li><li><a href="#creating-dns-records" class="table-of-contents__link toc-highlight">Creating DNS Records</a></li><li><a href="#finalizing-your-custom-domain" class="table-of-contents__link toc-highlight">Finalizing Your Custom Domain</a></li><li><a href="#start-sharing" class="table-of-contents__link toc-highlight">Start Sharing!</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p><img decoding="async" loading="lazy" alt="zrok_status" src="/assets/images/zrok_status-0ce131c6d8bba0df50b0f2a577707f0a.png" width="404" height="220" class="img_ev3q"></p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-0.4/myzrok/custom-domains/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/0.4/category/myzrok/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">myzrok</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a><ul><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a></li><li><a href="#create-your-custom-domain" class="table-of-contents__link toc-highlight">Create Your Custom Domain</a></li><li><a href="#creating-dns-records" class="table-of-contents__link toc-highlight">Creating DNS Records</a></li><li><a href="#finalizing-your-custom-domain" class="table-of-contents__link toc-highlight">Finalizing Your Custom Domain</a></li><li><a href="#start-sharing" class="table-of-contents__link toc-highlight">Start Sharing!</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -37,6 +37,6 @@ was run from.</p>
|
||||
<div class="language-html codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-html codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token tag" style="color:rgb(255, 121, 198)">html</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token tag" style="color:rgb(255, 121, 198)">body</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> </span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token tag" style="color:rgb(255, 121, 198)">h1</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token plain">Hello </span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"><</span><span class="token tag" style="color:rgb(255, 121, 198)">code</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token plain">zrok</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"></</span><span class="token tag" style="color:rgb(255, 121, 198)">code</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"></</span><span class="token tag" style="color:rgb(255, 121, 198)">h1</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token tag punctuation" style="color:rgb(248, 248, 242)"></</span><span class="token tag" style="color:rgb(255, 121, 198)">html</span><span class="token tag punctuation" style="color:rgb(248, 248, 242)">></span><br></span></code></pre></div></div>
|
||||
<p>Sharing the directory will result in the following when you access the share in a web browser:</p>
|
||||
<p><img decoding="async" loading="lazy" alt="zrok_share_web_website" src="/assets/images/zrok_share_web_website-5d4c550374b118d1992e488bb319e230.png" width="952" height="723" class="img_ev3q"></p>
|
||||
<p><code>zrok</code> contains a built-in web server, which you can use to serve static websites as a share.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/files.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/concepts/tunnels/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Sharing TCP and UDP Servers</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/concepts/opensource/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Open Source</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p><code>zrok</code> contains a built-in web server, which you can use to serve static websites as a share.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/files.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/concepts/tunnels/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Sharing TCP and UDP Servers</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/concepts/opensource/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Open Source</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -27,6 +27,6 @@ also freely available as open source software hosted by GitHub under a very perm
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="managed-service">Managed Service<a href="#managed-service" class="hash-link" aria-label="Direct link to Managed Service" title="Direct link to Managed Service"></a></h2>
|
||||
<p><code>zrok</code> is also offered as a cloud service, making it instantly accessible to a large population immediately.
|
||||
NetFoundry provides a manged version of <code>zrok</code> at <a href="https://zrok.io" target="_blank" rel="noopener noreferrer">https://zrok.io</a>. This provides the easy-to-use,
|
||||
quick to demonstrate features of <code>zrok</code> without needing to deploy and host <code>zrok</code> yourself.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/hosting.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/concepts/opensource/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Open Source</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/category/guides/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Guides</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#self-hosted" class="table-of-contents__link toc-highlight">Self-Hosted</a></li><li><a href="#managed-service" class="table-of-contents__link toc-highlight">Managed Service</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
quick to demonstrate features of <code>zrok</code> without needing to deploy and host <code>zrok</code> yourself.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/hosting.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/concepts/opensource/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Open Source</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/category/guides/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Guides</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#self-hosted" class="table-of-contents__link toc-highlight">Self-Hosted</a></li><li><a href="#managed-service" class="table-of-contents__link toc-highlight">Managed Service</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -28,6 +28,6 @@
|
||||
<p>When you execute this command, you'll get a <code>zrok</code> bridge like the following:</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">╭───────────────────────────────────────────────────────────────╮╭────────────────╮</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ http://cht7gj4g5pjf.share.zrok.io ││[PUBLIC] [PROXY]│</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╰───────────────────────────────────────────────────────────────╯╰────────────────╯</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╭─────────────────────────────────────────────────────────────────────────────────╮</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╰────────────────────────── ───────────────────────────────────────────────────────╯</span><br></span></code></pre></div></div>
|
||||
<p>The URL shown at the top of the bridge shows the address where you can access your <code>public</code> share.</p>
|
||||
<p>Hit <code>CTRL-C</code> or <code>q</code> in the bridge to exit it and delete the <code>public</code> share.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/http.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/concepts/sharing-reserved/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Reserved Shares</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/concepts/tunnels/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Sharing TCP and UDP Servers</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>Hit <code>CTRL-C</code> or <code>q</code> in the bridge to exit it and delete the <code>public</code> share.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/http.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/concepts/sharing-reserved/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Reserved Shares</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/concepts/tunnels/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Sharing TCP and UDP Servers</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -24,6 +24,6 @@
|
||||
<p><code>zrok</code> was designed to make sharing local resources both secure and easy. In this section of the <code>zrok</code> documentation, we'll tour through all of the most important features.</p>
|
||||
<p>Sharing with <code>zrok</code> can be either <a href="/docs/1.0/concepts/sharing-public/"><code>public</code></a> or <a href="/docs/1.0/concepts/sharing-private/"><code>private</code></a>.
|
||||
Naturally, regular web-based resources can be shared but <code>zrok</code> also includes support for sharing raw <a href="/docs/1.0/concepts/tunnels/">TCP</a> and <a href="/docs/1.0/concepts/tunnels/">UDP</a> network connections, and also includes a <a href="/docs/1.0/concepts/files/">website and file sharing</a> feature.</p>
|
||||
<p>Learn about <code>zrok</code> <a href="/docs/1.0/concepts/hosting/">hosting here</a>, including instructions on how to <a href="/docs/1.0/guides/self-hosting/linux/">install your own <code>zrok</code> instance</a>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/index.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/getting-started/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Getting Started</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/concepts/sharing-private/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Private Shares</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>Learn about <code>zrok</code> <a href="/docs/1.0/concepts/hosting/">hosting here</a>, including instructions on how to <a href="/docs/1.0/guides/self-hosting/linux/">install your own <code>zrok</code> instance</a>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/index.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/getting-started/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Getting Started</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/concepts/sharing-private/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Private Shares</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -32,6 +32,6 @@ project.</p>
|
||||
member of any organization. To enable <code>private</code> sharing, <code>zrok</code> was built on top of another excellent open source project named OpenZiti.</p>
|
||||
<p>OpenZiti is a secure overlay network focusing on bringing zero trust to applications. It is the <strong>backbone</strong> of <code>zrok</code>.
|
||||
In fact, <code>zrok</code> proudly proclaims itself as an Ziti <em>native</em> application.</p>
|
||||
<p>If you are interested in learning more about OpenZiti head over to <a href="https://docs.openziti.io/docs/learn/introduction/" target="_blank" rel="noopener noreferrer">the docs</a>, try the quickstart, and don't forget to star that project too. We couldn't build <code>zrok</code> without OpenZiti!</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/opensource.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/concepts/files/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Sharing Websites and Files</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/concepts/hosting/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Hosting</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#built-on-openziti" class="table-of-contents__link toc-highlight">Built on OpenZiti</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>If you are interested in learning more about OpenZiti head over to <a href="https://docs.openziti.io/docs/learn/introduction/" target="_blank" rel="noopener noreferrer">the docs</a>, try the quickstart, and don't forget to star that project too. We couldn't build <code>zrok</code> without OpenZiti!</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/opensource.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/concepts/files/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Sharing Websites and Files</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/concepts/hosting/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Hosting</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#built-on-openziti" class="table-of-contents__link toc-highlight">Built on OpenZiti</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -47,6 +47,6 @@ accessed on another user's system as if it were local to them. Privately sh
|
||||
<li><code>tcpTunnel</code>, <code>udpTunnel</code> modes forward the data payload to the target server (<a href="/docs/1.0/concepts/tunnels/">more</a>)</li>
|
||||
<li><code>socks</code> mode provides a SOCKS5 dynamic proxy on the private access bind port that tunnels TCP payloads to the share backend where they are forwarded to their destinations (<a href="https://blog.openziti.io/the-zrok-socks-backend" target="_blank" rel="noopener noreferrer">blog</a>)</li>
|
||||
<li><code>vpn</code> mode provides a network layer tunnel between the private access and the share backend (<a href="/docs/1.0/guides/vpn/">guide</a>)</li>
|
||||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/sharing-private.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/concepts/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Concepts</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/concepts/sharing-public/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Public Shares</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#peer-to-peer" class="table-of-contents__link toc-highlight">Peer to Peer</a></li><li><a href="#private-backend-modes" class="table-of-contents__link toc-highlight">Private Backend Modes</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/sharing-private.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/concepts/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Concepts</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/concepts/sharing-public/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Public Shares</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#peer-to-peer" class="table-of-contents__link toc-highlight">Peer to Peer</a></li><li><a href="#private-backend-modes" class="table-of-contents__link toc-highlight">Private Backend Modes</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -35,6 +35,6 @@
|
||||
<li><code>web</code> mode serves a target folder as a file index web page (<a href="/docs/concepts/files/">more</a>)</li>
|
||||
<li><code>drive</code> mode serves a target folder with WebDAV (<a href="/docs/guides/drives/">guide</a>)</li>
|
||||
<li><code>caddy</code> mode runs the built-in Caddy server with the targeted Caddyfile (<a href="/simple_reverse_proxy.Caddyfile" target="_blank" rel="noopener noreferrer">example</a>)</li>
|
||||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/sharing-public.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/concepts/sharing-private/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Private Shares</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/concepts/sharing-reserved/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Reserved Shares</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#peer-to-public" class="table-of-contents__link toc-highlight">Peer to Public</a></li><li><a href="#public-backend-modes" class="table-of-contents__link toc-highlight">Public Backend Modes</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/sharing-public.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/concepts/sharing-private/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Private Shares</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/concepts/sharing-reserved/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Reserved Shares</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#peer-to-public" class="table-of-contents__link toc-highlight">Peer to Public</a></li><li><a href="#public-backend-modes" class="table-of-contents__link toc-highlight">Public Backend Modes</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -31,6 +31,6 @@
|
||||
<p>This reserves public share token "toaster".</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_OeMC">Reserve with the Command Line</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok reserve public 80 --unique-name "toaster"</span><br></span></code></pre></div></div>
|
||||
<p>This shares <code>127.0.0.1:80</code> as <code>https://toaster.zrok.example.com</code> where <code>https://{token}.zrok.example.com</code> is the frontend's template.</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_OeMC">Share a Reserved Token</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok share reserved "toaster"</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/sharing-reserved.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/concepts/sharing-public/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Public Shares</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/concepts/http/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Sharing HTTP Servers</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#unique-names" class="table-of-contents__link toc-highlight">Unique Names</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_OeMC">Share a Reserved Token</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok share reserved "toaster"</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/sharing-reserved.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/concepts/sharing-public/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Public Shares</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/concepts/http/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Sharing HTTP Servers</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#unique-names" class="table-of-contents__link toc-highlight">Unique Names</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -37,6 +37,6 @@
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">╭──────────────────────────────────────────────────────────╮╭─────────────────────╮</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ access your share with: zrok access private 5adagwfl888k ││[PRIVATE] [TCPTUNNEL]│</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╰──────────────────────────────────────────────────────────╯╰─────────────────────╯</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╭─────────────────────────────────────────────────────────────────────────────────╮</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│Friday, 23-Jun-23 15:33:10 EDT ziti-edge-router │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│connId=2147483648, logical=ziti- │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│sdk[router=tls:ziti-lx:3022] -> ACCEPT 192.168.9.1:22 │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╰─────────────────────────────────────────────────────────────────────────────────╯</span><br></span></code></pre></div></div>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">╭─────────────────────────────────────────────────────────────────────────────────╮</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ tcp://127.0.0.1:9191 -> 5adagwfl888k │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╰─────────────────────────────────────────────────────────────────────────────────╯</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╭─────────────────────────────────────────────────────────────────────────────────╮</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│Friday, 23-Jun-23 15:33:10 EDT 127.0.0.1:42312 -> ACCEPT 5adagwfl888k │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">│ │</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">╰─────────────────────────────────────────────────────────────────────────────────╯</span><br></span></code></pre></div></div>
|
||||
<p>Exit the <code>access</code> client to remove the local access to the shared TCP port. Exit the <code>share</code> client to disable further accesses to the shared resource.</p>
|
||||
<p>For UDP network resources just use the <code>zrok share private --backend-mode udpTunnel</code> instead of <code>tcpTunnel</code>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/tunnels.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/concepts/http/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Sharing HTTP Servers</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/concepts/files/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Sharing Websites and Files</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>For UDP network resources just use the <code>zrok share private --backend-mode udpTunnel</code> instead of <code>tcpTunnel</code>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/concepts/tunnels.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/concepts/http/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Sharing HTTP Servers</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/concepts/files/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Sharing Websites and Files</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -35,6 +35,6 @@
|
||||
<p>When your Agent is remoted and accessible through the zrok API, you can use the <code>/agent/share/http-healthcheck</code> endpoint to remotely check your Agent's connectivity to the backend target:</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ curl -H "X-TOKEN: 5hLXj48Bmn11" -XPOST -H "Content-Type: application/zrok.v1+json" -d '{"envZId": "MxMbUXSANU", "shareToken": "8rvjpmeeyvwc", "httpVerb": "GET", "endpoint": "/", "expectedHttpResponse": 200}' http://localhost:18080/api/v1/agent/share/http-healthcheck</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">{</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> "healthy": true</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">}</span><br></span></code></pre></div></div>
|
||||
<p>A non-existent health check URL will return a non-<code>200</code> response:</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ curl -H "X-TOKEN: 5hLXj48Bmn11" -XPOST -H "Content-Type: application/zrok.v1+json" -d '{"envZId": "MxMbUXSANU", "shareToken": "8rvjpmeeyvwc", "httpVerb": "GET", "endpoint": "/non-existent", "expectedHttpResponse": 200}' http://localhost:18080/api/v1/agent/share/http-healthcheck</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">{</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> "error": "unexpected status code; got '202', want '200'"</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">}</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/agent/http-healthcheck.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/agent/remoting/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Remoting</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/agent/linux-service/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Linux Agent Service</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#local-agent-health-checks" class="table-of-contents__link toc-highlight">Local Agent Health Checks</a><ul><li><a href="#detecting-communications-errors" class="table-of-contents__link toc-highlight">Detecting Communications Errors</a></li></ul></li><li><a href="#remoted-agent-health-checks" class="table-of-contents__link toc-highlight">Remoted Agent Health Checks</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ curl -H "X-TOKEN: 5hLXj48Bmn11" -XPOST -H "Content-Type: application/zrok.v1+json" -d '{"envZId": "MxMbUXSANU", "shareToken": "8rvjpmeeyvwc", "httpVerb": "GET", "endpoint": "/non-existent", "expectedHttpResponse": 200}' http://localhost:18080/api/v1/agent/share/http-healthcheck</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">{</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> "error": "unexpected status code; got '202', want '200'"</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">}</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/agent/http-healthcheck.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/agent/remoting/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Remoting</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/agent/linux-service/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Linux Agent Service</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#local-agent-health-checks" class="table-of-contents__link toc-highlight">Local Agent Health Checks</a><ul><li><a href="#detecting-communications-errors" class="table-of-contents__link toc-highlight">Detecting Communications Errors</a></li></ul></li><li><a href="#remoted-agent-health-checks" class="table-of-contents__link toc-highlight">Remoted Agent Health Checks</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -68,6 +68,6 @@
|
||||
<li>Create new shares and accesses using simple UI widgets</li>
|
||||
<li>Stop or restart existing shares and accesses</li>
|
||||
<li>Monitor traffic and connection statistics</li>
|
||||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/agent/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/install/windows/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Windows</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/agent/remoting/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Remoting</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#tutorial" class="table-of-contents__link toc-highlight">Tutorial</a><ul><li><a href="#running-the-agent-in-the-background" class="table-of-contents__link toc-highlight">Running the Agent in the background</a></li></ul></li><li><a href="#how-the-agent-works" class="table-of-contents__link toc-highlight">How the Agent Works</a><ul><li><a href="#centralized-management" class="table-of-contents__link toc-highlight">Centralized Management</a></li><li><a href="#agent-console" class="table-of-contents__link toc-highlight">Agent Console</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/agent/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/install/windows/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Windows</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/agent/remoting/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Remoting</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#tutorial" class="table-of-contents__link toc-highlight">Tutorial</a><ul><li><a href="#running-the-agent-in-the-background" class="table-of-contents__link toc-highlight">Running the Agent in the background</a></li></ul></li><li><a href="#how-the-agent-works" class="table-of-contents__link toc-highlight">How the Agent Works</a><ul><li><a href="#centralized-management" class="table-of-contents__link toc-highlight">Centralized Management</a></li><li><a href="#agent-console" class="table-of-contents__link toc-highlight">Agent Console</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -44,6 +44,6 @@
|
||||
<p>Learn more about using the zrok agent in the <a href="/docs/1.0/guides/agent/">agent guide</a>.</p>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="troubleshooting">Troubleshooting<a href="#troubleshooting" class="hash-link" aria-label="Direct link to Troubleshooting" title="Direct link to Troubleshooting"></a></h2>
|
||||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="check-the-user-service-log">Check the User Service Log<a href="#check-the-user-service-log" class="hash-link" aria-label="Direct link to Check the User Service Log" title="Direct link to Check the User Service Log"></a></h3>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">journalctl --user -lfu zrok-agent.service</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/agent/linux-service.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/agent/http-healthcheck/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">HTTP Health Checks</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/agent/windows-service/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Windows Agent Service</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#install-the-package" class="table-of-contents__link toc-highlight">Install the Package</a></li><li><a href="#enable-your-account" class="table-of-contents__link toc-highlight">Enable your Account</a></li><li><a href="#start-the-service" class="table-of-contents__link toc-highlight">Start the Service</a></li><li><a href="#use-the-agent" class="table-of-contents__link toc-highlight">Use the agent</a></li><li><a href="#troubleshooting" class="table-of-contents__link toc-highlight">Troubleshooting</a><ul><li><a href="#check-the-user-service-log" class="table-of-contents__link toc-highlight">Check the User Service Log</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">journalctl --user -lfu zrok-agent.service</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/agent/linux-service.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/agent/http-healthcheck/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">HTTP Health Checks</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/agent/windows-service/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Windows Agent Service</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#install-the-package" class="table-of-contents__link toc-highlight">Install the Package</a></li><li><a href="#enable-your-account" class="table-of-contents__link toc-highlight">Enable your Account</a></li><li><a href="#start-the-service" class="table-of-contents__link toc-highlight">Start the Service</a></li><li><a href="#use-the-agent" class="table-of-contents__link toc-highlight">Use the agent</a></li><li><a href="#troubleshooting" class="table-of-contents__link toc-highlight">Troubleshooting</a><ul><li><a href="#check-the-user-service-log" class="table-of-contents__link toc-highlight">Check the User Service Log</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -48,6 +48,6 @@
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="unenrolling-an-agent">Unenrolling an Agent<a href="#unenrolling-an-agent" class="hash-link" aria-label="Direct link to Unenrolling an Agent" title="Direct link to Unenrolling an Agent"></a></h2>
|
||||
<p>The <code>zrok agent unenroll</code> command will remove all remote control access from an Agent in an environment:</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ zrok agent unenroll</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">SUCCESS: unenrolled agent from 'https://api-v1.zrok.io'</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">SUCCESS: removed agent-enrollment.json</span><br></span></code></pre></div></div>
|
||||
<p>Unenrolling an agent currently enrolled in remoting will result in (ignorable) agent errors. Restart your agent to resume unenrolled operation.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/agent/remoting.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/agent/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Agent</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/agent/http-healthcheck/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">HTTP Health Checks</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#enabling-agent-remoting-in-the-zrok-controller" class="table-of-contents__link toc-highlight">Enabling Agent Remoting in the zrok Controller</a></li><li><a href="#enrolling-an-agent" class="table-of-contents__link toc-highlight">Enrolling an Agent</a></li><li><a href="#the-agent-remoting-api" class="table-of-contents__link toc-highlight">The Agent Remoting API</a><ul><li><a href="#create-a-remote-share" class="table-of-contents__link toc-highlight">Create A Remote Share</a></li><li><a href="#query-the-status-of-the-remote-agent" class="table-of-contents__link toc-highlight">Query the Status of the Remote Agent</a></li><li><a href="#remove-the-remote-share" class="table-of-contents__link toc-highlight">Remove the Remote Share</a></li><li><a href="#creating-and-removing-private-access" class="table-of-contents__link toc-highlight">Creating and Removing Private Access</a></li></ul></li><li><a href="#unenrolling-an-agent" class="table-of-contents__link toc-highlight">Unenrolling an Agent</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>Unenrolling an agent currently enrolled in remoting will result in (ignorable) agent errors. Restart your agent to resume unenrolled operation.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/agent/remoting.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/agent/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Agent</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/agent/http-healthcheck/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">HTTP Health Checks</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#enabling-agent-remoting-in-the-zrok-controller" class="table-of-contents__link toc-highlight">Enabling Agent Remoting in the zrok Controller</a></li><li><a href="#enrolling-an-agent" class="table-of-contents__link toc-highlight">Enrolling an Agent</a></li><li><a href="#the-agent-remoting-api" class="table-of-contents__link toc-highlight">The Agent Remoting API</a><ul><li><a href="#create-a-remote-share" class="table-of-contents__link toc-highlight">Create A Remote Share</a></li><li><a href="#query-the-status-of-the-remote-agent" class="table-of-contents__link toc-highlight">Query the Status of the Remote Agent</a></li><li><a href="#remove-the-remote-share" class="table-of-contents__link toc-highlight">Remove the Remote Share</a></li><li><a href="#creating-and-removing-private-access" class="table-of-contents__link toc-highlight">Creating and Removing Private Access</a></li></ul></li><li><a href="#unenrolling-an-agent" class="table-of-contents__link toc-highlight">Unenrolling an Agent</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -79,6 +79,6 @@
|
||||
<div class="language-cmd codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-cmd codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">C:\>sc stop zrokAgent</span><br></span></code></pre></div></div>
|
||||
<div class="language-cmd codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-cmd codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">C:\>sc delete zrokAgent</span><br></span></code></pre></div></div>
|
||||
<p>And if you have your <code>USERPROFILE</code> environment variable properly set to <code>C:\Windows\System32\config\systemprofile</code>, you can use this command to remove the environment from your system and from the zrok service:</p>
|
||||
<div class="language-cmd codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-cmd codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">C:\Program Files\zrok>zrok disable</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/agent/windows-service/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/agent/linux-service/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Linux Agent Service</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/frontdoor/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">frontdoor</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#enabling-the-service-environment" class="table-of-contents__link toc-highlight">Enabling the Service Environment</a></li><li><a href="#installing-the-service" class="table-of-contents__link toc-highlight">Installing the Service</a></li><li><a href="#non-interactive-service-installation" class="table-of-contents__link toc-highlight">Non-interactive Service Installation</a></li><li><a href="#removing-the-zrok-agent-service" class="table-of-contents__link toc-highlight">Removing the zrok Agent Service</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<div class="language-cmd codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-cmd codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">C:\Program Files\zrok>zrok disable</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/agent/windows-service/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/agent/linux-service/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Linux Agent Service</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/frontdoor/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">frontdoor</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#enabling-the-service-environment" class="table-of-contents__link toc-highlight">Enabling the Service Environment</a></li><li><a href="#installing-the-service" class="table-of-contents__link toc-highlight">Installing the Service</a></li><li><a href="#non-interactive-service-installation" class="table-of-contents__link toc-highlight">Non-interactive Service Installation</a></li><li><a href="#removing-the-zrok-agent-service" class="table-of-contents__link toc-highlight">Removing the zrok Agent Service</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -120,6 +120,6 @@
|
||||
</ol>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="cleaning-up">Cleaning Up<a href="#cleaning-up" class="hash-link" aria-label="Direct link to Cleaning Up" title="Direct link to Cleaning Up"></a></h2>
|
||||
<p>Run the "down" command in both Compose projects to destroy them when you're all done. This will stop the running containers and delete zrok environments' storage volumes. Then delete the selected zrok environment by clicking "Actions" in the web console.</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">docker compose down --remove-orphans --volumes</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/docker-share/docker_private_share_guide.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/docker-share/docker_public_share_guide/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Public Share</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/category/self-hosting/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Self Hosting</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#goal" class="table-of-contents__link toc-highlight">Goal</a></li><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#walkthrough-video" class="table-of-contents__link toc-highlight">Walkthrough Video</a></li><li><a href="#how-it-works" class="table-of-contents__link toc-highlight">How it Works</a></li><li><a href="#before-you-begin" class="table-of-contents__link toc-highlight">Before You Begin</a></li><li><a href="#begin-sharing-privately-with-zrok-in-docker" class="table-of-contents__link toc-highlight">Begin Sharing Privately with zrok in Docker</a></li><li><a href="#access-the-private-share" class="table-of-contents__link toc-highlight">Access the Private Share</a></li><li><a href="#closed-permission-mode" class="table-of-contents__link toc-highlight">Closed Permission Mode</a></li><li><a href="#going-further-with-private-access" class="table-of-contents__link toc-highlight">Going Further with Private Access</a></li><li><a href="#cleaning-up" class="table-of-contents__link toc-highlight">Cleaning Up</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">docker compose down --remove-orphans --volumes</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/docker-share/docker_private_share_guide.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/docker-share/docker_public_share_guide/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Public Share</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/category/self-hosting/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Self Hosting</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#goal" class="table-of-contents__link toc-highlight">Goal</a></li><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#walkthrough-video" class="table-of-contents__link toc-highlight">Walkthrough Video</a></li><li><a href="#how-it-works" class="table-of-contents__link toc-highlight">How it Works</a></li><li><a href="#before-you-begin" class="table-of-contents__link toc-highlight">Before You Begin</a></li><li><a href="#begin-sharing-privately-with-zrok-in-docker" class="table-of-contents__link toc-highlight">Begin Sharing Privately with zrok in Docker</a></li><li><a href="#access-the-private-share" class="table-of-contents__link toc-highlight">Access the Private Share</a></li><li><a href="#closed-permission-mode" class="table-of-contents__link toc-highlight">Closed Permission Mode</a></li><li><a href="#going-further-with-private-access" class="table-of-contents__link toc-highlight">Going Further with Private Access</a></li><li><a href="#cleaning-up" class="table-of-contents__link toc-highlight">Cleaning Up</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -104,6 +104,6 @@ post</a>.</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">docker compose logs zrok-share</span><br></span></code></pre></div></div>
|
||||
<div class="language-buttonless codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_OeMC">Output</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-buttonless codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">INFO: zrok public URL: https://88s803f2qvao.share.zrok.io/</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/docker-share/docker_public_share_guide.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/docker-share/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Getting Started with Docker</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/docker-share/docker_private_share_guide/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Private Share</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#goal" class="table-of-contents__link toc-highlight">Goal</a></li><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#walkthrough-video" class="table-of-contents__link toc-highlight">Walkthrough Video</a></li><li><a href="#how-it-works" class="table-of-contents__link toc-highlight">How it Works</a></li><li><a href="#create-the-docker-project" class="table-of-contents__link toc-highlight">Create the Docker Project</a></li><li><a href="#proxy-any-web-server" class="table-of-contents__link toc-highlight">Proxy Any Web Server</a></li><li><a href="#require-authentication" class="table-of-contents__link toc-highlight">Require Authentication</a><ul><li><a href="#oauth-email" class="table-of-contents__link toc-highlight">OAuth Email</a></li></ul></li><li><a href="#caddy-is-powerful" class="table-of-contents__link toc-highlight">Caddy is Powerful</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/docker-share/docker_public_share_guide.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/docker-share/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Getting Started with Docker</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/docker-share/docker_private_share_guide/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Private Share</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#goal" class="table-of-contents__link toc-highlight">Goal</a></li><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#walkthrough-video" class="table-of-contents__link toc-highlight">Walkthrough Video</a></li><li><a href="#how-it-works" class="table-of-contents__link toc-highlight">How it Works</a></li><li><a href="#create-the-docker-project" class="table-of-contents__link toc-highlight">Create the Docker Project</a></li><li><a href="#proxy-any-web-server" class="table-of-contents__link toc-highlight">Proxy Any Web Server</a></li><li><a href="#require-authentication" class="table-of-contents__link toc-highlight">Require Authentication</a><ul><li><a href="#oauth-email" class="table-of-contents__link toc-highlight">OAuth Email</a></li></ul></li><li><a href="#caddy-is-powerful" class="table-of-contents__link toc-highlight">Caddy is Powerful</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -53,6 +53,6 @@
|
||||
<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>
|
||||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/docker-share/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/permission-modes/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Permission Modes</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/docker-share/docker_public_share_guide/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Public Share</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#permanent-public-share" class="table-of-contents__link toc-highlight">Permanent Public Share</a></li><li><a href="#temporary-public-share" class="table-of-contents__link toc-highlight">Temporary Public Share</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/docker-share/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/permission-modes/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Permission Modes</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/docker-share/docker_public_share_guide/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Public Share</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#permanent-public-share" class="table-of-contents__link toc-highlight">Permanent Public Share</a></li><li><a href="#temporary-public-share" class="table-of-contents__link toc-highlight">Temporary Public Share</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -85,6 +85,6 @@
|
||||
<ul>
|
||||
<li>two-way synchronization between multiple hosts... allowing for shared "dropbox-like" usage scenarios between multiple environments</li>
|
||||
<li>better ergonomics for single-file destinations</li>
|
||||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/drives.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/self-service-invite/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Invitations</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/vpn/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">VPN</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#sharing-a-drive" class="table-of-contents__link toc-highlight">Sharing a Drive</a></li><li><a href="#working-with-a-private-drive-share" class="table-of-contents__link toc-highlight">Working with a Private Drive Share</a></li><li><a href="#working-with-public-shares" class="table-of-contents__link toc-highlight">Working with Public Shares</a></li><li><a href="#one-way-synchronization" class="table-of-contents__link toc-highlight">One-way Synchronization</a></li><li><a href="#drive-to-drive-copies-and-synchronization" class="table-of-contents__link toc-highlight">Drive-to-Drive Copies and Synchronization</a></li><li><a href="#copying-from-drives-to-the-local-filesystem" class="table-of-contents__link toc-highlight">Copying from Drives to the Local Filesystem</a></li><li><a href="#unique-names-and-reserved-shares" class="table-of-contents__link toc-highlight">Unique Names and Reserved Shares</a></li><li><a href="#future-enhancements" class="table-of-contents__link toc-highlight">Future Enhancements</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/drives.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/self-service-invite/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Invitations</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/vpn/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">VPN</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#sharing-a-drive" class="table-of-contents__link toc-highlight">Sharing a Drive</a></li><li><a href="#working-with-a-private-drive-share" class="table-of-contents__link toc-highlight">Working with a Private Drive Share</a></li><li><a href="#working-with-public-shares" class="table-of-contents__link toc-highlight">Working with Public Shares</a></li><li><a href="#one-way-synchronization" class="table-of-contents__link toc-highlight">One-way Synchronization</a></li><li><a href="#drive-to-drive-copies-and-synchronization" class="table-of-contents__link toc-highlight">Drive-to-Drive Copies and Synchronization</a></li><li><a href="#copying-from-drives-to-the-local-filesystem" class="table-of-contents__link toc-highlight">Copying from Drives to the Local Filesystem</a></li><li><a href="#unique-names-and-reserved-shares" class="table-of-contents__link toc-highlight">Unique Names and Reserved Shares</a></li><li><a href="#future-enhancements" class="table-of-contents__link toc-highlight">Future Enhancements</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -97,6 +97,6 @@
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="package-contents">Package Contents<a href="#package-contents" class="hash-link" aria-label="Direct link to Package Contents" title="Direct link to Package Contents"></a></h2>
|
||||
<p>The files included in the <code>zrok-share</code> package are sourced <a href="https://github.com/openziti/zrok/tree/main/nfpm" target="_blank" rel="noopener noreferrer">here in GitHub</a>.</p></div><div role="tabpanel" class="tabItem_Ymn6" hidden=""><p>On macOS and Windows, zrok frontdoor is implemented as a Docker Compose project which reserves a public subdomain for your website or service and manages a zrok environment that's separate from the Docker host. <a href="/docs/1.0/guides/docker-share/docker_public_share_guide/">Link to the Docker Public Share Guide</a></p></div></div></div>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="concepts">Concepts<a href="#concepts" class="hash-link" aria-label="Direct link to Concepts" title="Direct link to Concepts"></a></h2>
|
||||
<p>Overview of <a href="/docs/1.0/concepts/sharing-reserved/">zrok reserved shares</a></p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/frontdoor.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/agent/windows-service/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Windows Agent Service</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/permission-modes/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Permission Modes</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>Overview of <a href="/docs/1.0/concepts/sharing-reserved/">zrok reserved shares</a></p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/frontdoor.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/agent/windows-service/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Windows Agent Service</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/permission-modes/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Permission Modes</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -52,6 +52,6 @@
|
||||
<p><a href="https://aur.archlinux.org/packages/zrok-bin" target="_blank" rel="noopener noreferrer">An Arch User Repository (AUR) package</a> is maintained by the Arch community. As of April 2025, the AUR package includes the <code>zrok</code> CLI and <a href="/docs/1.0/guides/agent/linux-service/">the <code>zrok-agent.service</code> systemd <code>--user</code> service</a>.</p>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="homebrew-formula">Homebrew Formula<a href="#homebrew-formula" class="hash-link" aria-label="Direct link to Homebrew Formula" title="Direct link to Homebrew Formula"></a></h2>
|
||||
<p>This formula is maintained by the Homebrew community.</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">brew install zrok</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/install/linux.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/install/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Install</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/install/macos/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">macOS</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#package-repository" class="table-of-contents__link toc-highlight">Package Repository</a></li><li><a href="#linux-binary" class="table-of-contents__link toc-highlight">Linux Binary</a></li><li><a href="#arch-user-repository" class="table-of-contents__link toc-highlight">Arch User Repository</a></li><li><a href="#homebrew-formula" class="table-of-contents__link toc-highlight">Homebrew Formula</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">brew install zrok</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/install/linux.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/install/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Install</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/install/macos/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">macOS</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#package-repository" class="table-of-contents__link toc-highlight">Package Repository</a></li><li><a href="#linux-binary" class="table-of-contents__link toc-highlight">Linux Binary</a></li><li><a href="#arch-user-repository" class="table-of-contents__link toc-highlight">Arch User Repository</a></li><li><a href="#homebrew-formula" class="table-of-contents__link toc-highlight">Homebrew Formula</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -44,6 +44,6 @@
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok version</span><br></span></code></pre></div></div>
|
||||
<div class="language-buttonless codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_OeMC">Output</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-buttonless codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain"> _ </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> _____ __ ___ | | __</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">|_ / '__/ _ \| |/ /</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> / /| | | (_) | < </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">/___|_| \___/|_|\_\</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">v0.4.0 [c889005]</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/install/macos.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/install/linux/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Linux</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/install/windows/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Windows</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#homebrew" class="table-of-contents__link toc-highlight">Homebrew</a></li><li><a href="#darwin-binary" class="table-of-contents__link toc-highlight">Darwin Binary</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/install/macos.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/install/linux/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Linux</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/install/windows/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Windows</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#homebrew" class="table-of-contents__link toc-highlight">Homebrew</a></li><li><a href="#darwin-binary" class="table-of-contents__link toc-highlight">Darwin Binary</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -38,6 +38,6 @@
|
||||
</li>
|
||||
</ol>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="wintun-for-zrok-vpn">Wintun for zrok VPN<a href="#wintun-for-zrok-vpn" class="hash-link" aria-label="Direct link to Wintun for zrok VPN" title="Direct link to Wintun for zrok VPN"></a></h2>
|
||||
<p>On Windows, you must install Wintun to use zrok's VPN backend mode. See the <a href="/docs/1.0/guides/vpn/">VPN guide</a> for more details.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/install/windows.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/install/macos/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">macOS</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/agent/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Agent</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#windows-binary" class="table-of-contents__link toc-highlight">Windows Binary</a></li><li><a href="#wintun-for-zrok-vpn" class="table-of-contents__link toc-highlight">Wintun for zrok VPN</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>On Windows, you must install Wintun to use zrok's VPN backend mode. See the <a href="/docs/1.0/guides/vpn/">VPN guide</a> for more details.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/install/windows.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/install/macos/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">macOS</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/agent/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Agent</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#windows-binary" class="table-of-contents__link toc-highlight">Windows Binary</a></li><li><a href="#wintun-for-zrok-vpn" class="table-of-contents__link toc-highlight">Wintun for zrok VPN</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -44,6 +44,6 @@
|
||||
<p>And to remove the grant:</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ zrok modify share s4czjylwk7wa --remove-access-grant anotheruser@test.com</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">updated</span><br></span></code></pre></div></div>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="limitations">Limitations<a href="#limitations" class="hash-link" aria-label="Direct link to Limitations" title="Direct link to Limitations"></a></h2>
|
||||
<p>As of <code>v0.4.26</code> there is currently no way to <em>list</em> the current access grants. This will be addressed shortly in a subsequent update.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/permission-modes.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/frontdoor/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">frontdoor</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/docker-share/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Getting Started with Docker</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#creating-a-share-with-closed-permission-mode" class="table-of-contents__link toc-highlight">Creating a Share with Closed Permission Mode</a></li><li><a href="#adding-and-removing-access-grants-for-existing-shares" class="table-of-contents__link toc-highlight">Adding and Removing Access Grants for Existing Shares</a></li><li><a href="#limitations" class="table-of-contents__link toc-highlight">Limitations</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>As of <code>v0.4.26</code> there is currently no way to <em>list</em> the current access grants. This will be addressed shortly in a subsequent update.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/permission-modes.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/frontdoor/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">frontdoor</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/docker-share/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Getting Started with Docker</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#creating-a-share-with-closed-permission-mode" class="table-of-contents__link toc-highlight">Creating a Share with Closed Permission Mode</a></li><li><a href="#adding-and-removing-access-grants-for-existing-shares" class="table-of-contents__link toc-highlight">Adding and Removing Access Grants for Existing Shares</a></li><li><a href="#limitations" class="table-of-contents__link toc-highlight">Limitations</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -129,6 +129,6 @@
|
||||
<p>Check certificate status:</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain"># For Caddy</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">docker compose exec caddy curl -s "http://localhost:2019/certificates"</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"># For Traefik - view the ACME certificate file directly</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">docker compose exec traefik cat /etc/traefik/acme/acme.json | grep -A 5 "Certificates"</span><br></span></code></pre></div></div>
|
||||
</li>
|
||||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/docker.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/personalized-frontend/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Personalized Frontend</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/kubernetes/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Kubernetes</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#docker-instance" class="table-of-contents__link toc-highlight">Docker Instance</a><ul><li><a href="#create-the-docker-compose-project" class="table-of-contents__link toc-highlight">Create the Docker Compose Project</a></li><li><a href="#basic-configuration-no-tls-localhost-only" class="table-of-contents__link toc-highlight">Basic Configuration (No TLS, Localhost Only)</a></li><li><a href="#expanded-configuration-with-tls-caddy-or-traefik" class="table-of-contents__link toc-highlight">Expanded Configuration with TLS (Caddy or Traefik)</a></li><li><a href="#set-up-a-user-account" class="table-of-contents__link toc-highlight">Set up a User Account</a></li><li><a href="#enable-the-user-environment" class="table-of-contents__link toc-highlight">Enable the User Environment</a></li><li><a href="#firewall-configuration" class="table-of-contents__link toc-highlight">Firewall Configuration</a></li><li><a href="#additional-configuration-options" class="table-of-contents__link toc-highlight">Additional Configuration Options</a></li><li><a href="#troubleshooting" class="table-of-contents__link toc-highlight">Troubleshooting</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/docker.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/personalized-frontend/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Personalized Frontend</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/kubernetes/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Kubernetes</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#docker-instance" class="table-of-contents__link toc-highlight">Docker Instance</a><ul><li><a href="#create-the-docker-compose-project" class="table-of-contents__link toc-highlight">Create the Docker Compose Project</a></li><li><a href="#basic-configuration-no-tls-localhost-only" class="table-of-contents__link toc-highlight">Basic Configuration (No TLS, Localhost Only)</a></li><li><a href="#expanded-configuration-with-tls-caddy-or-traefik" class="table-of-contents__link toc-highlight">Expanded Configuration with TLS (Caddy or Traefik)</a></li><li><a href="#set-up-a-user-account" class="table-of-contents__link toc-highlight">Set up a User Account</a></li><li><a href="#enable-the-user-environment" class="table-of-contents__link toc-highlight">Enable the User Environment</a></li><li><a href="#firewall-configuration" class="table-of-contents__link toc-highlight">Firewall Configuration</a></li><li><a href="#additional-configuration-options" class="table-of-contents__link toc-highlight">Additional Configuration Options</a></li><li><a href="#troubleshooting" class="table-of-contents__link toc-highlight">Troubleshooting</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -29,6 +29,6 @@
|
||||
<p>You can use the <code>zrok status</code> command to inspect the state of your local <em>environment</em>. <code>zrok</code> refers to each shell where you install and <code>enable</code> a copy of <code>zrok</code> as an <em>environment</em>.</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok status</span><br></span></code></pre></div></div>
|
||||
<div class="language-buttonless codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_OeMC">Output</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-buttonless codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">Config:</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> CONFIG VALUE SOURCE </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> apiEndpoint https://zrok.mydomain.com config </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">[WARNING]: Unable to load your local environment!</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">To create a local environment use the zrok enable command.</span><br></span></code></pre></div></div>
|
||||
<p>The <code>zrok status</code> command shows the configured API service that your environment is using, as well as the <code>SOURCE</code> where the setting was retrieved. In this case, <code>config</code> means that the setting was set into the environment using the <code>zrok config</code> command.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/instance-configuration.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/oauth/configuring-oauth/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">OAuth Public Frontend Configuration</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/self-service-invite/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Invitations</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>The <code>zrok status</code> command shows the configured API service that your environment is using, as well as the <code>SOURCE</code> where the setting was retrieved. In this case, <code>config</code> means that the setting was set into the environment using the <code>zrok config</code> command.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/instance-configuration.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/oauth/configuring-oauth/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">OAuth Public Frontend Configuration</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/self-service-invite/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Invitations</div></a></nav></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -38,6 +38,6 @@
|
||||
<p>Typically the <code>user_agent_prefixes</code> list contains <code>Mozilla/5.0</code>, which matches all typical interactive mobile and desktop browsers. Setting a non-standard <code>User-Agent</code> in an interactive browser will bypass the interstitial pages for frontends configured with the usual <code>Mozilla/5.0</code> prefix.</p>
|
||||
<p>End users can offer an HTTP header of <code>skip_zrok_interstitial</code>, set to any value to bypass the interstitial page. Setting this header means that the user most likely understands what a zrok share is and will hopefully not fall for a phishing attack.</p>
|
||||
<p>The <code>skip_zrok_interstitial</code> header is especially useful for API clients (like <code>curl</code>) and other types of non-interactive clients.</p>
|
||||
<p>The <code>drive</code> backend mode does not currently support <code>GET</code> requests and cannot be accessed with a conventional web browser, so it bypasses the interstitial page requirement.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/interstitial-page.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/linux/nginx/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">NGINX TLS</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/organizations/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Organizations</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#bypassing-the-interstitial" class="table-of-contents__link toc-highlight">Bypassing the Interstitial</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>The <code>drive</code> backend mode does not currently support <code>GET</code> requests and cannot be accessed with a conventional web browser, so it bypasses the interstitial page requirement.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/interstitial-page.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/linux/nginx/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">NGINX TLS</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/organizations/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Organizations</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#bypassing-the-interstitial" class="table-of-contents__link toc-highlight">Bypassing the Interstitial</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -138,6 +138,6 @@
|
||||
<div class="language-buttonless codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_OeMC">Example output</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-buttonless codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok environment '2AS1WZ3Sz' enabled for 'SuGzRPjVDIcF'</span><br></span></code></pre></div></div>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok status --secrets</span><br></span></code></pre></div></div>
|
||||
<div class="language-buttonless codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_OeMC">Example output</div><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-buttonless codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">Config:</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> CONFIG VALUE SOURCE</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> apiEndpoint https://zrok.quigley.com env</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">Environment:</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> PROPERTY VALUE</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> Secret Token SuGzRPjVDIcF</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> Ziti Identity 2AS1WZ3Sz</span><br></span></code></pre></div></div>
|
||||
<p>Congratulations. You have a working <code>zrok</code> environment!</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/linux/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/category/self-hosting/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Self Hosting</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/linux/nginx/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">NGINX TLS</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#walkthrough-video" class="table-of-contents__link toc-highlight">Walkthrough Video</a></li><li><a href="#before-you-begin" class="table-of-contents__link toc-highlight">Before you Begin</a></li><li><a href="#openziti" class="table-of-contents__link toc-highlight">OpenZiti</a></li><li><a href="#install-zrok" class="table-of-contents__link toc-highlight">Install zrok</a></li><li><a href="#configure-the-controller" class="table-of-contents__link toc-highlight">Configure the Controller</a></li><li><a href="#environment-variables" class="table-of-contents__link toc-highlight">Environment Variables</a></li><li><a href="#bootstrap-openziti-for-zrok" class="table-of-contents__link toc-highlight">Bootstrap OpenZiti for zrok</a></li><li><a href="#run-zrok-controller" class="table-of-contents__link toc-highlight">Run zrok Controller</a></li><li><a href="#create-zrok-frontend" class="table-of-contents__link toc-highlight">Create zrok Frontend</a></li><li><a href="#configure-the-public-frontend" class="table-of-contents__link toc-highlight">Configure the Public Frontend</a></li><li><a href="#start-public-frontend" class="table-of-contents__link toc-highlight">Start Public Frontend</a></li><li><a href="#create-a-user-account" class="table-of-contents__link toc-highlight">Create a User Account</a></li><li><a href="#invite-additional-users" class="table-of-contents__link toc-highlight">Invite Additional Users</a></li><li><a href="#enable-your-environment" class="table-of-contents__link toc-highlight">Enable Your Environment</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>Congratulations. You have a working <code>zrok</code> environment!</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/linux/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/category/self-hosting/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Self Hosting</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/linux/nginx/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">NGINX TLS</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#walkthrough-video" class="table-of-contents__link toc-highlight">Walkthrough Video</a></li><li><a href="#before-you-begin" class="table-of-contents__link toc-highlight">Before you Begin</a></li><li><a href="#openziti" class="table-of-contents__link toc-highlight">OpenZiti</a></li><li><a href="#install-zrok" class="table-of-contents__link toc-highlight">Install zrok</a></li><li><a href="#configure-the-controller" class="table-of-contents__link toc-highlight">Configure the Controller</a></li><li><a href="#environment-variables" class="table-of-contents__link toc-highlight">Environment Variables</a></li><li><a href="#bootstrap-openziti-for-zrok" class="table-of-contents__link toc-highlight">Bootstrap OpenZiti for zrok</a></li><li><a href="#run-zrok-controller" class="table-of-contents__link toc-highlight">Run zrok Controller</a></li><li><a href="#create-zrok-frontend" class="table-of-contents__link toc-highlight">Create zrok Frontend</a></li><li><a href="#configure-the-public-frontend" class="table-of-contents__link toc-highlight">Configure the Public Frontend</a></li><li><a href="#start-public-frontend" class="table-of-contents__link toc-highlight">Start Public Frontend</a></li><li><a href="#create-a-user-account" class="table-of-contents__link toc-highlight">Create a User Account</a></li><li><a href="#invite-additional-users" class="table-of-contents__link toc-highlight">Invite Additional Users</a></li><li><a href="#enable-your-environment" class="table-of-contents__link toc-highlight">Enable Your Environment</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -52,6 +52,6 @@
|
||||
<p>List available frontends to obtain the token identifier of the frontend named "public". You may need to set <code>ZROK_ADMIN_TOKEN</code> or <code>ZROK_API_ENDPOINT</code> before running <code>zrok admin</code>.</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ zrok admin list frontends</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> TOKEN ZID PUBLIC NAME URL TEMPLATE CREATED AT UPDATED AT </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> 2NiDTRYUww18 7DsLh9DXG public http://{token}.zrok.quigley.com:8080 2023-01-19 05:29:20.793 +0000 UTC 2023-01-19 06:17:25 +0000 UTC </span><br></span></code></pre></div></div>
|
||||
<p>Update the URL template to use NGINX.</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ zrok admin update frontend 2NiDTRYUww18 --url-template https://{token}.zrok.quigley.com:443</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">[ 0.028] INFO main.(*adminUpdateFrontendCommand).run: updated global frontend '2NiDTRYUww18'</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/linux/nginx.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/linux/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Linux</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/interstitial-page/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Interstitial Pages</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#walkthrough-video" class="table-of-contents__link toc-highlight">Walkthrough Video</a></li><li><a href="#before-you-begin" class="table-of-contents__link toc-highlight">Before You Begin</a></li><li><a href="#choose-a-reverse-proxy-address" class="table-of-contents__link toc-highlight">Choose a Reverse Proxy Address</a></li><li><a href="#obtain-a-wildcard-server-certificate" class="table-of-contents__link toc-highlight">Obtain a Wildcard Server Certificate</a></li><li><a href="#install-nginx" class="table-of-contents__link toc-highlight">Install NGINX</a></li><li><a href="#configure-nginx" class="table-of-contents__link toc-highlight">Configure NGINX</a></li><li><a href="#restart-nginx" class="table-of-contents__link toc-highlight">Restart NGINX</a></li><li><a href="#check-the-firewall" class="table-of-contents__link toc-highlight">Check the Firewall</a></li><li><a href="#update-the-zrok-frontend" class="table-of-contents__link toc-highlight">Update the zrok Frontend</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ zrok admin update frontend 2NiDTRYUww18 --url-template https://{token}.zrok.quigley.com:443</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">[ 0.028] INFO main.(*adminUpdateFrontendCommand).run: updated global frontend '2NiDTRYUww18'</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/linux/nginx.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/linux/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Linux</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/interstitial-page/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Interstitial Pages</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#walkthrough-video" class="table-of-contents__link toc-highlight">Walkthrough Video</a></li><li><a href="#before-you-begin" class="table-of-contents__link toc-highlight">Before You Begin</a></li><li><a href="#choose-a-reverse-proxy-address" class="table-of-contents__link toc-highlight">Choose a Reverse Proxy Address</a></li><li><a href="#obtain-a-wildcard-server-certificate" class="table-of-contents__link toc-highlight">Obtain a Wildcard Server Certificate</a></li><li><a href="#install-nginx" class="table-of-contents__link toc-highlight">Install NGINX</a></li><li><a href="#configure-nginx" class="table-of-contents__link toc-highlight">Configure NGINX</a></li><li><a href="#restart-nginx" class="table-of-contents__link toc-highlight">Restart NGINX</a></li><li><a href="#check-the-firewall" class="table-of-contents__link toc-highlight">Check the Firewall</a></li><li><a href="#update-the-zrok-frontend" class="table-of-contents__link toc-highlight">Update the zrok Frontend</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -89,6 +89,6 @@
|
||||
<p>There are currently no administrative API endpoints (or corresponding CLI tools) to support creating and applying limit classes in the current release. The limits agent infrastructure was designed to support software integrations that directly manipulate the underlying database structures.</p>
|
||||
<p>A future release may provide API and CLI tooling to support the human administration of the limits agent.</p>
|
||||
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="performance">Performance<a href="#performance" class="hash-link" aria-label="Direct link to Performance" title="Direct link to Performance"></a></h3>
|
||||
<p>Be sure to minimize the number of different periods used for specifying bandwidth limits. Specifying limits in multiple different periods can cause a multiplicity of queries to be executed against the metrics store (InfluxDB). Standardizing on a period like <code>24h</code> or <code>6h</code> and using that consistently is the best way to to manage the performance of the metrics store.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/metrics-and-limits/configuring-limits.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/metrics-and-limits/configuring-metrics/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Configuring Metrics</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/category/oauth/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">OAuth</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#understanding-the-zrok-limits-agent" class="table-of-contents__link toc-highlight">Understanding the zrok Limits Agent</a><ul><li><a href="#types-of-limits" class="table-of-contents__link toc-highlight">Types of Limits</a></li></ul></li><li><a href="#the-global-configuration" class="table-of-contents__link toc-highlight">The Global Configuration</a><ul><li><a href="#global-resouce-count-limits" class="table-of-contents__link toc-highlight">Global Resouce Count Limits</a></li><li><a href="#global-bandwidth-limits" class="table-of-contents__link toc-highlight">Global Bandwidth Limits</a></li></ul></li><li><a href="#limit-classes" class="table-of-contents__link toc-highlight">Limit Classes</a><ul><li><a href="#unscoped-resource-count-classes" class="table-of-contents__link toc-highlight">Unscoped Resource Count Classes</a></li><li><a href="#unscoped-bandwidth-classes" class="table-of-contents__link toc-highlight">Unscoped Bandwidth Classes</a></li><li><a href="#scoped-classes" class="table-of-contents__link toc-highlight">Scoped Classes</a></li></ul></li><li><a href="#limit-actions" class="table-of-contents__link toc-highlight">Limit Actions</a></li><li><a href="#unlimited-accounts" class="table-of-contents__link toc-highlight">Unlimited Accounts</a></li><li><a href="#experimental-limits-locking" class="table-of-contents__link toc-highlight">Experimental Limits Locking</a></li><li><a href="#caveats" class="table-of-contents__link toc-highlight">Caveats</a><ul><li><a href="#aggregate-bandwidth" class="table-of-contents__link toc-highlight">Aggregate Bandwidth</a></li><li><a href="#administration-through-sql" class="table-of-contents__link toc-highlight">Administration Through SQL</a></li><li><a href="#performance" class="table-of-contents__link toc-highlight">Performance</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>Be sure to minimize the number of different periods used for specifying bandwidth limits. Specifying limits in multiple different periods can cause a multiplicity of queries to be executed against the metrics store (InfluxDB). Standardizing on a period like <code>24h</code> or <code>6h</code> and using that consistently is the best way to to manage the performance of the metrics store.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/metrics-and-limits/configuring-limits.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/metrics-and-limits/configuring-metrics/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Configuring Metrics</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/category/oauth/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">OAuth</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#understanding-the-zrok-limits-agent" class="table-of-contents__link toc-highlight">Understanding the zrok Limits Agent</a><ul><li><a href="#types-of-limits" class="table-of-contents__link toc-highlight">Types of Limits</a></li></ul></li><li><a href="#the-global-configuration" class="table-of-contents__link toc-highlight">The Global Configuration</a><ul><li><a href="#global-resouce-count-limits" class="table-of-contents__link toc-highlight">Global Resouce Count Limits</a></li><li><a href="#global-bandwidth-limits" class="table-of-contents__link toc-highlight">Global Bandwidth Limits</a></li></ul></li><li><a href="#limit-classes" class="table-of-contents__link toc-highlight">Limit Classes</a><ul><li><a href="#unscoped-resource-count-classes" class="table-of-contents__link toc-highlight">Unscoped Resource Count Classes</a></li><li><a href="#unscoped-bandwidth-classes" class="table-of-contents__link toc-highlight">Unscoped Bandwidth Classes</a></li><li><a href="#scoped-classes" class="table-of-contents__link toc-highlight">Scoped Classes</a></li></ul></li><li><a href="#limit-actions" class="table-of-contents__link toc-highlight">Limit Actions</a></li><li><a href="#unlimited-accounts" class="table-of-contents__link toc-highlight">Unlimited Accounts</a></li><li><a href="#experimental-limits-locking" class="table-of-contents__link toc-highlight">Experimental Limits Locking</a></li><li><a href="#caveats" class="table-of-contents__link toc-highlight">Caveats</a><ul><li><a href="#aggregate-bandwidth" class="table-of-contents__link toc-highlight">Aggregate Bandwidth</a></li><li><a href="#administration-through-sql" class="table-of-contents__link toc-highlight">Administration Through SQL</a></li><li><a href="#performance" class="table-of-contents__link toc-highlight">Performance</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -56,6 +56,6 @@
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">[5339.658] INFO zrok/controller/metrics.(*influxWriter).Handle: share: 736z80mr4syu, circuit: Ad1V-6y48 backend {rx: 4.5 kB, tx: 4.6 kB} frontend {rx: 4.6 kB, tx: 4.5 kB}</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">[5349.652] INFO zrok/controller/metrics.(*influxWriter).Handle: share: 736z80mr4syu, circuit: Ad1V-6y48 backend {rx: 2.5 kB, tx: 2.6 kB} frontend {rx: 2.6 kB, tx: 2.5 kB}</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">[5354.657] INFO zrok/controller/metrics.(*influxWriter).Handle: share: 5a4u7lqxb7pa, circuit: iG1--6H4S backend {rx: 13.2 kB, tx: 13.3 kB} frontend {rx: 13.3 kB, tx: 13.2 kB}</span><br></span></code></pre></div></div>
|
||||
<p>The <code>zrok</code> web console should also be showing activity for your share(s) like the following:</p>
|
||||
<p><img decoding="async" loading="lazy" alt="zrok web console activity" src="/assets/images/zrok-console-activity-5e11ec1f9f3e58b54566c42a213e4ee5.png" width="1920" height="1230" class="img_ev3q"></p>
|
||||
<p>With metrics configured, you might be interested in <a href="/docs/1.0/guides/self-hosting/metrics-and-limits/configuring-limits/">configuring limits</a>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/metrics-and-limits/configuring-metrics.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/category/metrics-and-limits/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Metrics and Limits</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/metrics-and-limits/configuring-limits/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Configuring Limits</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#configuring-the-openziti-controller" class="table-of-contents__link toc-highlight">Configuring the OpenZiti Controller</a></li><li><a href="#configuring-the-zrok-metrics-bridge" class="table-of-contents__link toc-highlight">Configuring the zrok Metrics Bridge</a><ul><li><a href="#rabbitmq" class="table-of-contents__link toc-highlight">RabbitMQ</a></li></ul></li><li><a href="#configuring-zrok-metrics" class="table-of-contents__link toc-highlight">Configuring zrok Metrics</a></li><li><a href="#testing-metrics" class="table-of-contents__link toc-highlight">Testing Metrics</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>With metrics configured, you might be interested in <a href="/docs/1.0/guides/self-hosting/metrics-and-limits/configuring-limits/">configuring limits</a>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/metrics-and-limits/configuring-metrics.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/category/metrics-and-limits/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Metrics and Limits</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/metrics-and-limits/configuring-limits/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Configuring Limits</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#configuring-the-openziti-controller" class="table-of-contents__link toc-highlight">Configuring the OpenZiti Controller</a></li><li><a href="#configuring-the-zrok-metrics-bridge" class="table-of-contents__link toc-highlight">Configuring the zrok Metrics Bridge</a><ul><li><a href="#rabbitmq" class="table-of-contents__link toc-highlight">RabbitMQ</a></li></ul></li><li><a href="#configuring-zrok-metrics" class="table-of-contents__link toc-highlight">Configuring zrok Metrics</a></li><li><a href="#testing-metrics" class="table-of-contents__link toc-highlight">Testing Metrics</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -79,6 +79,6 @@
|
||||
<p>The <code>--oauth-email-address-patterns</code> flag accepts a single glob pattern that matches an authenticated email address that is allowed to access the share. Use this flag multiple times to allow different patterns.</p>
|
||||
<p>The <code>--oauth-check-interval</code> flag specifies how frequently the authentication must be checked.</p>
|
||||
<p>An example public share:</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok share public --backend-mode web --oauth-provider github --oauth-email-address-patterns '*@zrok.io' ~/public</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/oauth/configuring-oauth.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/category/oauth/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">OAuth</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/instance-configuration/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Instance Config</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#planning-for-the-oauth-frontend" class="table-of-contents__link toc-highlight">Planning for the OAuth Frontend</a></li><li><a href="#configuring-a-google-oauth-client-id" class="table-of-contents__link toc-highlight">Configuring a Google OAuth Client ID</a><ul><li><a href="#oauth-content-screen" class="table-of-contents__link toc-highlight">OAuth Content Screen</a></li><li><a href="#create-the-oauth-20-client-id" class="table-of-contents__link toc-highlight">Create the OAuth 2.0 Client ID</a></li></ul></li><li><a href="#configuring-a-github-client-id" class="table-of-contents__link toc-highlight">Configuring a GitHub Client ID</a></li><li><a href="#configuring-your-public-frontend" class="table-of-contents__link toc-highlight">Configuring your Public Frontend</a></li><li><a href="#enabling-oauth-on-a-public-share" class="table-of-contents__link toc-highlight">Enabling OAuth on a Public Share</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok share public --backend-mode web --oauth-provider github --oauth-email-address-patterns '*@zrok.io' ~/public</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/oauth/configuring-oauth.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/category/oauth/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">OAuth</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/instance-configuration/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Instance Config</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#planning-for-the-oauth-frontend" class="table-of-contents__link toc-highlight">Planning for the OAuth Frontend</a></li><li><a href="#configuring-a-google-oauth-client-id" class="table-of-contents__link toc-highlight">Configuring a Google OAuth Client ID</a><ul><li><a href="#oauth-content-screen" class="table-of-contents__link toc-highlight">OAuth Content Screen</a></li><li><a href="#create-the-oauth-20-client-id" class="table-of-contents__link toc-highlight">Create the OAuth 2.0 Client ID</a></li></ul></li><li><a href="#configuring-a-github-client-id" class="table-of-contents__link toc-highlight">Configuring a GitHub Client ID</a></li><li><a href="#configuring-your-public-frontend" class="table-of-contents__link toc-highlight">Configuring your Public Frontend</a></li><li><a href="#enabling-oauth-on-a-public-share" class="table-of-contents__link toc-highlight">Enabling OAuth on a Public Share</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -51,6 +51,6 @@
|
||||
<p>The <code>zrok organization admin overview</code> command is used to retrieve an overview of an organization member account. This is functionally equivalent to what the <code>zrok overview</code> command does, but it allows an organization admin to retrieve the overview for another zrok account.</p>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="end-user-organization-commands">End-user Organization Commands<a href="#end-user-organization-commands" class="hash-link" aria-label="Direct link to End-user Organization Commands" title="Direct link to End-user Organization Commands"></a></h2>
|
||||
<p>All zrok accounts can use the <code>zrok organization memberships</code> command to list the organizations they're a member of:</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ zrok organization memberships</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> ORGANIZATION TOKEN DESCRIPTION ADMIN? </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> gK1XRvthq7ci documentation false </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/organizations.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/interstitial-page/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Interstitial Pages</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/personalized-frontend/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Personalized Frontend</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#configuring-an-organization" class="table-of-contents__link toc-highlight">Configuring an Organization</a><ul><li><a href="#create-an-organization" class="table-of-contents__link toc-highlight">Create an Organization</a></li><li><a href="#list-organizations" class="table-of-contents__link toc-highlight">List Organizations</a></li><li><a href="#add-a-member-to-an-organization" class="table-of-contents__link toc-highlight">Add a Member to an Organization</a></li><li><a href="#list-members-of-an-organization" class="table-of-contents__link toc-highlight">List Members of an Organization</a></li><li><a href="#removing-organizations-and-members" class="table-of-contents__link toc-highlight">Removing Organizations and Members</a></li></ul></li><li><a href="#end-user-organization-administrator-commands" class="table-of-contents__link toc-highlight">End-user Organization Administrator Commands</a></li><li><a href="#end-user-organization-commands" class="table-of-contents__link toc-highlight">End-user Organization Commands</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">$ zrok organization memberships</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> ORGANIZATION TOKEN DESCRIPTION ADMIN? </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> gK1XRvthq7ci documentation false </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/organizations.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/interstitial-page/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Interstitial Pages</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/personalized-frontend/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Personalized Frontend</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#configuring-an-organization" class="table-of-contents__link toc-highlight">Configuring an Organization</a><ul><li><a href="#create-an-organization" class="table-of-contents__link toc-highlight">Create an Organization</a></li><li><a href="#list-organizations" class="table-of-contents__link toc-highlight">List Organizations</a></li><li><a href="#add-a-member-to-an-organization" class="table-of-contents__link toc-highlight">Add a Member to an Organization</a></li><li><a href="#list-members-of-an-organization" class="table-of-contents__link toc-highlight">List Members of an Organization</a></li><li><a href="#removing-organizations-and-members" class="table-of-contents__link toc-highlight">Removing Organizations and Members</a></li></ul></li><li><a href="#end-user-organization-administrator-commands" class="table-of-contents__link toc-highlight">End-user Organization Administrator Commands</a></li><li><a href="#end-user-organization-commands" class="table-of-contents__link toc-highlight">End-user Organization Commands</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -45,6 +45,6 @@
|
||||
<p>Your protected resources remain disconnected from the internet and are only reachable through your personalized endpoint.</p>
|
||||
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="privacy">Privacy<a href="#privacy" class="hash-link" aria-label="Direct link to Privacy" title="Direct link to Privacy"></a></h2>
|
||||
<p>When you use a public frontend (with a simple <code>zrok share public</code>) at a hosted zrok instance (like zrok.io), the operators of that service have some amount of visibility into what traffic you're sending to your shares. The load balancers in front of the public frontend maintain logs describing all of the URLs that were accessed, as well as other information (headers, etc.) that contain information about the resource you're sharing.</p>
|
||||
<p>If you create private shares using <code>zrok share private</code> and then run your own <code>zrok access private</code> from some other location, the operators of the zrok service instance only know that some amount of data moved between the environment running the <code>zrok share private</code> and the <code>zrok access private</code>. There is no other information available.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/personalized-frontend.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/organizations/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Organizations</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/docker/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Docker</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#privacy" class="table-of-contents__link toc-highlight">Privacy</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>If you create private shares using <code>zrok share private</code> and then run your own <code>zrok access private</code> from some other location, the operators of the zrok service instance only know that some amount of data moved between the environment running the <code>zrok share private</code> and the <code>zrok access private</code>. There is no other information available.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/personalized-frontend.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/organizations/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Organizations</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/self-hosting/docker/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Docker</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#privacy" class="table-of-contents__link toc-highlight">Privacy</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -42,6 +42,6 @@
|
||||
<p><img decoding="async" loading="lazy" alt="Web Login" src="/assets/images/zrok_web_login-a6161cc79e66932fab76994bdfb8f9c1.png" width="1791" height="1362" class="img_ev3q"></p>
|
||||
<p>After clicking the <code>Log In</code> button, you'll be brought into the <code>zrok</code> <em>web console</em>:</p>
|
||||
<p><img decoding="async" loading="lazy" alt="Web Console; Empty" src="/assets/images/zrok_web_console_empty-cce147eaf8e7bc83abe556336a4aea98.png" width="1791" height="1362" class="img_ev3q"></p>
|
||||
<p>Congratulations! Your <code>zrok</code> account is ready to go!</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/self-service-invite.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/instance-configuration/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Instance Config</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/drives/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Drives</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#the-self-service-user-experience" class="table-of-contents__link toc-highlight">The Self-Service User Experience</a></li><li><a href="#how-it-works" class="table-of-contents__link toc-highlight">How it Works</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>Congratulations! Your <code>zrok</code> account is ready to go!</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/self-hosting/self-service-invite.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/self-hosting/instance-configuration/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Instance Config</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/guides/drives/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Drives</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a></li><li><a href="#the-self-service-user-experience" class="table-of-contents__link toc-highlight">The Self-Service User Experience</a></li><li><a href="#how-it-works" class="table-of-contents__link toc-highlight">How it Works</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -54,6 +54,6 @@ In the example above server is <code>hermes(10.122.0.1)</code> and client is <co
|
||||
All devices in the VPN can access one another by IP address.</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene@calculon ~ % ssh eugene@10.122.0.1</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">Welcome to Ubuntu 23.10 (GNU/Linux 6.5.0-27-generic x86_64)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> * Documentation: https://help.ubuntu.com</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> * Management: https://landscape.canonical.com</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> * Support: https://ubuntu.com/pro</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">0 updates can be applied immediately.</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">Last login: Tue Apr 16 09:27:13 2024 from 127.0.0.1</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene@hermes:~$ who am i</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene pts/8 2024-04-16 10:04 (10.122.0.3)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene@hermes:~$</span><br></span></code></pre></div></div>
|
||||
<p>You can also make a reverse(server-to-client) connection:</p>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene@hermes:~$ ssh 10.122.0.3</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">Last login: Tue Apr 16 09:57:28 2024</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene@calculon ~ % who am i</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene ttys008 Apr 16 10:06 (10.122.0.1)</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/vpn/vpn.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/drives/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Drives</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/category/myzrok/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">myzrok</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#operating-system-requirements" class="table-of-contents__link toc-highlight">Operating System Requirements</a><ul><li><a href="#windows" class="table-of-contents__link toc-highlight">Windows</a></li><li><a href="#linux" class="table-of-contents__link toc-highlight">Linux</a></li><li><a href="#macos" class="table-of-contents__link toc-highlight">macOS</a></li></ul></li><li><a href="#start-the-vpn-server" class="table-of-contents__link toc-highlight">Start the VPN Server</a></li><li><a href="#reserve-a-vpn-share-token" class="table-of-contents__link toc-highlight">Reserve a VPN Share Token</a></li><li><a href="#access-the-vpn-share" class="table-of-contents__link toc-highlight">Access the VPN Share</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene@hermes:~$ ssh 10.122.0.3</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">Last login: Tue Apr 16 09:57:28 2024</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene@calculon ~ % who am i</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">eugene ttys008 Apr 16 10:06 (10.122.0.1)</span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/guides/vpn/vpn.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/guides/drives/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Drives</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/category/myzrok/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">myzrok</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#operating-system-requirements" class="table-of-contents__link toc-highlight">Operating System Requirements</a><ul><li><a href="#windows" class="table-of-contents__link toc-highlight">Windows</a></li><li><a href="#linux" class="table-of-contents__link toc-highlight">Linux</a></li><li><a href="#macos" class="table-of-contents__link toc-highlight">macOS</a></li></ul></li><li><a href="#start-the-vpn-server" class="table-of-contents__link toc-highlight">Start the VPN Server</a></li><li><a href="#reserve-a-vpn-share-token" class="table-of-contents__link toc-highlight">Reserve a VPN Share Token</a></li><li><a href="#access-the-vpn-share" class="table-of-contents__link toc-highlight">Access the VPN Share</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -77,6 +77,6 @@ or update your environment configuration to use this new frontend by default.</p
|
||||
<p>You can set the custom frontend as the environment default by running:</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok config set defaultFrontend foo-example--goPIhgtJtz</span><br></span></code></pre></div></div>
|
||||
<p>To validate which frontend is being used, use the <code>zrok status</code> command, which will identify the default frontend being used:</p>
|
||||
<p><img decoding="async" loading="lazy" alt="zrok_status" src="/assets/images/zrok_status-0ce131c6d8bba0df50b0f2a577707f0a.png" width="404" height="220" class="img_ev3q"></p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/myzrok/custom-domains/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/category/myzrok/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">myzrok</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/myzrok/limits/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Limits</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a><ul><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a></li><li><a href="#create-your-custom-domain" class="table-of-contents__link toc-highlight">Create Your Custom Domain</a></li><li><a href="#creating-dns-records" class="table-of-contents__link toc-highlight">Creating DNS Records</a></li><li><a href="#finalizing-your-custom-domain" class="table-of-contents__link toc-highlight">Finalizing Your Custom Domain</a></li><li><a href="#start-sharing" class="table-of-contents__link toc-highlight">Start Sharing!</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p><img decoding="async" loading="lazy" alt="zrok_status" src="/assets/images/zrok_status-0ce131c6d8bba0df50b0f2a577707f0a.png" width="404" height="220" class="img_ev3q"></p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/myzrok/custom-domains/index.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/category/myzrok/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">myzrok</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/myzrok/limits/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Limits</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#overview" class="table-of-contents__link toc-highlight">Overview</a><ul><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a></li><li><a href="#create-your-custom-domain" class="table-of-contents__link toc-highlight">Create Your Custom Domain</a></li><li><a href="#creating-dns-records" class="table-of-contents__link toc-highlight">Creating DNS Records</a></li><li><a href="#finalizing-your-custom-domain" class="table-of-contents__link toc-highlight">Finalizing Your Custom Domain</a></li><li><a href="#start-sharing" class="table-of-contents__link toc-highlight">Start Sharing!</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -37,6 +37,6 @@ The rate limits for public shares are defined below:</p>
|
||||
<p>The rate limiter will allow a burst of requests in a shorter timespan up to 2000 requests, but once the rate limit has been exceeded,
|
||||
new requests will be blocked until the request rate falls below the limit of the 300 second window.</p>
|
||||
<h4 class="anchor anchorWithStickyNavbar_LWe7" id="per-share">Per Share<a href="#per-share" class="hash-link" aria-label="Direct link to Per Share" title="Direct link to Per Share"></a></h4>
|
||||
<p>7500 requests per 300 seconds from <em>any number of IP addresses</em> (average of 25 requests per second)</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/myzrok/limits.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/myzrok/custom-domains/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Custom Domains</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/myzrok/upgrading/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Upgrading From 0.4 to 1.0</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#limits-on-shares-environments-or-bandwidth" class="table-of-contents__link toc-highlight">Limits on Shares, Environments, or Bandwidth</a></li><li><a href="#rate-limitations-for-public-shares" class="table-of-contents__link toc-highlight">Rate Limitations For Public Shares</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<p>7500 requests per 300 seconds from <em>any number of IP addresses</em> (average of 25 requests per second)</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/myzrok/limits.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/myzrok/custom-domains/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Custom Domains</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/1.0/myzrok/upgrading/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Upgrading From 0.4 to 1.0</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#limits-on-shares-environments-or-bandwidth" class="table-of-contents__link toc-highlight">Limits on Shares, Environments, or Bandwidth</a></li><li><a href="#rate-limitations-for-public-shares" class="table-of-contents__link toc-highlight">Rate Limitations For Public Shares</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -10,8 +10,8 @@
|
||||
|
||||
|
||||
<link rel="search" type="application/opensearchdescription+xml" title="zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.f094a017.css">
|
||||
<script src="/assets/js/runtime~main.3c7c1276.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.6df861b5.js" defer="defer"></script>
|
||||
<script src="/assets/js/runtime~main.564b7b76.js" defer="defer"></script>
|
||||
<script src="/assets/js/main.e070a266.js" defer="defer"></script>
|
||||
</head>
|
||||
<body class="navigation-with-keyboard">
|
||||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-MDFLZPK8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
@@ -39,6 +39,6 @@ No action is necessary.</p></div></div>
|
||||
<p>Reset the config back to the default API endpoint for the binary version</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok config unset apiEndpoint</span><br></span></code></pre></div></div>
|
||||
<p>Create a fresh environment</p>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok enable <your account token></span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/myzrok/upgrading.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/myzrok/limits/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Limits</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#upgrading-an-existing-04-environment" class="table-of-contents__link toc-highlight">Upgrading an existing 0.4 environment</a></li><li><a href="#trouble-after-upgrade" class="table-of-contents__link toc-highlight">Trouble after upgrade?</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
|
||||
<div class="language-text codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">zrok enable <your account token></span><br></span></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/openziti/zrok/blob/main/docs/versioned_docs/version-1.0/myzrok/upgrading.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/1.0/myzrok/limits/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Limits</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#upgrading-an-existing-04-environment" class="table-of-contents__link toc-highlight">Upgrading an existing 0.4 environment</a></li><li><a href="#trouble-after-upgrade" class="table-of-contents__link toc-highlight">Trouble after upgrade?</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 <a href="https://netfoundry.io">NetFoundry Inc.</a></div></div></div></footer></div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user