extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2024-12-31 11:09:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

deploy: 920c598a00

Browse Source
This commit is contained in:
qrkourier 2024-07-08 15:24:22 +00:00
parent 1786583af8
commit badfea1c54
42 changed files with 72 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
404.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

1
assets/js/bbbe662c.48b3d7ab.js Normal file
View File

File diff suppressed because one or more lines are too long

1
assets/js/bbbe662c.b1bdc9a0.js
View File

File diff suppressed because one or more lines are too long

2
assets/js/runtime~main.ccdf759e.js → assets/js/runtime~main.935f139e.js
View File

File diff suppressed because one or more lines are too long

2
docs/category/guides/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/category/metrics-and-limits/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/category/oauth/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/category/self-hosting/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/files/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/hosting/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/http/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/opensource/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/sharing-private/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/sharing-public/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/sharing-reserved/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/concepts/tunnels/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/getting-started/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

15
docs/guides/docker-share/docker_private_share_guide/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -31,7 +31,7 @@
<li>start sharing the target specified in the <code>ZROK_TARGET</code> environment variable</li>
</ol>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="before-you-begin">Before You Begin<a href="#before-you-begin" class="hash-link" aria-label="Direct link to Before You Begin" title="Direct link to Before You Begin">​</a></h2>
<p>To follow this guide you will need <a href="https://docs.docker.com/get-docker/" target="_blank" rel="noopener noreferrer">Docker</a> and <a href="https://docs.docker.com/compose/install/" target="_blank" rel="noopener noreferrer">the Docker Compose plugin</a> for running <code>docker compose</code> commands in your terminal.</p>
<p>To follow this guide you will need <a href="https://docs.docker.com/get-docker/" target="_blank" rel="noopener noreferrer">Docker</a>.</p>
<p>If you have installed Docker Desktop on macOS or Windows then you are all set.</p>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="begin-sharing-privately-with-zrok-in-docker">Begin Sharing Privately with zrok in Docker<a href="#begin-sharing-privately-with-zrok-in-docker" class="hash-link" aria-label="Direct link to Begin Sharing Privately with zrok in Docker" title="Direct link to Begin Sharing Privately with zrok in Docker">​</a></h2>
<p>First, let&#x27;s create the private share.</p>
@ -91,6 +91,15 @@
<p>Now your zrok private access proxy is ready on <a href="http://127.0.0.1:9191" target="_blank" rel="noopener noreferrer">http://127.0.0.1:9191</a>. You can visit the demo web server in your browser.</p>
</li>
</ol>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="closed-permission-mode">Closed Permission Mode<a href="#closed-permission-mode" class="hash-link" aria-label="Direct link to Closed Permission Mode" title="Direct link to Closed Permission Mode">​</a></h2>
<p>Normally, you need only the share token to access a private share. You can further restrict access with &quot;closed&quot; permission mode.</p>
<p>You must set the permission mode before you reserve the share.</p>
<p>Only your own account can access the private share.</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><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_PERMISSION_MODE=closed</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<p>Grant access to additional zrok accounts.</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><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_ACCESS_GRANTS=&quot;bob@example.com alice@example.org&quot;</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<p>You can adjust the access grants by running the CLI inside the <code>zrok-share</code> container.</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><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 exec zrok-share zrok modify ${ZROK_UNIQUE_NAME} --remove-access-grant bob@example.com</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="going-further-with-private-access">Going Further with Private Access<a href="#going-further-with-private-access" class="hash-link" aria-label="Direct link to Going Further with Private Access" title="Direct link to Going Further with Private Access">​</a></h2>
<ol>
<li>
@ -106,6 +115,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 &quot;down&quot; command in both Compose projects to destroy them when you&#x27;re all done. This will stop the running containers and delete zrok environments&#x27; storage volumes. Then delete the selected zrok environment by clicking &quot;Actions&quot; 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_biex"><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 class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></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/../docs/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="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/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/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="#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="footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 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_biex"><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 class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></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/../docs/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="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/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/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="footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 NetFoundry Inc. Built with Docusaurus.</div></div></div></footer></div>
</body>
</html>

