deploy: a17de9d0fe

assets/js/1772.ad1487e6.js

@@ -1 +1 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[1772],{5658:(e,t,i)=>{i.d(t,{Z:()=>a});i(7294);var n=i(6905),s=i(5999),o=i(2503),r=i(5893);function a(e){let{className:t}=e;return(0,r.jsx)("main",{className:(0,n.Z)("container margin-vert--xl",t),children:(0,r.jsx)("div",{className:"row",children:(0,r.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,r.jsx)(o.Z,{as:"h1",className:"hero__title",children:(0,r.jsx)(s.Z,{id:"theme.NotFound.title",description:"The title of the 404 page",children:"Page Not Found"})}),(0,r.jsx)("p",{children:(0,r.jsx)(s.Z,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page",children:"We could not find what you were looking for."})}),(0,r.jsx)("p",{children:(0,r.jsx)(s.Z,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page",children:"Please contact the owner of the site that linked you to the original URL and let them know their link is broken."})})]})})})}},1772:(e,t,i)=>{i.r(t),i.d(t,{default:()=>l});i(7294);var n=i(5999),s=i(833),o=i(7372),r=i(5658),a=i(5893);function l(){const e=(0,n.I)({id:"theme.NotFound.title",message:"Page Not Found"});return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(s.d,{title:e}),(0,a.jsx)(o.Z,{children:(0,a.jsx)(r.Z,{})})]})}}}]);
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[1772],{5658:(e,t,i)=>{i.d(t,{Z:()=>a});i(7294);var n=i(6905),s=i(5999),o=i(2503),r=i(5893);function a(e){let{className:t}=e;return(0,r.jsx)("main",{className:(0,n.Z)("container margin-vert--xl",t),children:(0,r.jsx)("div",{className:"row",children:(0,r.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,r.jsx)(o.Z,{as:"h1",className:"hero__title",children:(0,r.jsx)(s.Z,{id:"theme.NotFound.title",description:"The title of the 404 page",children:"Page Not Found"})}),(0,r.jsx)("p",{children:(0,r.jsx)(s.Z,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page",children:"We could not find what you were looking for."})}),(0,r.jsx)("p",{children:(0,r.jsx)(s.Z,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page",children:"Please contact the owner of the site that linked you to the original URL and let them know their link is broken."})})]})})})}},1772:(e,t,i)=>{i.r(t),i.d(t,{default:()=>l});i(7294);var n=i(5999),s=i(833),o=i(3211),r=i(5658),a=i(5893);function l(){const e=(0,n.I)({id:"theme.NotFound.title",message:"Page Not Found"});return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(s.d,{title:e}),(0,a.jsx)(o.Z,{children:(0,a.jsx)(r.Z,{})})]})}}}]);

assets/js/17896441.669126b4.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[7918],{4073:(t,e,a)=>{a.d(e,{Z:()=>m});a(7294);var r=a(1263),s=a(6010),c=a(5893);const l=t=>{let{className:e,style:a,children:r,shadow:l}=t;const n=l?`item shadow--${l}`:"";return(0,c.jsx)("div",{className:(0,s.Z)("card",e,n),style:a,children:r})},n=t=>{let{className:e,style:a,children:r,textAlign:l,variant:n,italic:i=!1,noDecoration:o=!1,transform:d,breakWord:x=!1,truncate:m=!1,weight:h}=t;const u=l?`text--${l}`:"",y=n?`text--${n}`:"",N=i?"text--italic":"",$=o?"text-no-decoration":"",v=d?`text--${d}`:"",b=x?"text--break":"",g=m?"text--truncate":"",k=h?`text--${h}`:"";return(0,c.jsx)("div",{className:(0,s.Z)("card__body",e,u,v,y,N,$,b,g,k),style:a,children:r})},i=t=>{let{className:e,style:a,children:r,textAlign:l,variant:n,italic:i=!1,noDecoration:o=!1,transform:d,breakWord:x=!1,truncate:m=!1,weight:h}=t;const u=l?`text--${l}`:"",y=n?`text--${n}`:"",N=i?"text--italic":"",$=o?"text-no-decoration":"",v=d?`text--${d}`:"",b=x?"text--break":"",g=m?"text--truncate":"",k=h?`text--${h}`:"";return(0,c.jsx)("div",{className:(0,s.Z)("card__footer",e,u,v,y,N,$,b,g,k),style:a,children:r})},o=t=>{let{className:e,style:a,children:r,textAlign:l,variant:n,italic:i=!1,noDecoration:o=!1,transform:d,breakWord:x=!1,truncate:m=!1,weight:h}=t;const u=l?`text--${l}`:"",y=n?`text--${n}`:"",N=i?"text--italic":"",$=o?"text-no-decoration":"",v=d?`text--${d}`:"",b=x?"text--break":"",g=m?"text--truncate":"",k=h?`text--${h}`:"";return(0,c.jsx)("div",{className:(0,s.Z)("card__header",e,u,v,y,N,$,b,g,k),style:a,children:r})};var d=a(4996);const x=t=>{let{className:e,style:a,cardImageUrl:r,alt:l,title:n}=t;const i=(0,d.ZP)(r);return(0,c.jsx)("img",{className:(0,s.Z)("card__image",e),style:a,src:i,alt:l,title:n})};const m={...r.Z,Card:l,CardHeader:o,CardBody:n,CardFooter:i,CardImage:x,Columns:function(t){let{children:e,className:a,style:r}=t;return(0,c.jsx)("div",{className:"container center",children:(0,c.jsx)("div",{className:(0,s.Z)("row",a),style:r,children:e})})},Column:function(t){let{children:e,className:a,style:r}=t;return(0,c.jsx)("div",{className:(0,s.Z)("col",a),style:r,children:e})}}}}]);

assets/js/1a4e3797.3ac16762.js.LICENSE.txt

@@ -0,0 +1 @@
+/*! algoliasearch-lite.umd.js | 4.24.0 | © Algolia, inc. | https://github.com/algolia/algoliasearch-client-javascript */

assets/js/1a4e3797.56015c27.js.LICENSE.txt

@@ -1 +0,0 @@
-/*! algoliasearch-lite.umd.js | 4.23.3 | © Algolia, inc. | https://github.com/algolia/algoliasearch-client-javascript */

assets/js/20595907.67ccb14e.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[3927],{78:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>r,metadata:()=>a,toc:()=>l});var s=n(5893),i=n(1151);const r={title:"Self-host a zrok Instance in Kubernetes",sidebar_label:"Kubernetes",sidebar_position:55},o=void 0,a={id:"guides/self-hosting/kubernetes",title:"Self-host a zrok Instance in Kubernetes",description:"The Helm chart for zrok is available from the main OpenZiti charts repo.",source:"@site/../docs/guides/self-hosting/kubernetes.mdx",sourceDirName:"guides/self-hosting",slug:"/guides/self-hosting/kubernetes",permalink:"/docs/guides/self-hosting/kubernetes",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/guides/self-hosting/kubernetes.mdx",tags:[],version:"current",sidebarPosition:55,frontMatter:{title:"Self-host a zrok Instance in Kubernetes",sidebar_label:"Kubernetes",sidebar_position:55},sidebar:"tutorialSidebar",previous:{title:"Docker",permalink:"/docs/guides/self-hosting/docker"},next:{title:"Metrics and Limits",permalink:"/docs/category/metrics-and-limits"}},c={},l=[];function u(e){const t={a:"a",p:"p",...(0,i.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.p,{children:"The Helm chart for zrok is available from the main OpenZiti charts repo."}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"https://github.com/openziti/helm-charts/tree/main/charts/zrok#readme",children:"Link to README in GitHub"})})]})}function d(e={}){const{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(u,{...e})}):u(e)}},1151:(e,t,n)=>{n.d(t,{Z:()=>a,a:()=>o});var s=n(7294);const i={},r=s.createContext(i);function o(e){const t=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]);

assets/js/2c440c24.b75e9cbb.js

@@ -1 +1 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[6062],{3922:e=>{e.exports=JSON.parse('{"categoryGeneratedIndex":{"title":"Self Hosting","slug":"/category/self-hosting","permalink":"/docs/category/self-hosting","sidebar":"tutorialSidebar","navigation":{"previous":{"title":"Private Share","permalink":"/docs/guides/docker-share/docker_private_share_guide"},"next":{"title":"Linux","permalink":"/docs/guides/self-hosting/linux/"}}}}')}}]);
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[1975],{3533:e=>{e.exports=JSON.parse('{"categoryGeneratedIndex":{"title":"Self Hosting","slug":"/category/self-hosting","permalink":"/docs/category/self-hosting","sidebar":"tutorialSidebar","navigation":{"previous":{"title":"Private Share","permalink":"/docs/guides/docker-share/docker_private_share_guide"},"next":{"title":"Linux","permalink":"/docs/guides/self-hosting/linux/"}}}}')}}]);

assets/js/4483.af172fd7.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[4483],{4483:(e,s,a)=>{a.r(s),a.d(s,{DocSearchModal:()=>c.He});var c=a(4443)}}]);

