extern/zrok
1
1
Fork 0
mirror of https://github.com/openziti/zrok.git synced 2025-02-01 19:10:05 +01:00
Code Issues Packages Projects Releases Wiki Activity

deploy: 4cf9f37bf2

Browse Source
This commit is contained in:
qrkourier 2024-08-19 22:20:57 +00:00
parent 480f967c61
commit 3dbd4d225e
44 changed files with 54 additions and 52 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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
assets/js/d768dc0f.8e1de618.js → assets/js/d768dc0f.374d3e8d.js
View File

File diff suppressed because one or more lines are too long

1
assets/js/e1dfe4fe.309e457f.js
View File

File diff suppressed because one or more lines are too long

1
assets/js/e1dfe4fe.44c158fb.js Normal file
View File

File diff suppressed because one or more lines are too long

2
assets/js/runtime~main.ad0ba528.js → assets/js/runtime~main.9efafe91.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

12
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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -23,7 +23,7 @@
<li>A wildcard record exists for the IP address where the zrok instance will run, e.g. if your DNS zone is <code>share.example.com</code>, then your wildcard record is <code>*.share.example.com</code>.</li>
</ol>
<h4 class="anchor anchorWithStickyNavbar_LWe7" id="additional-dns-configuration-for-caddy-tls">Additional DNS Configuration for Caddy TLS<a href="#additional-dns-configuration-for-caddy-tls" class="hash-link" aria-label="Direct link to Additional DNS Configuration for Caddy TLS" title="Direct link to Additional DNS Configuration for Caddy TLS">​</a></h4>
<p>The included Caddy container can automatically manage a wildcard certificate for your zrok instance. You can enable Caddy in this compose project by renaming <code>caddy.compose.override.yml</code> as <code>compose.override.yml</code>.</p>
<p>The included Caddy container can automatically manage a wildcard certificate for your zrok instance. You can enable Caddy in this compose project by renaming <code>compose.caddy.yml</code> as <code>compose.override.yml</code>.</p>
<ol>
<li>Ensure A Caddy DNS plugin is available for your DNS provider (see <a href="https://github.com/orgs/caddy-dns/repositories?type=all&amp;q=sort%3Aname-asc" target="_blank" rel="noopener noreferrer">github.com/caddy-dns</a>).</li>
<li>Designate A DNS zone for zrok, e.g. <code>example.com</code> or <code>share.example.com</code> and create the zone on your DNS provider&#x27;s platform.</li>
@ -54,7 +54,7 @@
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="configure-the-docker-compose-project-environment">Configure the Docker Compose Project Environment<a href="#configure-the-docker-compose-project-environment" class="hash-link" aria-label="Direct link to Configure the Docker Compose Project Environment" title="Direct link to Configure the Docker Compose Project Environment">​</a></h3>
<p>Create an <code>.env</code> file in the working directory.</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_Ktv7">.env required</div><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_DNS_ZONE=share.example.com</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">ZROK_USER_EMAIL=me@example.com</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_USER_PWD=zrokuserpw</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">ZITI_PWD=zitiadminpw</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_ADMIN_TOKEN=zroktoken</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 class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_Ktv7">.env options</div><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"># Caddy TLS option: rename caddy.compose.override.yml to compose.override.yml and set these vars; allow 80,443 in firewall</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"># plugin name for your DNS provider</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">CADDY_DNS_PLUGIN=cloudflare</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"># API token from your DNS provider</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">CADDY_DNS_PLUGIN_TOKEN=abcd1234</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"># use the staging API until you&#x27;re sure everything is working to avoid hitting the rate limit</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">CADDY_ACME_API=https://acme-staging-v02.api.letsencrypt.org/directory</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"># no TLS option: publish the insecure ports to the internet and allow them in the firewall </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_INSECURE_INTERFACE=0.0.0.0</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_CTRL_PORT=18080</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_FRONTEND_PORT=8080</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_OAUTH_PORT=8081</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"># ziti ports must be published to the internet and allowed by firewall</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZITI_CTRL_ADVERTISED_PORT=1280</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZITI_ROUTER_PORT=3022</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"># configure oauth for public shares</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_OAUTH_HASH_KEY=oauthhashkeysecret</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_OAUTH_GITHUB_CLIENT_ID=abcd1234</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_OAUTH_GITHUB_CLIENT_SECRET=abcd1234</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_OAUTH_GOOGLE_CLIENT_ID=abcd1234</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_OAUTH_GOOGLE_CLIENT_SECRET=abcd1234</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"># zrok version, e.g., 1.0.0</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_CLI_TAG=latest</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"># ziti version, e.g., 1.0.0</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZITI_CLI_TAG=latest</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 class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_Ktv7">.env options</div><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"># Caddy TLS option: rename compose.caddy.yml to compose.override.yml and set these vars; allow 80,443 in firewall</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"># plugin name for your DNS provider</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">CADDY_DNS_PLUGIN=cloudflare</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"># API token from your DNS provider</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">CADDY_DNS_PLUGIN_TOKEN=abcd1234</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"># use the staging API until you&#x27;re sure everything is working to avoid hitting the rate limit</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">CADDY_ACME_API=https://acme-staging-v02.api.letsencrypt.org/directory</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"># no TLS option: publish the insecure ports to the internet and allow them in the firewall </span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_INSECURE_INTERFACE=0.0.0.0</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_CTRL_PORT=18080</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_FRONTEND_PORT=8080</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_OAUTH_PORT=8081</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"># ziti ports must be published to the internet and allowed by firewall</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZITI_CTRL_ADVERTISED_PORT=1280</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZITI_ROUTER_PORT=3022</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"># configure oauth for public shares</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_OAUTH_HASH_KEY=oauthhashkeysecret</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_OAUTH_GITHUB_CLIENT_ID=abcd1234</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_OAUTH_GITHUB_CLIENT_SECRET=abcd1234</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_OAUTH_GOOGLE_CLIENT_ID=abcd1234</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_OAUTH_GOOGLE_CLIENT_SECRET=abcd1234</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"># zrok version, e.g., 1.0.0</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_CLI_TAG=latest</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"># ziti version, e.g., 1.0.0</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZITI_CLI_TAG=latest</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>
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="start-the-docker-compose-project">Start the Docker Compose Project<a href="#start-the-docker-compose-project" class="hash-link" aria-label="Direct link to Start the Docker Compose Project" title="Direct link to Start the Docker Compose Project">​</a></h3>
<ol>
<li>
@ -65,10 +65,10 @@
</ol>
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="set-up-a-user-account">Set up a User Account<a href="#set-up-a-user-account" class="hash-link" aria-label="Direct link to Set up a User Account" title="Direct link to Set up a User Account">​</a></h3>
<p>This step creates a user account. You will log in to the zrok web console with the account password created in this step. The ZROK_USER_EMAIL and ZROK_USER_PWD variables are set in the <code>.env</code> file. You can create more user accounts the same way by substituting a different email and password.</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_Ktv7">Create the first user account</div><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-controller bash -xc &#x27;zrok admin create account /etc/zrok-controller/config.yml ${ZROK_USER_EMAIL} ${ZROK_USER_PWD}&#x27;</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 class="language-buttonless codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_Ktv7">Example output</div><div class="codeBlockContent_biex"><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 admin create account /etc/zrok-controller/config.yml me@example.com zrokuserpw</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">[ 0.000] INFO zrok/controller/store.Open: database connected</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">[ 0.002] INFO zrok/controller/store.(*Store).migrate: applied 0 migrations</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">heMqncCyxZcx</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 class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_Ktv7">Create the first user account</div><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-controller bash -xc &#x27;zrok admin create account ${ZROK_USER_EMAIL} ${ZROK_USER_PWD}&#x27;</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 class="language-buttonless codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_Ktv7">Example output</div><div class="codeBlockContent_biex"><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 admin create account me@example.com zrokuserpw</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">[ 0.000] INFO zrok/controller/store.Open: database connected</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">[ 0.002] INFO zrok/controller/store.(*Store).migrate: applied 0 migrations</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">heMqncCyxZcx</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>Create additional users by running the command again with a different email and password.</p>
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_Ktv7">Create another user</div><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-controller zrok admin create account /etc/zrok-controller/config.yml &lt;email&gt; &lt;password&gt;</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 class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_Ktv7">Create another user</div><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-controller zrok admin create account &lt;email&gt; &lt;password&gt;</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>
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="enable-the-user-environment">Enable the User Environment<a href="#enable-the-user-environment" class="hash-link" aria-label="Direct link to Enable the User Environment" title="Direct link to Enable the User Environment">​</a></h3>
<p>You must enable each device environment with the account token obtained when the account was created. This is separate from the account password that&#x27;s used to log in to the web console.</p>
<p>Follow <a href="/docs/getting-started/#installing-the-zrok-command">the getting started guide</a> to install the zrok CLI on some device and enable a zrok environment.</p>

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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/self-hosting/interstitial-page/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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

