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

deploy: f11819fe73

Browse Source
This commit is contained in:
qrkourier 2024-05-20 13:53:28 +00:00
parent 7799703585
commit 7d84b0d8b4
40 changed files with 53 additions and 46 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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

1
assets/js/e1dfe4fe.526749f8.js Normal file
View File

File diff suppressed because one or more lines are too long

1
assets/js/e1dfe4fe.54d38c3a.js
View File

File diff suppressed because one or more lines are too long

2
assets/js/runtime~main.757cf1b2.js → assets/js/runtime~main.0a87592b.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

4
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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@ -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"># 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"># zrok version, e.g., 1.0.0</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZROK_IMAGE_TAG=latest</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 version, e.g., 1.0.0</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain">ZITI_IMAGE_TAG=latest</span><br></span><span class="token-line" style="color:#F8F8F2"><span class="token plain"># ziti ports</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></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_IMAGE_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_IMAGE_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>

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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.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.e053e05e.css">
<script src="/assets/js/runtime~main.757cf1b2.js" defer="defer"></script>
<script src="/assets/js/runtime~main.0a87592b.js" defer="defer"></script>
<script src="/assets/js/main.11d64925.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

17
zrok-instance/README.md
View File

@ -64,6 +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
# plugin name for your DNS provider
CADDY_DNS_PLUGIN=cloudflare
# API token from your DNS provider
@ -71,12 +72,13 @@ CADDY_DNS_PLUGIN_TOKEN=abcd1234
# use the staging API until you're sure everything is working to avoid hitting the rate limit
CADDY_ACME_API=https://acme-staging-v02.api.letsencrypt.org/directory
# zrok version, e.g., 1.0.0
ZROK_IMAGE_TAG=latest
# no TLS option: publish the insecure ports to the internet and allow them in the firewall
ZROK_INSECURE_INTERFACE=0.0.0.0
ZROK_CTRL_PORT=18080
ZROK_FRONTEND_PORT=8080
ZROK_OAUTH_PORT=8081
# ziti version, e.g., 1.0.0
ZITI_IMAGE_TAG=latest
# ziti ports
# ziti ports must be published to the internet and allowed by firewall
ZITI_CTRL_ADVERTISED_PORT=1280
ZITI_ROUTER_PORT=3022
@ -86,6 +88,11 @@ ZROK_OAUTH_GITHUB_CLIENT_ID=abcd1234
ZROK_OAUTH_GITHUB_CLIENT_SECRET=abcd1234
ZROK_OAUTH_GOOGLE_CLIENT_ID=abcd1234
ZROK_OAUTH_GOOGLE_CLIENT_SECRET=abcd1234
# zrok version, e.g., 1.0.0
ZROK_IMAGE_TAG=latest
# ziti version, e.g., 1.0.0
ZITI_IMAGE_TAG=latest
```
### Start the Docker Compose Project

6
zrok-instance/compose.yml
View File

@ -110,7 +110,7 @@ services:
expose:
- ${ZROK_CTRL_PORT:-18080} # (not published)
ports:
- 127.0.0.1:${ZROK_CTRL_PORT:-18080}:${ZROK_CTRL_PORT:-18080}
- ${ZROK_INSECURE_INTERFACE:-127.0.0.1}:${ZROK_CTRL_PORT:-18080}:${ZROK_CTRL_PORT:-18080}
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)
@ -144,8 +144,8 @@ services:
- ${ZROK_FRONTEND_PORT:-8080} # (not published)
- ${ZROK_OAUTH_PORT:-8081} # (not published)
ports:
- 127.0.0.1:${ZROK_FRONTEND_PORT:-8080}:${ZROK_FRONTEND_PORT:-8080}
- 127.0.0.1:${ZROK_OAUTH_PORT:-8081}:${ZROK_OAUTH_PORT:-8081}
- ${ZROK_INSECURE_INTERFACE:-127.0.0.1}:${ZROK_FRONTEND_PORT:-8080}:${ZROK_FRONTEND_PORT:-8080}
- ${ZROK_INSECURE_INTERFACE:-127.0.0.1}:${ZROK_OAUTH_PORT:-8081}:${ZROK_OAUTH_PORT:-8081}
environment:
HOME: /var/lib/zrok-frontend
ZROK_DNS_ZONE: ${ZROK_DNS_ZONE} # e.g., "example.com" or "127.0.0.1.sslip.io"