assets/js/4cb7be2f.a36a515f.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[4654],{6616:e=>{e.exports=JSON.parse('{"categoryGeneratedIndex":{"title":"Metrics and Limits","slug":"/category/metrics-and-limits","permalink":"/docs/category/metrics-and-limits","sidebar":"tutorialSidebar","navigation":{"previous":{"title":"Kubernetes","permalink":"/docs/guides/self-hosting/kubernetes"},"next":{"title":"Configuring Metrics","permalink":"/docs/guides/self-hosting/metrics-and-limits/configuring-metrics"}}}}')}}]);

assets/js/50ef9c44.2dae98fd.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[8198],{919:(e,o,s)=>{s.r(o),s.d(o,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var n=s(5893),t=s(1151);const i={sidebar_position:200},r="Hosting",c={id:"concepts/hosting",title:"Hosting",description:"Self-Hosted",source:"@site/../docs/concepts/hosting.md",sourceDirName:"concepts",slug:"/concepts/hosting",permalink:"/docs/concepts/hosting",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/concepts/hosting.md",tags:[],version:"current",sidebarPosition:200,frontMatter:{sidebar_position:200},sidebar:"tutorialSidebar",previous:{title:"Open Source",permalink:"/docs/concepts/opensource"},next:{title:"Guides",permalink:"/docs/category/guides"}},d={},a=[{value:"Self-Hosted",id:"self-hosted",level:2},{value:"Managed Service",id:"managed-service",level:2}];function l(e){const o={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",...(0,t.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.header,{children:(0,n.jsx)(o.h1,{id:"hosting",children:"Hosting"})}),"\n",(0,n.jsx)(o.h2,{id:"self-hosted",children:"Self-Hosted"}),"\n",(0,n.jsxs)(o.p,{children:[(0,n.jsx)(o.code,{children:"zrok"})," is not limited to a managed offering. You can ",(0,n.jsx)(o.a,{href:"/docs/guides/self-hosting/linux/",children:"host your own"})," instance of ",(0,n.jsx)(o.code,{children:"zrok"})," as well. ",(0,n.jsx)(o.code,{children:"zrok"})," is\nalso freely available as open source software hosted by GitHub under a very permissive Apache v2 license."]}),"\n",(0,n.jsx)(o.h2,{id:"managed-service",children:"Managed Service"}),"\n",(0,n.jsxs)(o.p,{children:[(0,n.jsx)(o.code,{children:"zrok"})," is also offered as a cloud service, making it instantly accessible to a large population immediately.\nNetFoundry provides a manged version of ",(0,n.jsx)(o.code,{children:"zrok"})," at ",(0,n.jsx)(o.a,{href:"https://zrok.io",children:"https://zrok.io"}),". This provides the easy-to-use,\nquick to demonstrate features of ",(0,n.jsx)(o.code,{children:"zrok"})," without needing to deploy and host ",(0,n.jsx)(o.code,{children:"zrok"})," yourself."]})]})}function h(e={}){const{wrapper:o}={...(0,t.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},1151:(e,o,s)=>{s.d(o,{Z:()=>c,a:()=>r});var n=s(7294);const t={},i=n.createContext(t);function r(e){const o=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function c(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:r(e.components),n.createElement(i.Provider,{value:o},e.children)}}}]);

assets/js/50ef9c44.5df32fc9.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[8198],{8413:(e,o,s)=>{s.r(o),s.d(o,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>a});var t=s(5893),n=s(1151);const i={sidebar_position:200},r="Hosting",c={id:"concepts/hosting",title:"Hosting",description:"Self-Hosted",source:"@site/../docs/concepts/hosting.md",sourceDirName:"concepts",slug:"/concepts/hosting",permalink:"/docs/concepts/hosting",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/concepts/hosting.md",tags:[],version:"current",sidebarPosition:200,frontMatter:{sidebar_position:200},sidebar:"tutorialSidebar",previous:{title:"Open Source",permalink:"/docs/concepts/opensource"},next:{title:"Guides",permalink:"/docs/category/guides"}},d={},a=[{value:"Self-Hosted",id:"self-hosted",level:2},{value:"Managed Service",id:"managed-service",level:2}];function l(e){const o={a:"a",code:"code",h1:"h1",h2:"h2",p:"p",...(0,n.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(o.h1,{id:"hosting",children:"Hosting"}),"\n",(0,t.jsx)(o.h2,{id:"self-hosted",children:"Self-Hosted"}),"\n",(0,t.jsxs)(o.p,{children:[(0,t.jsx)(o.code,{children:"zrok"})," is not limited to a managed offering. You can ",(0,t.jsx)(o.a,{href:"/docs/guides/self-hosting/linux/",children:"host your own"})," instance of ",(0,t.jsx)(o.code,{children:"zrok"})," as well. ",(0,t.jsx)(o.code,{children:"zrok"})," is\nalso freely available as open source software hosted by GitHub under a very permissive Apache v2 license."]}),"\n",(0,t.jsx)(o.h2,{id:"managed-service",children:"Managed Service"}),"\n",(0,t.jsxs)(o.p,{children:[(0,t.jsx)(o.code,{children:"zrok"})," is also offered as a cloud service, making it instantly accessible to a large population immediately.\nNetFoundry provides a manged version of ",(0,t.jsx)(o.code,{children:"zrok"})," at ",(0,t.jsx)(o.a,{href:"https://zrok.io",children:"https://zrok.io"}),". This provides the easy-to-use,\nquick to demonstrate features of ",(0,t.jsx)(o.code,{children:"zrok"})," without needing to deploy and host ",(0,t.jsx)(o.code,{children:"zrok"})," yourself."]})]})}function h(e={}){const{wrapper:o}={...(0,n.a)(),...e.components};return o?(0,t.jsx)(o,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},1151:(e,o,s)=>{s.d(o,{Z:()=>c,a:()=>r});var t=s(7294);const n={},i=t.createContext(n);function r(e){const o=t.useContext(i);return t.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function c(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:r(e.components),t.createElement(i.Provider,{value:o},e.children)}}}]);

assets/js/5cd0a723.3e34c4c7.js

@@ -1 +1 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[8993],{2121:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var o=t(5893),s=t(1151);const i={title:"Use Another zrok Instance",sidebar_label:"Instance Config"},r=void 0,c={id:"guides/self-hosting/instance-configuration",title:"Use Another zrok Instance",description:"This guide is relevant if you are self-hosting or using a friend's zrok instance instead of using zrok-as-a-service from zrok.io.",source:"@site/../docs/guides/self-hosting/instance-configuration.mdx",sourceDirName:"guides/self-hosting",slug:"/guides/self-hosting/instance-configuration",permalink:"/docs/guides/self-hosting/instance-configuration",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/guides/self-hosting/instance-configuration.mdx",tags:[],version:"current",frontMatter:{title:"Use Another zrok Instance",sidebar_label:"Instance Config"},sidebar:"tutorialSidebar",previous:{title:"OAuth Public Frontend Configuration",permalink:"/docs/guides/self-hosting/oauth/configuring-oauth"},next:{title:"The Drives CLI",permalink:"/docs/guides/drives/cli"}},a={},d=[];function l(e){const n={admonition:"admonition",code:"code",em:"em",p:"p",pre:"pre",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.admonition,{type:"note",children:(0,o.jsxs)(n.p,{children:["This guide is relevant if you are self-hosting or using a friend's ",(0,o.jsx)(n.code,{children:"zrok"})," instance instead of using zrok-as-a-service from ",(0,o.jsx)(n.code,{children:"zrok.io"}),"."]})}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.code,{children:"zrok"})," ",(0,o.jsx)(n.em,{children:"command"})," on your computer uses a ",(0,o.jsx)(n.code,{children:"zrok"})," ",(0,o.jsx)(n.em,{children:"instance"})," over the network."]}),"\n",(0,o.jsxs)(n.p,{children:["The default instance API endpoint for the ",(0,o.jsx)(n.code,{children:"zrok"})," command is ",(0,o.jsx)(n.code,{children:"api.zrok.io"}),". Set the API endpoint to another instance's API endpoint:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"zrok config set apiEndpoint https://zrok.example.com\n"})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-buttonless",metastring:'title="Output"',children:"[WARNING]: unable to open environment metadata; ignoring\n\nzrok configuration updated\n"})}),"\n",(0,o.jsx)(n.admonition,{type:"note",children:(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.code,{children:"WARNING"})," about ",(0,o.jsx)(n.code,{children:"environment metadata"})," is expected when you run ",(0,o.jsx)(n.code,{children:"zrok config set"})," before ",(0,o.jsx)(n.code,{children:"zrok enable"}),"."]})}),"\n",(0,o.jsxs)(n.p,{children:["You can use the ",(0,o.jsx)(n.code,{children:"zrok status"})," command to inspect the state of your local ",(0,o.jsx)(n.em,{children:"environment"}),". ",(0,o.jsx)(n.code,{children:"zrok"})," refers to each shell where you install and ",(0,o.jsx)(n.code,{children:"enable"})," a copy of ",(0,o.jsx)(n.code,{children:"zrok"})," as an ",(0,o.jsx)(n.em,{children:"environment"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"zrok status\n"})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-buttonless",metastring:'title="Output"',children:"Config:\n\n CONFIG       VALUE                      SOURCE \n apiEndpoint  https://zrok.mydomain.com  config \n\n[WARNING]: Unable to load your local environment!\n\nTo create a local environment use the zrok enable command.\n"})}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.code,{children:"zrok status"})," command shows the configured API service that your environment is using, as well as the ",(0,o.jsx)(n.code,{children:"SOURCE"})," where the setting was retrieved. In this case, ",(0,o.jsx)(n.code,{children:"config"})," means that the setting was set into the environment using the ",(0,o.jsx)(n.code,{children:"zrok config"})," command."]})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},1151:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var o=t(7294);const s={},i=o.createContext(s);function r(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]);
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[8993],{5542:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var o=t(5893),s=t(1151);const i={title:"Use Another zrok Instance",sidebar_label:"Instance Config"},r=void 0,c={id:"guides/self-hosting/instance-configuration",title:"Use Another zrok Instance",description:"This guide is relevant if you are self-hosting or using a friend's zrok instance instead of using zrok-as-a-service from zrok.io.",source:"@site/../docs/guides/self-hosting/instance-configuration.mdx",sourceDirName:"guides/self-hosting",slug:"/guides/self-hosting/instance-configuration",permalink:"/docs/guides/self-hosting/instance-configuration",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/guides/self-hosting/instance-configuration.mdx",tags:[],version:"current",frontMatter:{title:"Use Another zrok Instance",sidebar_label:"Instance Config"},sidebar:"tutorialSidebar",previous:{title:"OAuth Public Frontend Configuration",permalink:"/docs/guides/self-hosting/oauth/configuring-oauth"},next:{title:"The Drives CLI",permalink:"/docs/guides/drives/cli"}},a={},d=[];function l(e){const n={admonition:"admonition",code:"code",em:"em",p:"p",pre:"pre",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.admonition,{type:"note",children:(0,o.jsxs)(n.p,{children:["This guide is relevant if you are self-hosting or using a friend's ",(0,o.jsx)(n.code,{children:"zrok"})," instance instead of using zrok-as-a-service from ",(0,o.jsx)(n.code,{children:"zrok.io"}),"."]})}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.code,{children:"zrok"})," ",(0,o.jsx)(n.em,{children:"command"})," on your computer uses a ",(0,o.jsx)(n.code,{children:"zrok"})," ",(0,o.jsx)(n.em,{children:"instance"})," over the network."]}),"\n",(0,o.jsxs)(n.p,{children:["The default instance API endpoint for the ",(0,o.jsx)(n.code,{children:"zrok"})," command is ",(0,o.jsx)(n.code,{children:"api.zrok.io"}),". Set the API endpoint to another instance's API endpoint:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"zrok config set apiEndpoint https://zrok.example.com\n"})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-buttonless",metastring:'title="Output"',children:"[WARNING]: unable to open environment metadata; ignoring\n\nzrok configuration updated\n"})}),"\n",(0,o.jsx)(n.admonition,{type:"note",children:(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.code,{children:"WARNING"})," about ",(0,o.jsx)(n.code,{children:"environment metadata"})," is expected when you run ",(0,o.jsx)(n.code,{children:"zrok config set"})," before ",(0,o.jsx)(n.code,{children:"zrok enable"}),"."]})}),"\n",(0,o.jsxs)(n.p,{children:["You can use the ",(0,o.jsx)(n.code,{children:"zrok status"})," command to inspect the state of your local ",(0,o.jsx)(n.em,{children:"environment"}),". ",(0,o.jsx)(n.code,{children:"zrok"})," refers to each shell where you install and ",(0,o.jsx)(n.code,{children:"enable"})," a copy of ",(0,o.jsx)(n.code,{children:"zrok"})," as an ",(0,o.jsx)(n.em,{children:"environment"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-text",children:"zrok status\n"})}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-buttonless",metastring:'title="Output"',children:"Config:\n\n CONFIG       VALUE                      SOURCE \n apiEndpoint  https://zrok.mydomain.com  config \n\n[WARNING]: Unable to load your local environment!\n\nTo create a local environment use the zrok enable command.\n"})}),"\n",(0,o.jsxs)(n.p,{children:["The ",(0,o.jsx)(n.code,{children:"zrok status"})," command shows the configured API service that your environment is using, as well as the ",(0,o.jsx)(n.code,{children:"SOURCE"})," where the setting was retrieved. In this case, ",(0,o.jsx)(n.code,{children:"config"})," means that the setting was set into the environment using the ",(0,o.jsx)(n.code,{children:"zrok config"})," command."]})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},1151:(e,n,t)=>{t.d(n,{Z:()=>c,a:()=>r});var o=t(7294);const s={},i=o.createContext(s);function r(e){const n=o.useContext(i);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),o.createElement(i.Provider,{value:n},e.children)}}}]);