6
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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -104,7 +104,7 @@
<p>Create an http frontend configuration file in <code>etc/http-frontend.yml</code>.</p>
<div class="language-yaml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-yaml codeBlock_bY9V thin-scrollbar" style="color:#F8F8F2;background-color:#282A36"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token key atrule">v</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> </span><span class="token number">3</span><span class="token plain"></span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token key atrule">host_match</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> zrok.quigley.com</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"></span><span class="token key atrule">address</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token plain"> 0.0.0.0</span><span class="token punctuation" style="color:rgb(248, 248, 242)">:</span><span class="token number">8080</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>This frontend config file has a <code>host_match</code> pattern that represents the DNS zone you&#x27;re using with this instance of <code>zrok</code>. Incoming HTTP requests with a matching <code>Host</code> header will be handled by this frontend. You may also specify the interface address where the frontend will listen for public access requests.</p>
<p>The frontend does not provide server TLS, but you may front the server with a reverse proxy. It is essential the reverse proxy forwards the <code>Host</code> header supplied by the viewer. This example will expose the non-TLS listener for the frontend.</p>
<p>The frontend does not provide server TLS, but you may front the server with a reverse proxy. The reverse proxy must forward the <code>Host</code> header supplied by the viewer. This example will expose the non-TLS listener for the frontend.</p>
<p>You can also specify an <code>oauth</code> configuration in this file, full details of are found in <a href="/docs/guides/self-hosting/oauth/configuring-oauth/#configuring-your-public-frontend">OAuth Public Frontend Configuration</a>.</p>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="start-public-frontend">Start Public Frontend<a href="#start-public-frontend" class="hash-link" aria-label="Direct link to Start Public Frontend" title="Direct link to Start Public Frontend">​</a></h2>
<p>In another terminal window, run:</p>
@ -112,7 +112,7 @@
<p>The <code>zrok</code> frontend uses the <code>public</code> identity created during the bootstrap process to securely access zrok backends. to provide public access for the <code>zrok</code> deployment. It is expected that the configured listener for this frontend corresponds to the DNS template specified when creating the public frontend record above.</p>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="create-a-user-account">Create a User Account<a href="#create-a-user-account" class="hash-link" aria-label="Direct link to Create a User Account" title="Direct link to Create a User Account">​</a></h2>
<p>With our <code>ZROK_ADMIN_TOKEN</code> and <code>ZROK_API_ENDPOINT</code> environment variables set, we can create our first user account.</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 admin create account etc/ctrl.yml &lt;email&gt; &lt;password&gt;</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 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 admin create account &lt;email&gt; &lt;password&gt;</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>The output is the account token you will use to enable each device&#x27;s zrok environment.</p>
<div class="language-buttonless codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockTitle_Ktv7">Example output</div><div class="codeBlockContent_biex"><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">SuGzRPjVDIcF</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="invite-additional-users">Invite Additional Users<a href="#invite-additional-users" class="hash-link" aria-label="Direct link to Invite Additional Users" title="Direct link to Invite Additional Users">​</a></h2>

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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/self-hosting/personalized-frontend/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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.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.ad0ba528.js" defer="defer"></script>
<script src="/assets/js/runtime~main.9efafe91.js" defer="defer"></script>
<script src="/assets/js/main.919bd9e8.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