2
docs/guides/docker-share/docker_public_share_guide/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/docker-share/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/drives/cli/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/frontdoor/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/install/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/install/linux/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/install/macos/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/install/windows/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/permission-modes/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/self-hosting/docker/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/self-hosting/instance-configuration/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/self-hosting/linux/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/self-hosting/linux/nginx/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/self-hosting/metrics-and-limits/configuring-limits/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/self-hosting/metrics-and-limits/configuring-metrics/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/self-hosting/oauth/configuring-oauth/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/vpn/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
search/index.html
View File

@ -9,7 +9,7 @@
<link rel="search" type="application/opensearchdescription+xml" title="Zrok" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.44f28847.css">
<script src="/assets/js/runtime~main.ccdf759e.js" defer="defer"></script>
<script src="/assets/js/runtime~main.935f139e.js" defer="defer"></script>
<script src="/assets/js/main.5d16ecbc.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
zrok-private-access/compose.yml
View File

@ -17,7 +17,7 @@ services:
volumes:
- zrok_env:/mnt
environment:
STATE_DIRECTORY: /mnt
HOME: /mnt
ZROK_ENABLE_TOKEN:
ZROK_API_ENDPOINT:
ZROK_ENVIRONMENT_NAME: docker-private-access

32
zrok-private-share/compose.yml
View File

@ -17,30 +17,38 @@ services:
volumes:
- zrok_env:/mnt
environment:
STATE_DIRECTORY: /mnt
HOME: /mnt
ZROK_ENABLE_TOKEN:
ZROK_API_ENDPOINT:
ZROK_ENVIRONMENT_NAME: docker-private-share
zrok-share:
image: ${ZROK_CONTAINER_IMAGE:-docker.io/openziti/zrok}
restart: no
entrypoint:
- bash
- -euxc
- |
echo "DEBUG: HOME=$${HOME}"
ls -lA /mnt/.zrok/
exec zrok $${@}
command: -- share private --headless --backend-mode proxy ${ZROK_TARGET:-http://zrok-test:9090/}
restart: unless-stopped
entrypoint: zrok-share.bash
depends_on:
zrok-enable:
condition: service_completed_successfully
volumes:
- zrok_env:/mnt
environment:
HOME: /mnt
PFXLOG_NO_JSON: "true"
# internal configuration
HOME: /mnt # zrok homedir in container
# most relevant options
ZROK_UNIQUE_NAME: # name is used to construct frontend domain name, e.g. "myapp" in "myapp.share.zrok.io"
ZROK_BACKEND_MODE: # web, caddy, drive, proxy
ZROK_TARGET: # backend target, is a path in container filesystem unless proxy mode
ZROK_INSECURE: # "--insecure" if proxy target has unverifiable TLS server certificate
ZROK_BASIC_AUTH: # username:password
ZROK_PERMISSION_MODE: # if "closed" allow only your account and additional accounts in ZROK_ACCESS_GRANTS
ZROK_ACCESS_GRANTS: # space-separated list of additional zrok account emails to grant access in closed permission mode
# least relevant options
ZROK_VERBOSE: # "--verbose"
ZROK_SHARE_OPTS: # additional arguments to "zrok reserve private" command
ZROK_FRONTEND_MODE: reserved-private
PFXLOG_NO_JSON: "true" # suppress JSON logging format
# demo server you can share with zrok
zrok-test:

2
zrok-public-reserved/compose.override.yml
View File

@ -15,4 +15,4 @@ services:
ZROK_BACKEND_MODE: caddy
ZROK_TARGET: /Caddyfile
# internal configuration
STATE_DIRECTORY: /mnt # zrok homedir in container
HOME: /mnt # zrok homedir in container

4
zrok-public-reserved/compose.yml
View File

@ -18,7 +18,7 @@ services:
volumes:
- zrok_env:/mnt
environment:
STATE_DIRECTORY: /mnt
HOME: /mnt
ZROK_ENABLE_TOKEN:
ZROK_API_ENDPOINT:
ZROK_ENVIRONMENT_NAME:
@ -35,7 +35,7 @@ services:
- zrok_env:/mnt
environment:
# internal configuration
STATE_DIRECTORY: /mnt # zrok homedir in container
HOME: /mnt # zrok homedir in container
# most relevant options
ZROK_UNIQUE_NAME: # name is used to construct frontend domain name, e.g. "myapp" in "myapp.share.zrok.io"