assets/js/5e95c892.4db699c3.js

@@ -1 +1 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[9661],{1892:(e,s,r)=>{r.r(s),r.d(s,{default:()=>l});r(7294);var t=r(6905),u=r(833),a=r(5281),c=r(8790),n=r(7372),i=r(5893);function l(e){return(0,i.jsx)(u.FG,{className:(0,t.Z)(a.k.wrapper.docsPages),children:(0,i.jsx)(n.Z,{children:(0,c.H)(e.route.routes)})})}}}]);
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[9661],{1892:(e,s,r)=>{r.r(s),r.d(s,{default:()=>l});r(7294);var t=r(6905),u=r(833),a=r(5281),c=r(8790),n=r(3211),i=r(5893);function l(e){return(0,i.jsx)(u.FG,{className:(0,t.Z)(a.k.wrapper.docsPages),children:(0,i.jsx)(n.Z,{children:(0,c.H)(e.route.routes)})})}}}]);

assets/js/6272ba0e.35172d6c.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[7176],{7806:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>d,contentTitle:()=>i,default:()=>l,frontMatter:()=>t,metadata:()=>a,toc:()=>c});var n=s(5893),o=s(1151);const t={sidebar_position:10},i="Reserved Shares",a={id:"concepts/sharing-reserved",title:"Reserved Shares",description:"By default a public or private share is assigned a share token when you create a share using the zrok share command. The zrok share command is the bridge between your local environment and the users you are sharing with. When you terminate the zrok share, the bridge is eliminated and the share token is deleted. If you run zrok share again, you will be allocated a brand new share token.",source:"@site/../docs/concepts/sharing-reserved.md",sourceDirName:"concepts",slug:"/concepts/sharing-reserved",permalink:"/docs/concepts/sharing-reserved",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/concepts/sharing-reserved.md",tags:[],version:"current",sidebarPosition:10,frontMatter:{sidebar_position:10},sidebar:"tutorialSidebar",previous:{title:"Public Shares",permalink:"/docs/concepts/sharing-public"},next:{title:"Sharing HTTP Servers",permalink:"/docs/concepts/http"}},d={},c=[];function h(e){const r={code:"code",em:"em",h1:"h1",p:"p",...(0,o.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.h1,{id:"reserved-shares",children:"Reserved Shares"}),"\n",(0,n.jsxs)(r.p,{children:["By default a ",(0,n.jsx)(r.code,{children:"public"})," or ",(0,n.jsx)(r.code,{children:"private"})," share is assigned a ",(0,n.jsx)(r.em,{children:"share token"})," when you create a share using the ",(0,n.jsx)(r.code,{children:"zrok share"})," command. The ",(0,n.jsx)(r.code,{children:"zrok share"})," command is the bridge between your local environment and the users you are sharing with. When you terminate the ",(0,n.jsx)(r.code,{children:"zrok share"}),", the bridge is eliminated and the ",(0,n.jsx)(r.em,{children:"share token"})," is deleted. If you run ",(0,n.jsx)(r.code,{children:"zrok share"})," again, you will be allocated a brand new ",(0,n.jsx)(r.em,{children:"share token"}),"."]}),"\n",(0,n.jsxs)(r.p,{children:["You can use a ",(0,n.jsx)(r.code,{children:"reserved"})," share to persist your ",(0,n.jsx)(r.em,{children:"share token"})," across multiple runs of the ",(0,n.jsx)(r.code,{children:"zrok share"})," bridge. When you use a ",(0,n.jsx)(r.code,{children:"reserved"})," share, the share token will not be deleted between multiple runs of ",(0,n.jsx)(r.code,{children:"zrok share"}),"."]}),"\n",(0,n.jsxs)(r.p,{children:["To use a ",(0,n.jsx)(r.code,{children:"reserved"})," share, you will first run the ",(0,n.jsx)(r.code,{children:"zrok reserve"})," command to create the reserved share (see ",(0,n.jsx)(r.code,{children:"zrok reserve --help"})," for details). Once you've created your ",(0,n.jsx)(r.code,{children:"reserved"})," share, you will use the ",(0,n.jsx)(r.code,{children:"zrok share reserved"})," command (see ",(0,n.jsx)(r.code,{children:"--help"})," for details) to run the bridge for the shared resource."]}),"\n",(0,n.jsxs)(r.p,{children:["This pattern works for both ",(0,n.jsx)(r.code,{children:"public"})," and ",(0,n.jsx)(r.code,{children:"private"})," shares, and for all resource types supported by ",(0,n.jsx)(r.code,{children:"zrok"}),"."]}),"\n",(0,n.jsxs)(r.p,{children:["To delete your ",(0,n.jsx)(r.code,{children:"reserved"})," share use the ",(0,n.jsx)(r.code,{children:"zrok release"})," command or click the delete button in the share's ",(0,n.jsx)(r.em,{children:"Actions"})," tab in the web console."]})]})}function l(e={}){const{wrapper:r}={...(0,o.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},1151:(e,r,s)=>{s.d(r,{Z:()=>a,a:()=>i});var n=s(7294);const o={},t=n.createContext(o);function i(e){const r=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),n.createElement(t.Provider,{value:r},e.children)}}}]);

assets/js/6272ba0e.b4fcb5f7.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[7176],{516:(e,r,s)=>{s.r(r),s.d(r,{assets:()=>i,contentTitle:()=>d,default:()=>l,frontMatter:()=>t,metadata:()=>a,toc:()=>c});var n=s(5893),o=s(1151);const t={sidebar_position:10},d="Reserved Shares",a={id:"concepts/sharing-reserved",title:"Reserved Shares",description:"By default a public or private share is assigned a share token when you create a share using the zrok share command. The zrok share command is the bridge between your local environment and the users you are sharing with. When you terminate the zrok share, the bridge is eliminated and the share token is deleted. If you run zrok share again, you will be allocated a brand new share token.",source:"@site/../docs/concepts/sharing-reserved.md",sourceDirName:"concepts",slug:"/concepts/sharing-reserved",permalink:"/docs/concepts/sharing-reserved",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/concepts/sharing-reserved.md",tags:[],version:"current",sidebarPosition:10,frontMatter:{sidebar_position:10},sidebar:"tutorialSidebar",previous:{title:"Public Shares",permalink:"/docs/concepts/sharing-public"},next:{title:"Sharing HTTP Servers",permalink:"/docs/concepts/http"}},i={},c=[];function h(e){const r={code:"code",em:"em",h1:"h1",header:"header",p:"p",...(0,o.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"reserved-shares",children:"Reserved Shares"})}),"\n",(0,n.jsxs)(r.p,{children:["By default a ",(0,n.jsx)(r.code,{children:"public"})," or ",(0,n.jsx)(r.code,{children:"private"})," share is assigned a ",(0,n.jsx)(r.em,{children:"share token"})," when you create a share using the ",(0,n.jsx)(r.code,{children:"zrok share"})," command. The ",(0,n.jsx)(r.code,{children:"zrok share"})," command is the bridge between your local environment and the users you are sharing with. When you terminate the ",(0,n.jsx)(r.code,{children:"zrok share"}),", the bridge is eliminated and the ",(0,n.jsx)(r.em,{children:"share token"})," is deleted. If you run ",(0,n.jsx)(r.code,{children:"zrok share"})," again, you will be allocated a brand new ",(0,n.jsx)(r.em,{children:"share token"}),"."]}),"\n",(0,n.jsxs)(r.p,{children:["You can use a ",(0,n.jsx)(r.code,{children:"reserved"})," share to persist your ",(0,n.jsx)(r.em,{children:"share token"})," across multiple runs of the ",(0,n.jsx)(r.code,{children:"zrok share"})," bridge. When you use a ",(0,n.jsx)(r.code,{children:"reserved"})," share, the share token will not be deleted between multiple runs of ",(0,n.jsx)(r.code,{children:"zrok share"}),"."]}),"\n",(0,n.jsxs)(r.p,{children:["To use a ",(0,n.jsx)(r.code,{children:"reserved"})," share, you will first run the ",(0,n.jsx)(r.code,{children:"zrok reserve"})," command to create the reserved share (see ",(0,n.jsx)(r.code,{children:"zrok reserve --help"})," for details). Once you've created your ",(0,n.jsx)(r.code,{children:"reserved"})," share, you will use the ",(0,n.jsx)(r.code,{children:"zrok share reserved"})," command (see ",(0,n.jsx)(r.code,{children:"--help"})," for details) to run the bridge for the shared resource."]}),"\n",(0,n.jsxs)(r.p,{children:["This pattern works for both ",(0,n.jsx)(r.code,{children:"public"})," and ",(0,n.jsx)(r.code,{children:"private"})," shares, and for all resource types supported by ",(0,n.jsx)(r.code,{children:"zrok"}),"."]}),"\n",(0,n.jsxs)(r.p,{children:["To delete your ",(0,n.jsx)(r.code,{children:"reserved"})," share use the ",(0,n.jsx)(r.code,{children:"zrok release"})," command or click the delete button in the share's ",(0,n.jsx)(r.em,{children:"Actions"})," tab in the web console."]})]})}function l(e={}){const{wrapper:r}={...(0,o.a)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},1151:(e,r,s)=>{s.d(r,{Z:()=>a,a:()=>d});var n=s(7294);const o={},t=n.createContext(o);function d(e){const r=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function a(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:d(e.components),n.createElement(t.Provider,{value:r},e.children)}}}]);

assets/js/75b20590.3455a494.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[4838],{6162:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>i,metadata:()=>c,toc:()=>p});var n=t(5893),r=t(1151);const i={sidebar_position:100},s="Open Source",c={id:"concepts/opensource",title:"Open Source",description:"It's important to the zrok project that it remain free and open source software. The code is available on GitHub",source:"@site/../docs/concepts/opensource.md",sourceDirName:"concepts",slug:"/concepts/opensource",permalink:"/docs/concepts/opensource",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/concepts/opensource.md",tags:[],version:"current",sidebarPosition:100,frontMatter:{sidebar_position:100},sidebar:"tutorialSidebar",previous:{title:"Sharing Websites and Files",permalink:"/docs/concepts/files"},next:{title:"Hosting",permalink:"/docs/concepts/hosting"}},a={},p=[{value:"Built on OpenZiti",id:"built-on-openziti",level:2}];function d(e){const o={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.h1,{id:"open-source",children:"Open Source"}),"\n",(0,n.jsxs)(o.p,{children:["It's important to the ",(0,n.jsx)(o.code,{children:"zrok"})," project that it remain free and open source software. The code is available on ",(0,n.jsx)(o.a,{href:"https://github.com/openziti/zrok",children:"GitHub"}),"\nfor the world to use, inspect, and build upon!"]}),"\n",(0,n.jsxs)(o.p,{children:["Check out the repository over on GitHub at ",(0,n.jsx)(o.a,{href:"https://github.com/openziti/zrok",children:"https://github.com/openziti/zrok"}),".  If you find ",(0,n.jsx)(o.code,{children:"zrok"})," to be useful, and\nyou want to help spread the word of ",(0,n.jsx)(o.code,{children:"zrok"})," give the project a star. It really does help get the word out about the\nproject."]}),"\n",(0,n.jsxs)(o.p,{children:["The project also uses a very permissive license: Apache v2. We encourage people to fork the repo and use ",(0,n.jsx)(o.code,{children:"zrok"})," for your own purposes how you see fit or contribute back to the project."]}),"\n",(0,n.jsx)(o.h2,{id:"built-on-openziti",children:"Built on OpenZiti"}),"\n",(0,n.jsxs)(o.p,{children:["The power of ",(0,n.jsx)(o.code,{children:"zrok"})," really lies in ",(0,n.jsx)(o.code,{children:"private"})," sharing. It's increasingly clear that security needs to be a first-class\nmember of any organization. To enable ",(0,n.jsx)(o.code,{children:"private"})," sharing, ",(0,n.jsx)(o.code,{children:"zrok"})," was built on top of another excellent open source project named OpenZiti."]}),"\n",(0,n.jsxs)(o.p,{children:["OpenZiti is a secure overlay network focusing on bringing zero trust to applications. It is the ",(0,n.jsx)(o.strong,{children:"backbone"})," of ",(0,n.jsx)(o.code,{children:"zrok"}),".\nIn fact, ",(0,n.jsx)(o.code,{children:"zrok"})," proudly proclaims itself as an Ziti ",(0,n.jsx)(o.em,{children:"native"})," application."]}),"\n",(0,n.jsxs)(o.p,{children:["If you are interested in learning more about OpenZiti head over to ",(0,n.jsx)(o.a,{href:"https://docs.openziti.io/docs/learn/introduction/",children:"the docs"}),", try the quickstart, and don't forget to star that project too. We couldn't build ",(0,n.jsx)(o.code,{children:"zrok"})," without OpenZiti!"]})]})}function l(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},1151:(e,o,t)=>{t.d(o,{Z:()=>c,a:()=>s});var n=t(7294);const r={},i=n.createContext(r);function s(e){const o=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function c(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),n.createElement(i.Provider,{value:o},e.children)}}}]);

assets/js/75b20590.636296cd.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[4838],{6943:(e,o,t)=>{t.r(o),t.d(o,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var n=t(5893),r=t(1151);const i={sidebar_position:100},s="Open Source",c={id:"concepts/opensource",title:"Open Source",description:"It's important to the zrok project that it remain free and open source software. The code is available on GitHub",source:"@site/../docs/concepts/opensource.md",sourceDirName:"concepts",slug:"/concepts/opensource",permalink:"/docs/concepts/opensource",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/concepts/opensource.md",tags:[],version:"current",sidebarPosition:100,frontMatter:{sidebar_position:100},sidebar:"tutorialSidebar",previous:{title:"Sharing Websites and Files",permalink:"/docs/concepts/files"},next:{title:"Hosting",permalink:"/docs/concepts/hosting"}},a={},d=[{value:"Built on OpenZiti",id:"built-on-openziti",level:2}];function p(e){const o={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",header:"header",p:"p",strong:"strong",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(o.header,{children:(0,n.jsx)(o.h1,{id:"open-source",children:"Open Source"})}),"\n",(0,n.jsxs)(o.p,{children:["It's important to the ",(0,n.jsx)(o.code,{children:"zrok"})," project that it remain free and open source software. The code is available on ",(0,n.jsx)(o.a,{href:"https://github.com/openziti/zrok",children:"GitHub"}),"\nfor the world to use, inspect, and build upon!"]}),"\n",(0,n.jsxs)(o.p,{children:["Check out the repository over on GitHub at ",(0,n.jsx)(o.a,{href:"https://github.com/openziti/zrok",children:"https://github.com/openziti/zrok"}),".  If you find ",(0,n.jsx)(o.code,{children:"zrok"})," to be useful, and\nyou want to help spread the word of ",(0,n.jsx)(o.code,{children:"zrok"})," give the project a star. It really does help get the word out about the\nproject."]}),"\n",(0,n.jsxs)(o.p,{children:["The project also uses a very permissive license: Apache v2. We encourage people to fork the repo and use ",(0,n.jsx)(o.code,{children:"zrok"})," for your own purposes how you see fit or contribute back to the project."]}),"\n",(0,n.jsx)(o.h2,{id:"built-on-openziti",children:"Built on OpenZiti"}),"\n",(0,n.jsxs)(o.p,{children:["The power of ",(0,n.jsx)(o.code,{children:"zrok"})," really lies in ",(0,n.jsx)(o.code,{children:"private"})," sharing. It's increasingly clear that security needs to be a first-class\nmember of any organization. To enable ",(0,n.jsx)(o.code,{children:"private"})," sharing, ",(0,n.jsx)(o.code,{children:"zrok"})," was built on top of another excellent open source project named OpenZiti."]}),"\n",(0,n.jsxs)(o.p,{children:["OpenZiti is a secure overlay network focusing on bringing zero trust to applications. It is the ",(0,n.jsx)(o.strong,{children:"backbone"})," of ",(0,n.jsx)(o.code,{children:"zrok"}),".\nIn fact, ",(0,n.jsx)(o.code,{children:"zrok"})," proudly proclaims itself as an Ziti ",(0,n.jsx)(o.em,{children:"native"})," application."]}),"\n",(0,n.jsxs)(o.p,{children:["If you are interested in learning more about OpenZiti head over to ",(0,n.jsx)(o.a,{href:"https://docs.openziti.io/docs/learn/introduction/",children:"the docs"}),", try the quickstart, and don't forget to star that project too. We couldn't build ",(0,n.jsx)(o.code,{children:"zrok"})," without OpenZiti!"]})]})}function l(e={}){const{wrapper:o}={...(0,r.a)(),...e.components};return o?(0,n.jsx)(o,{...e,children:(0,n.jsx)(p,{...e})}):p(e)}},1151:(e,o,t)=>{t.d(o,{Z:()=>c,a:()=>s});var n=t(7294);const r={},i=n.createContext(r);function s(e){const o=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(o):{...o,...e}}),[o,e])}function c(e){let o;return o=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:s(e.components),n.createElement(i.Provider,{value:o},e.children)}}}]);