10
zrok-instance/README.md
View File

@ -11,7 +11,7 @@ This Docker Compose project creates a zrok instance and includes a ziti controll
#### Additional DNS Configuration for Caddy TLS
The included Caddy container can automatically manage a wildcard certificate for your zrok instance. You can enable Caddy in this compose project by renaming `caddy.compose.override.yml` as `compose.override.yml`.
The included Caddy container can automatically manage a wildcard certificate for your zrok instance. You can enable Caddy in this compose project by renaming `compose.caddy.yml` as `compose.override.yml`.
1. Ensure A Caddy DNS plugin is available for your DNS provider (see [github.com/caddy-dns](https://github.com/orgs/caddy-dns/repositories?type=all&q=sort%3Aname-asc)).
1. Designate A DNS zone for zrok, e.g. `example.com` or `share.example.com` and create the zone on your DNS provider's platform.
@ -64,7 +64,7 @@ ZROK_ADMIN_TOKEN=zroktoken
```
```bash title=".env options"
# Caddy TLS option: rename caddy.compose.override.yml to compose.override.yml and set these vars; allow 80,443 in firewall
# Caddy TLS option: rename compose.caddy.yml to compose.override.yml and set these vars; allow 80,443 in firewall
# plugin name for your DNS provider
CADDY_DNS_PLUGIN=cloudflare
# API token from your DNS provider
@ -110,11 +110,11 @@ ZITI_CLI_TAG=latest
This step creates a user account. You will log in to the zrok web console with the account password created in this step. The ZROK_USER_EMAIL and ZROK_USER_PWD variables are set in the `.env` file. You can create more user accounts the same way by substituting a different email and password.
```bash title="Create the first user account"
docker compose exec zrok-controller bash -xc 'zrok admin create account /etc/zrok-controller/config.yml ${ZROK_USER_EMAIL} ${ZROK_USER_PWD}'
docker compose exec zrok-controller bash -xc 'zrok admin create account ${ZROK_USER_EMAIL} ${ZROK_USER_PWD}'
```
```buttonless title="Example output"
+ zrok admin create account /etc/zrok-controller/config.yml me@example.com zrokuserpw
+ zrok admin create account me@example.com zrokuserpw
[ 0.000] INFO zrok/controller/store.Open: database connected
[ 0.002] INFO zrok/controller/store.(*Store).migrate: applied 0 migrations
heMqncCyxZcx
@ -123,7 +123,7 @@ heMqncCyxZcx
Create additional users by running the command again with a different email and password.
```bash title="Create another user"
docker compose exec zrok-controller zrok admin create account /etc/zrok-controller/config.yml <email> <password>
docker compose exec zrok-controller zrok admin create account <email> <password>
```
### Enable the User Environment

0
zrok-instance/caddy.compose.override.yml → zrok-instance/compose.caddy.yml
View File

2
zrok-instance/compose.yml
View File

@ -114,6 +114,8 @@ services:
environment:
ZROK_USER_PWD: ${ZROK_USER_PWD} # admin account password (initial user account)
ZROK_USER_EMAIL: ${ZROK_USER_EMAIL} # login email address (initial user account)
ZROK_ADMIN_TOKEN: ${ZROK_ADMIN_TOKEN} # zrok controller admin password
ZROK_API_ENDPOINT: http://zrok-controller:${ZROK_CTRL_PORT:-18080} # bridge address of the zrok controller
zrok-frontend:
depends_on: