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

deploy: 73e66c3ef6

Browse Source
This commit is contained in:
qrkourier 2025-01-29 15:10:29 +00:00
parent 4cfb047c5f
commit 74db59f4a8
45 changed files with 72 additions and 45 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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

1
assets/js/e1dfe4fe.064a8faa.js Normal file
View File

File diff suppressed because one or more lines are too long

1
assets/js/e1dfe4fe.c64343b7.js
View File

File diff suppressed because one or more lines are too long

2
assets/js/runtime~main.0f9b92c3.js → assets/js/runtime~main.8a1caa1d.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/drives/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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/linux-user-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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

14
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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -101,11 +101,21 @@
<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 logs zrok-controller</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>
</li>
<li>
<p>Check the caddy logs.</p>
<p>Check the Caddy logs.</p>
<p>It can take a few minutes for Caddy to obtain the wildcard certificate. You can check the logs to see if there were any errors completing the DNS challenge which involves using the Caddy DNS plugin to create a TXT record in your DNS zone. This leverages the API token you provided in the <code>.env</code> file, which must have permission to create DNS records in the zrok DNS zone.</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 logs caddy</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>
</li>
<li>
<p>Caddy keeps failing to obtain a wildcard certificate because it timed out waiting for DNS.</p>
<p>Symptom: the Caddy log contains &quot;timed out waiting for record to fully propagate.&quot; This means that Caddy added a DNS record with your DNS provider&#x27;s API to prove to the CA it controls the zrok DNS zone, but it wasn&#x27;t able to verify the record was created successfully with a DNS query.</p>
<p>Solutions:</p>
<ul>
<li>Add <code>propagation_delay</code> in your <code>Caddyfile</code> to delay the first DNS verification query. This avoids caching a verification query failure by waiting a few minutes for the record to become available so the verification query will succeed on the first attempt. Caddy will be unable to verify the DNS record if the failure remains in the cache too long.</li>
<li>If the prior solution fails, you can override the default resolves/nameservers with <code>resolvers</code>, a space-separated list of DNS servers. This gives you more control over if and where the verification query result is cached.</li>
</ul>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><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">tls {</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> dns {CADDY_DNS_PLUGIN} {CADDY_DNS_PLUGIN_TOKEN}</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> propagation_timeout 60m # default 2m</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"> propagation_delay 5m # default 0m</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">}</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>
</li>
<li>
<p><code>zrok enable</code> fails certificate verification: ensure you are not using the staging API for Let&#x27;s Encrypt.</p>
<p>If you are using the staging API, you will see an error about the API certificate when you use the zrok CLI. You can switch to the production API by removing the overriding assignment of the <code>CADDY_ACME_API</code> variable.</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">there was a problem enabling your environment!</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">you are trying to use the zrok service at: https://zrok.share.example.com</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">you can change your zrok service endpoint using this command:</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 config set apiEndpoint &lt;newEndpoint&gt;</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">(where newEndpoint is something like: https://some.zrok.io)</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">[ERROR]: error creating service client (error getting version from api endpoint &#x27;https://zrok.share.example.com&#x27;: Get &quot;https://zrok.share.example.com/api/v1/version&quot;: tls: failed to verify certificate: x509: certificate signed by unknown authority: Get &quot;https://zrok.share.example.com/api/v1/version&quot;: tls: failed to verify certificate: x509: certificate signed by unknown authority)</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>

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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/self-hosting/kubernetes/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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/self-hosting/organizations/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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/guides/self-hosting/self-service-invite/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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.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.bb90e80b.css">
<script src="/assets/js/runtime~main.0f9b92c3.js" defer="defer"></script>
<script src="/assets/js/runtime~main.8a1caa1d.js" defer="defer"></script>
<script src="/assets/js/main.9e5a9d8c.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

19
zrok-instance/README.md
View File

@ -190,7 +190,7 @@ See "My internet connection can only send traffic to common ports" below about c
docker compose logs zrok-controller
```
1. Check the caddy logs.
1. Check the Caddy logs.
It can take a few minutes for Caddy to obtain the wildcard certificate. You can check the logs to see if there were any errors completing the DNS challenge which involves using the Caddy DNS plugin to create a TXT record in your DNS zone. This leverages the API token you provided in the `.env` file, which must have permission to create DNS records in the zrok DNS zone.
@ -198,6 +198,23 @@ See "My internet connection can only send traffic to common ports" below about c
docker compose logs caddy
```
1. Caddy keeps failing to obtain a wildcard certificate because it timed out waiting for DNS.
Symptom: the Caddy log contains "timed out waiting for record to fully propagate." This means that Caddy added a DNS record with your DNS provider's API to prove to the CA it controls the zrok DNS zone, but it wasn't able to verify the record was created successfully with a DNS query.
Solutions:
- Add `propagation_delay` in your `Caddyfile` to delay the first DNS verification query. This avoids caching a verification query failure by waiting a few minutes for the record to become available so the verification query will succeed on the first attempt. Caddy will be unable to verify the DNS record if the failure remains in the cache too long.
- If the prior solution fails, you can override the default resolves/nameservers with `resolvers`, a space-separated list of DNS servers. This gives you more control over if and where the verification query result is cached.
```
tls {
dns {CADDY_DNS_PLUGIN} {CADDY_DNS_PLUGIN_TOKEN}
propagation_timeout 60m # default 2m
propagation_delay 5m # default 0m
}
```
1. `zrok enable` fails certificate verification: ensure you are not using the staging API for Let's Encrypt.
If you are using the staging API, you will see an error about the API certificate when you use the zrok CLI. You can switch to the production API by removing the overriding assignment of the `CADDY_ACME_API` variable.