assets/js/9af26a4e.9abe8e9c.js

@@ -1 +1 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[2914],{3719:e=>{e.exports=JSON.parse('{"categoryGeneratedIndex":{"title":"Guides","slug":"/category/guides","permalink":"/docs/category/guides","sidebar":"tutorialSidebar","navigation":{"previous":{"title":"Hosting","permalink":"/docs/concepts/hosting"},"next":{"title":"Install","permalink":"/docs/guides/install/"}}}}')}}]);
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[1999],{8055:e=>{e.exports=JSON.parse('{"categoryGeneratedIndex":{"title":"Guides","slug":"/category/guides","permalink":"/docs/category/guides","sidebar":"tutorialSidebar","navigation":{"previous":{"title":"Hosting","permalink":"/docs/concepts/hosting"},"next":{"title":"Install","permalink":"/docs/guides/install/"}}}}')}}]);

assets/js/a7bd4aaa.45274bc2.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[8518],{8564:(e,n,s)=>{s.r(n),s.d(n,{default:()=>d});s(7294);var r=s(833),o=s(3320),t=s(4477),i=s(8790),c=s(197),u=s(5893);function a(e){const{version:n}=e;return(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(c.Z,{version:n.version,tag:(0,o.os)(n.pluginId,n.version)}),(0,u.jsx)(r.d,{children:n.noIndex&&(0,u.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})]})}function l(e){const{version:n,route:s}=e;return(0,u.jsx)(r.FG,{className:n.className,children:(0,u.jsx)(t.q,{version:n,children:(0,i.H)(s.routes)})})}function d(e){return(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(a,{...e}),(0,u.jsx)(l,{...e})]})}}}]);

assets/js/a7bd4aaa.60d96043.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[8518],{8564:(e,n,s)=>{s.r(n),s.d(n,{default:()=>d});s(7294);var r=s(833),t=s(4165),o=s(3797),i=s(8790),c=s(197),u=s(5893);function a(e){const{version:n}=e;return(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(c.Z,{version:n.version,tag:(0,t.J)(n.pluginId,n.version)}),(0,u.jsx)(r.d,{children:n.noIndex&&(0,u.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})]})}function l(e){const{version:n,route:s}=e;return(0,u.jsx)(r.FG,{className:n.className,children:(0,u.jsx)(o.q,{version:n,children:(0,i.H)(s.routes)})})}function d(e){return(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(a,{...e}),(0,u.jsx)(l,{...e})]})}}}]);

assets/js/b186d866.64871ffa.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[960],{8100:i=>{i.exports=JSON.parse('{"categoryGeneratedIndex":{"title":"OAuth","slug":"/category/oauth","permalink":"/docs/category/oauth","sidebar":"tutorialSidebar","navigation":{"previous":{"title":"Configuring Limits","permalink":"/docs/guides/self-hosting/metrics-and-limits/configuring-limits"},"next":{"title":"OAuth Public Frontend Configuration","permalink":"/docs/guides/self-hosting/oauth/configuring-oauth"}}}}')}}]);

assets/js/b6569025.459556f5.js

@@ -1 +1 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[6913],{9243:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>u,contentTitle:()=>d,default:()=>x,frontMatter:()=>l,metadata:()=>c,toc:()=>m});var t=s(5893),o=s(1151),a=s(4908),i=s(3298),r=s(7597);const l={title:"Install"},d=void 0,c={id:"guides/install/index",title:"Install",description:"<DownloadCard",source:"@site/../docs/guides/install/index.mdx",sourceDirName:"guides/install",slug:"/guides/install/",permalink:"/docs/guides/install/",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/guides/install/index.mdx",tags:[],version:"current",frontMatter:{title:"Install"},sidebar:"tutorialSidebar",previous:{title:"Guides",permalink:"/docs/category/guides"},next:{title:"Linux",permalink:"/docs/guides/install/linux"}},u={},m=[];function g(e){return(0,t.jsx)(a.N,{children:(0,t.jsxs)("div",{className:r.Z.downloadContainer,children:[(0,t.jsx)(i.Z,{osName:"Windows",osLogo:"/img/logo-windows.svg",infoText:"Binary executable",guideLink:"/docs/guides/install/windows"}),(0,t.jsx)(i.Z,{osName:"macOS",osLogo:"/img/logo-apple.svg",infoText:"Binary executable",guideLink:"/docs/guides/install/macos"}),(0,t.jsx)(i.Z,{osName:"Linux",osLogo:"/img/logo-linux.svg",infoText:"DEB, RPM packages",guideLink:"/docs/guides/install/linux"})]})})}function x(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(g,{...e})}):g()}},4908:(e,n,s)=>{s.d(n,{L:()=>i,N:()=>r});var t=s(7294),o=s(5893);const a=(0,t.createContext)([]),i=()=>(0,t.useContext)(a),r=e=>{let{children:n}=e;const[s,i]=(0,t.useState)([]);return(0,t.useEffect)((()=>{(async()=>{try{const e=await fetch("https://api.github.com/repos/openziti/zrok/releases/latest");if(!e.ok)throw new Error(`HTTP error! status: ${e.status}`);const n=(await e.json()).assets.map((e=>({name:e.name,url:e.browser_download_url,arch:e.name.replace(".tar.gz","").split("_")[3]})));console.log("Fetched assets:",n),i(n)}catch(e){console.error("Error fetching the release assets:",e)}})()}),[]),(0,o.jsx)(a.Provider,{value:s,children:n})}},3298:(e,n,s)=>{s.d(n,{Z:()=>l});s(7294);var t=s(4908),o=s(7597),a=s(2949),i=s(5893);const r=e=>{switch(e){case"amd64":return"x86_64";case"arm64":return"ARM64";case"armv7":return"ARM";default:return e.toUpperCase()}},l=e=>{let{osName:n,osLogo:s,infoText:l,guideLink:d}=e;const{colorMode:c}=(0,a.I)(),u=(0,t.L)();console.log("Assets in DownloadCard:",u);const m=(e=>{switch(e){case"Windows":return"windows";case"macOS":return"darwin";case"Linux":return"linux";default:return""}})(n),g=u.filter((e=>e.name.includes(m)));return console.log("Filtered assets for",n,"in DownloadCard:",g),(0,i.jsxs)("div",{className:o.Z.downloadCard,children:[(0,i.jsx)("div",{className:o.Z.imgContainer,children:(0,i.jsx)("img",{src:s,alt:`${n} logo`})}),(0,i.jsx)("h3",{children:n}),g.length>0&&(0,i.jsx)("ul",{children:g.map(((e,n)=>(0,i.jsx)("li",{className:o.Z.downloadButtons,children:(0,i.jsx)("a",{href:e.url,className:o.Z.downloadLinks,children:r(e.arch)})},n)))}),d&&(0,i.jsxs)("div",{className:o.Z.cardFooter,children:[(0,i.jsx)("p",{children:l}),(0,i.jsx)("a",{href:d,children:"GUIDE"}),(0,i.jsx)("p",{})]})]})}},7597:(e,n,s)=>{s.d(n,{Z:()=>t});const t={downloadContainer:"downloadContainer_nNgj",downloadCard:"downloadCard_D_EY",cardFooter:"cardFooter_Rhom",downloadButtons:"downloadButtons_NPAP",downloadLinks:"downloadLinks_thSu",imgContainer:"imgContainer_r0QA"}},1151:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>i});var t=s(7294);const o={},a=t.createContext(o);function i(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]);
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[6913],{5721:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>u,contentTitle:()=>d,default:()=>x,frontMatter:()=>l,metadata:()=>c,toc:()=>m});var t=s(5893),o=s(1151),a=s(4908),i=s(3298),r=s(7597);const l={title:"Install"},d=void 0,c={id:"guides/install/index",title:"Install",description:"<DownloadCard",source:"@site/../docs/guides/install/index.mdx",sourceDirName:"guides/install",slug:"/guides/install/",permalink:"/docs/guides/install/",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/guides/install/index.mdx",tags:[],version:"current",frontMatter:{title:"Install"},sidebar:"tutorialSidebar",previous:{title:"Guides",permalink:"/docs/category/guides"},next:{title:"Linux",permalink:"/docs/guides/install/linux"}},u={},m=[];function g(e){return(0,t.jsx)(a.N,{children:(0,t.jsxs)("div",{className:r.Z.downloadContainer,children:[(0,t.jsx)(i.Z,{osName:"Windows",osLogo:"/img/logo-windows.svg",infoText:"Binary executable",guideLink:"/docs/guides/install/windows"}),(0,t.jsx)(i.Z,{osName:"macOS",osLogo:"/img/logo-apple.svg",infoText:"Binary executable",guideLink:"/docs/guides/install/macos"}),(0,t.jsx)(i.Z,{osName:"Linux",osLogo:"/img/logo-linux.svg",infoText:"DEB, RPM packages",guideLink:"/docs/guides/install/linux"})]})})}function x(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(g,{...e})}):g()}},4908:(e,n,s)=>{s.d(n,{L:()=>i,N:()=>r});var t=s(7294),o=s(5893);const a=(0,t.createContext)([]),i=()=>(0,t.useContext)(a),r=e=>{let{children:n}=e;const[s,i]=(0,t.useState)([]);return(0,t.useEffect)((()=>{(async()=>{try{const e=await fetch("https://api.github.com/repos/openziti/zrok/releases/latest");if(!e.ok)throw new Error(`HTTP error! status: ${e.status}`);const n=(await e.json()).assets.map((e=>({name:e.name,url:e.browser_download_url,arch:e.name.replace(".tar.gz","").split("_")[3]})));console.log("Fetched assets:",n),i(n)}catch(e){console.error("Error fetching the release assets:",e)}})()}),[]),(0,o.jsx)(a.Provider,{value:s,children:n})}},3298:(e,n,s)=>{s.d(n,{Z:()=>l});s(7294);var t=s(4908),o=s(7597),a=s(2949),i=s(5893);const r=e=>{switch(e){case"amd64":return"x86_64";case"arm64":return"ARM64";case"armv7":return"ARM";default:return e.toUpperCase()}},l=e=>{let{osName:n,osLogo:s,infoText:l,guideLink:d}=e;const{colorMode:c}=(0,a.I)(),u=(0,t.L)();console.log("Assets in DownloadCard:",u);const m=(e=>{switch(e){case"Windows":return"windows";case"macOS":return"darwin";case"Linux":return"linux";default:return""}})(n),g=u.filter((e=>e.name.includes(m)));return console.log("Filtered assets for",n,"in DownloadCard:",g),(0,i.jsxs)("div",{className:o.Z.downloadCard,children:[(0,i.jsx)("div",{className:o.Z.imgContainer,children:(0,i.jsx)("img",{src:s,alt:`${n} logo`})}),(0,i.jsx)("h3",{children:n}),g.length>0&&(0,i.jsx)("ul",{children:g.map(((e,n)=>(0,i.jsx)("li",{className:o.Z.downloadButtons,children:(0,i.jsx)("a",{href:e.url,className:o.Z.downloadLinks,children:r(e.arch)})},n)))}),d&&(0,i.jsxs)("div",{className:o.Z.cardFooter,children:[(0,i.jsx)("p",{children:l}),(0,i.jsx)("a",{href:d,children:"GUIDE"}),(0,i.jsx)("p",{})]})]})}},7597:(e,n,s)=>{s.d(n,{Z:()=>t});const t={downloadContainer:"downloadContainer_nNgj",downloadCard:"downloadCard_D_EY",cardFooter:"cardFooter_Rhom",downloadButtons:"downloadButtons_NPAP",downloadLinks:"downloadLinks_thSu",imgContainer:"imgContainer_r0QA"}},1151:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>i});var t=s(7294);const o={},a=t.createContext(o);function i(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]);

assets/js/bc747cac.01a42caa.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[8945],{3623:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>i,toc:()=>d});var s=t(5893),o=t(1151);const r={sidebar_title:"Core Features",sidebar_position:25},c="Concepts",i={id:"concepts/index",title:"Concepts",description:"zrok was designed to make sharing local resources both secure and easy. In this section of the zrok documentation, we'll tour through all of the most important features.",source:"@site/../docs/concepts/index.md",sourceDirName:"concepts",slug:"/concepts/",permalink:"/docs/concepts/",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/concepts/index.md",tags:[],version:"current",sidebarPosition:25,frontMatter:{sidebar_title:"Core Features",sidebar_position:25},sidebar:"tutorialSidebar",previous:{title:"Getting Started",permalink:"/docs/getting-started"},next:{title:"Private Shares",permalink:"/docs/concepts/sharing-private"}},a={},d=[];function l(e){const n={a:"a",code:"code",h1:"h1",header:"header",p:"p",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"concepts",children:"Concepts"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"zrok"})," was designed to make sharing local resources both secure and easy. In this section of the ",(0,s.jsx)(n.code,{children:"zrok"})," documentation, we'll tour through all of the most important features."]}),"\n",(0,s.jsxs)(n.p,{children:["Sharing with ",(0,s.jsx)(n.code,{children:"zrok"})," can be either ",(0,s.jsx)(n.a,{href:"/docs/concepts/sharing-public",children:(0,s.jsx)(n.code,{children:"public"})})," or ",(0,s.jsx)(n.a,{href:"/docs/concepts/sharing-private",children:(0,s.jsx)(n.code,{children:"private"})}),".\nNaturally, regular web-based resources can be shared but ",(0,s.jsx)(n.code,{children:"zrok"})," also includes support for sharing raw ",(0,s.jsx)(n.a,{href:"/docs/concepts/tunnels",children:"TCP"})," and ",(0,s.jsx)(n.a,{href:"/docs/concepts/tunnels",children:"UDP"})," network connections, and also includes a ",(0,s.jsx)(n.a,{href:"/docs/concepts/files",children:"website and file sharing"})," feature."]}),"\n",(0,s.jsxs)(n.p,{children:["Learn about ",(0,s.jsx)(n.code,{children:"zrok"})," ",(0,s.jsx)(n.a,{href:"/docs/concepts/hosting",children:"hosting here"}),", including instructions on how to ",(0,s.jsxs)(n.a,{href:"/docs/guides/self-hosting/linux/",children:["install your own ",(0,s.jsx)(n.code,{children:"zrok"})," instance"]}),"."]})]})}function h(e={}){const{wrapper:n}={...(0,o.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},1151:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>c});var s=t(7294);const o={},r=s.createContext(o);function c(e){const n=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(r.Provider,{value:n},e.children)}}}]);

assets/js/bc747cac.975267a6.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[8945],{3033:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>i,toc:()=>d});var s=n(5893),o=n(1151);const r={sidebar_title:"Core Features",sidebar_position:25},c="Concepts",i={id:"concepts/index",title:"Concepts",description:"zrok was designed to make sharing local resources both secure and easy. In this section of the zrok documentation, we'll tour through all of the most important features.",source:"@site/../docs/concepts/index.md",sourceDirName:"concepts",slug:"/concepts/",permalink:"/docs/concepts/",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/concepts/index.md",tags:[],version:"current",sidebarPosition:25,frontMatter:{sidebar_title:"Core Features",sidebar_position:25},sidebar:"tutorialSidebar",previous:{title:"Getting Started",permalink:"/docs/getting-started"},next:{title:"Private Shares",permalink:"/docs/concepts/sharing-private"}},a={},d=[];function l(e){const t={a:"a",code:"code",h1:"h1",p:"p",...(0,o.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.h1,{id:"concepts",children:"Concepts"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.code,{children:"zrok"})," was designed to make sharing local resources both secure and easy. In this section of the ",(0,s.jsx)(t.code,{children:"zrok"})," documentation, we'll tour through all of the most important features."]}),"\n",(0,s.jsxs)(t.p,{children:["Sharing with ",(0,s.jsx)(t.code,{children:"zrok"})," can be either ",(0,s.jsx)(t.a,{href:"/docs/concepts/sharing-public",children:(0,s.jsx)(t.code,{children:"public"})})," or ",(0,s.jsx)(t.a,{href:"/docs/concepts/sharing-private",children:(0,s.jsx)(t.code,{children:"private"})}),".\nNaturally, regular web-based resources can be shared but ",(0,s.jsx)(t.code,{children:"zrok"})," also includes support for sharing raw ",(0,s.jsx)(t.a,{href:"/docs/concepts/tunnels",children:"TCP"})," and ",(0,s.jsx)(t.a,{href:"/docs/concepts/tunnels",children:"UDP"})," network connections, and also includes a ",(0,s.jsx)(t.a,{href:"/docs/concepts/files",children:"website and file sharing"})," feature."]}),"\n",(0,s.jsxs)(t.p,{children:["Learn about ",(0,s.jsx)(t.code,{children:"zrok"})," ",(0,s.jsx)(t.a,{href:"/docs/concepts/hosting",children:"hosting here"}),", including instructions on how to ",(0,s.jsxs)(t.a,{href:"/docs/guides/self-hosting/linux/",children:["install your own ",(0,s.jsx)(t.code,{children:"zrok"})," instance"]}),"."]})]})}function h(e={}){const{wrapper:t}={...(0,o.a)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},1151:(e,t,n)=>{n.d(t,{Z:()=>i,a:()=>c});var s=n(7294);const o={},r=s.createContext(o);function c(e){const t=s.useContext(r);return s.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:c(e.components),s.createElement(r.Provider,{value:t},e.children)}}}]);

assets/js/c015c796.c571777a.js

@@ -1 +1 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[2732],{2180:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var i=n(5893),r=n(1151);const t={title:"Sharing Websites and Files",sidebar_position:30},o=void 0,c={id:"concepts/files",title:"Sharing Websites and Files",description:"With zrok it is possible to share files quickly and easily as well. To share files using zrok use",source:"@site/../docs/concepts/files.md",sourceDirName:"concepts",slug:"/concepts/files",permalink:"/docs/concepts/files",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/concepts/files.md",tags:[],version:"current",sidebarPosition:30,frontMatter:{title:"Sharing Websites and Files",sidebar_position:30},sidebar:"tutorialSidebar",previous:{title:"Sharing TCP and UDP Servers",permalink:"/docs/concepts/tunnels"},next:{title:"Open Source",permalink:"/docs/concepts/opensource"}},a={},l=[];function d(e){const s={code:"code",img:"img",p:"p",pre:"pre",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(s.p,{children:["With ",(0,i.jsx)(s.code,{children:"zrok"})," it is possible to share files quickly and easily as well. To share files using ",(0,i.jsx)(s.code,{children:"zrok"})," use\nthe ",(0,i.jsx)(s.code,{children:"--backend-mode web"}),", for example: ",(0,i.jsx)(s.code,{children:"zrok share private . --backend-mode web"}),"."]}),"\n",(0,i.jsx)(s.p,{children:"Running with this mode will make it trivially easy to share files from the directory which the command\nwas run from."}),"\n",(0,i.jsx)(s.p,{children:"For example if you have a directory with a structure like this:"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-shell",children:"-rw-r--r--+ 1 Michael None     7090 Apr 17 12:53 CHANGELOG.md\n-rw-r--r--+ 1 Michael None    11346 Apr 17 12:53 LICENSE\n-rw-r--r--+ 1 Michael None     2885 Apr 17 12:53 README.md\n-rwxr-xr-x+ 1 Michael None 44250624 Apr 17 13:00 zrok.exe*\n"})}),"\n",(0,i.jsx)(s.p,{children:"The files can be shared using a command such as:"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-shell",children:"zrok share public --backend-mode web .\n"})}),"\n",(0,i.jsxs)(s.p,{children:["Then the files can be access with a ",(0,i.jsx)(s.code,{children:"private"})," or ",(0,i.jsx)(s.code,{children:"public"})," share, for example as shown:"]}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.img,{alt:"zrok_share_web_files",src:n(4054).Z+"",width:"952",height:"723"})}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"zrok"})," will automatically provide a stock website, which will allow the accessing user to browse and navigate the file tree. Clicking the files allows the user to download them."]}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"zrok"})," can also share a pre-rendered static HTML website. If you have a directory like this:"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-shell",children:"-rw-rw-r--+ 1 Michael None 56 Jun 26 13:23 index.html\n"})}),"\n",(0,i.jsxs)(s.p,{children:["If ",(0,i.jsx)(s.code,{children:"index.html"})," contains valid HTML, like this:"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-html",children:"<html>\n<body>\n        <h1>Hello <code>zrok</code></h1>\n</html>\n"})}),"\n",(0,i.jsx)(s.p,{children:"Sharing the directory will result in the following when you access the share in a web browser:"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.img,{alt:"zrok_share_web_website",src:n(9068).Z+"",width:"952",height:"723"})}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"zrok"})," contains a built-in web server, which you can use to serve static websites as a share."]})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},4054:(e,s,n)=>{n.d(s,{Z:()=>i});const i=n.p+"assets/images/zrok_share_web_files-936de420b39b071d71a8e275fe84e63d.png"},9068:(e,s,n)=>{n.d(s,{Z:()=>i});const i=n.p+"assets/images/zrok_share_web_website-5d4c550374b118d1992e488bb319e230.png"},1151:(e,s,n)=>{n.d(s,{Z:()=>c,a:()=>o});var i=n(7294);const r={},t=i.createContext(r);function o(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]);
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[2732],{4561:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>a,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>l});var i=n(5893),r=n(1151);const t={title:"Sharing Websites and Files",sidebar_position:30},o=void 0,c={id:"concepts/files",title:"Sharing Websites and Files",description:"With zrok it is possible to share files quickly and easily as well. To share files using zrok use",source:"@site/../docs/concepts/files.md",sourceDirName:"concepts",slug:"/concepts/files",permalink:"/docs/concepts/files",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/concepts/files.md",tags:[],version:"current",sidebarPosition:30,frontMatter:{title:"Sharing Websites and Files",sidebar_position:30},sidebar:"tutorialSidebar",previous:{title:"Sharing TCP and UDP Servers",permalink:"/docs/concepts/tunnels"},next:{title:"Open Source",permalink:"/docs/concepts/opensource"}},a={},l=[];function d(e){const s={code:"code",img:"img",p:"p",pre:"pre",...(0,r.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(s.p,{children:["With ",(0,i.jsx)(s.code,{children:"zrok"})," it is possible to share files quickly and easily as well. To share files using ",(0,i.jsx)(s.code,{children:"zrok"})," use\nthe ",(0,i.jsx)(s.code,{children:"--backend-mode web"}),", for example: ",(0,i.jsx)(s.code,{children:"zrok share private . --backend-mode web"}),"."]}),"\n",(0,i.jsx)(s.p,{children:"Running with this mode will make it trivially easy to share files from the directory which the command\nwas run from."}),"\n",(0,i.jsx)(s.p,{children:"For example if you have a directory with a structure like this:"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-shell",children:"-rw-r--r--+ 1 Michael None     7090 Apr 17 12:53 CHANGELOG.md\n-rw-r--r--+ 1 Michael None    11346 Apr 17 12:53 LICENSE\n-rw-r--r--+ 1 Michael None     2885 Apr 17 12:53 README.md\n-rwxr-xr-x+ 1 Michael None 44250624 Apr 17 13:00 zrok.exe*\n"})}),"\n",(0,i.jsx)(s.p,{children:"The files can be shared using a command such as:"}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-shell",children:"zrok share public --backend-mode web .\n"})}),"\n",(0,i.jsxs)(s.p,{children:["Then the files can be access with a ",(0,i.jsx)(s.code,{children:"private"})," or ",(0,i.jsx)(s.code,{children:"public"})," share, for example as shown:"]}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.img,{alt:"zrok_share_web_files",src:n(4054).Z+"",width:"952",height:"723"})}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"zrok"})," will automatically provide a stock website, which will allow the accessing user to browse and navigate the file tree. Clicking the files allows the user to download them."]}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"zrok"})," can also share a pre-rendered static HTML website. If you have a directory like this:"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-shell",children:"-rw-rw-r--+ 1 Michael None 56 Jun 26 13:23 index.html\n"})}),"\n",(0,i.jsxs)(s.p,{children:["If ",(0,i.jsx)(s.code,{children:"index.html"})," contains valid HTML, like this:"]}),"\n",(0,i.jsx)(s.pre,{children:(0,i.jsx)(s.code,{className:"language-html",children:"<html>\n<body>\n        <h1>Hello <code>zrok</code></h1>\n</html>\n"})}),"\n",(0,i.jsx)(s.p,{children:"Sharing the directory will result in the following when you access the share in a web browser:"}),"\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.img,{alt:"zrok_share_web_website",src:n(9068).Z+"",width:"952",height:"723"})}),"\n",(0,i.jsxs)(s.p,{children:[(0,i.jsx)(s.code,{children:"zrok"})," contains a built-in web server, which you can use to serve static websites as a share."]})]})}function h(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},4054:(e,s,n)=>{n.d(s,{Z:()=>i});const i=n.p+"assets/images/zrok_share_web_files-936de420b39b071d71a8e275fe84e63d.png"},9068:(e,s,n)=>{n.d(s,{Z:()=>i});const i=n.p+"assets/images/zrok_share_web_website-5d4c550374b118d1992e488bb319e230.png"},1151:(e,s,n)=>{n.d(s,{Z:()=>c,a:()=>o});var i=n(7294);const r={},t=i.createContext(r);function o(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]);

assets/js/d9f29b48.6d24467b.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[9714],{690:e=>{e.exports=JSON.parse('{"categoryGeneratedIndex":{"title":"Metrics and Limits","slug":"/category/metrics-and-limits","permalink":"/docs/category/metrics-and-limits","sidebar":"tutorialSidebar","navigation":{"previous":{"title":"Docker","permalink":"/docs/guides/self-hosting/docker"},"next":{"title":"Configuring Metrics","permalink":"/docs/guides/self-hosting/metrics-and-limits/configuring-metrics"}}}}')}}]);

assets/js/e2c4d679.2ab770e0.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[5274],{1552:i=>{i.exports=JSON.parse('{"categoryGeneratedIndex":{"title":"OAuth","slug":"/category/oauth","permalink":"/docs/category/oauth","sidebar":"tutorialSidebar","navigation":{"previous":{"title":"Configuring Limits","permalink":"/docs/guides/self-hosting/metrics-and-limits/configuring-limits"},"next":{"title":"OAuth Public Frontend Configuration","permalink":"/docs/guides/self-hosting/oauth/configuring-oauth"}}}}')}}]);

assets/js/f2348458.19be6454.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[2992],{4732:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>a,contentTitle:()=>i,default:()=>d,frontMatter:()=>c,metadata:()=>t,toc:()=>h});var n=r(5893),o=r(1151);const c={sidebar_position:10},i="Public Shares",t={id:"concepts/sharing-public",title:"Public Shares",description:"zrok supports public sharing for web-based (HTTP and HTTPS) resources. These resources are easily shared with the general internet through public access points.",source:"@site/../docs/concepts/sharing-public.md",sourceDirName:"concepts",slug:"/concepts/sharing-public",permalink:"/docs/concepts/sharing-public",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/concepts/sharing-public.md",tags:[],version:"current",sidebarPosition:10,frontMatter:{sidebar_position:10},sidebar:"tutorialSidebar",previous:{title:"Private Shares",permalink:"/docs/concepts/sharing-private"},next:{title:"Reserved Shares",permalink:"/docs/concepts/sharing-reserved"}},a={},h=[{value:"Peer to Public",id:"peer-to-public",level:2}];function l(e){const s={code:"code",h1:"h1",h2:"h2",img:"img",p:"p",...(0,o.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.h1,{id:"public-shares",children:"Public Shares"}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.code,{children:"zrok"})," supports ",(0,n.jsx)(s.code,{children:"public"})," sharing for web-based (HTTP and HTTPS) resources. These resources are easily shared with the general internet through public access points."]}),"\n",(0,n.jsx)(s.h2,{id:"peer-to-public",children:"Peer to Public"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.img,{alt:"zrok_public_share",src:r(6831).Z+"",width:"2200",height:"916"})}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.code,{children:"public"})," sharing is most useful when the person or service accessing your resources does not have ",(0,n.jsx)(s.code,{children:"zrok"})," running locally and cannot make use of the ",(0,n.jsx)(s.code,{children:"private"})," sharing mode built into ",(0,n.jsx)(s.code,{children:"zrok"}),". Many users share development web servers, webhooks, and other HTTP/HTTPS resources."]}),"\n",(0,n.jsxs)(s.p,{children:["As with ",(0,n.jsx)(s.code,{children:"private"})," sharing, ",(0,n.jsx)(s.code,{children:"public"})," sharing does not require you to open any firewall ports or otherwise compromise the security of your local environments. A ",(0,n.jsx)(s.code,{children:"public"})," share goes away as soon as you terminate the ",(0,n.jsx)(s.code,{children:"zrok share"})," command."]}),"\n",(0,n.jsxs)(s.p,{children:["Using ",(0,n.jsx)(s.code,{children:"public"})," shares is easy and is accomplished using the ",(0,n.jsx)(s.code,{children:"zrok share public"})," command. Run ",(0,n.jsx)(s.code,{children:"zrok share public"})," to see the command-line help and to learn how to use ",(0,n.jsx)(s.code,{children:"public"})," shares."]})]})}function d(e={}){const{wrapper:s}={...(0,o.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},6831:(e,s,r)=>{r.d(s,{Z:()=>n});const n=r.p+"assets/images/zrok_public_share-1eec22cb798395c2bcd3ac10465f62ca.png"},1151:(e,s,r)=>{r.d(s,{Z:()=>t,a:()=>i});var n=r(7294);const o={},c=n.createContext(o);function i(e){const s=n.useContext(c);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function t(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),n.createElement(c.Provider,{value:s},e.children)}}}]);

assets/js/f2348458.3093e5a9.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[2992],{2711:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>a,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>t,toc:()=>h});var n=r(5893),c=r(1151);const o={sidebar_position:10},i="Public Shares",t={id:"concepts/sharing-public",title:"Public Shares",description:"zrok supports public sharing for web-based (HTTP and HTTPS) resources. These resources are easily shared with the general internet through public access points.",source:"@site/../docs/concepts/sharing-public.md",sourceDirName:"concepts",slug:"/concepts/sharing-public",permalink:"/docs/concepts/sharing-public",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/concepts/sharing-public.md",tags:[],version:"current",sidebarPosition:10,frontMatter:{sidebar_position:10},sidebar:"tutorialSidebar",previous:{title:"Private Shares",permalink:"/docs/concepts/sharing-private"},next:{title:"Reserved Shares",permalink:"/docs/concepts/sharing-reserved"}},a={},h=[{value:"Peer to Public",id:"peer-to-public",level:2}];function d(e){const s={code:"code",h1:"h1",h2:"h2",header:"header",img:"img",p:"p",...(0,c.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.header,{children:(0,n.jsx)(s.h1,{id:"public-shares",children:"Public Shares"})}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.code,{children:"zrok"})," supports ",(0,n.jsx)(s.code,{children:"public"})," sharing for web-based (HTTP and HTTPS) resources. These resources are easily shared with the general internet through public access points."]}),"\n",(0,n.jsx)(s.h2,{id:"peer-to-public",children:"Peer to Public"}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.img,{alt:"zrok_public_share",src:r(6831).Z+"",width:"2200",height:"916"})}),"\n",(0,n.jsxs)(s.p,{children:[(0,n.jsx)(s.code,{children:"public"})," sharing is most useful when the person or service accessing your resources does not have ",(0,n.jsx)(s.code,{children:"zrok"})," running locally and cannot make use of the ",(0,n.jsx)(s.code,{children:"private"})," sharing mode built into ",(0,n.jsx)(s.code,{children:"zrok"}),". Many users share development web servers, webhooks, and other HTTP/HTTPS resources."]}),"\n",(0,n.jsxs)(s.p,{children:["As with ",(0,n.jsx)(s.code,{children:"private"})," sharing, ",(0,n.jsx)(s.code,{children:"public"})," sharing does not require you to open any firewall ports or otherwise compromise the security of your local environments. A ",(0,n.jsx)(s.code,{children:"public"})," share goes away as soon as you terminate the ",(0,n.jsx)(s.code,{children:"zrok share"})," command."]}),"\n",(0,n.jsxs)(s.p,{children:["Using ",(0,n.jsx)(s.code,{children:"public"})," shares is easy and is accomplished using the ",(0,n.jsx)(s.code,{children:"zrok share public"})," command. Run ",(0,n.jsx)(s.code,{children:"zrok share public"})," to see the command-line help and to learn how to use ",(0,n.jsx)(s.code,{children:"public"})," shares."]})]})}function l(e={}){const{wrapper:s}={...(0,c.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},6831:(e,s,r)=>{r.d(s,{Z:()=>n});const n=r.p+"assets/images/zrok_public_share-1eec22cb798395c2bcd3ac10465f62ca.png"},1151:(e,s,r)=>{r.d(s,{Z:()=>t,a:()=>i});var n=r(7294);const c={},o=n.createContext(c);function i(e){const s=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function t(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),n.createElement(o.Provider,{value:s},e.children)}}}]);