zrok/assets/js/8bf77064.f45db9f7.js

"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[307],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?i(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):i(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function s(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},i=Object.keys(e);for(n=0;n<i.length;n++)r=i[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)r=i[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),c=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},l=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},u="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),u=c(r),d=a,m=u["".concat(p,".").concat(d)]||u[d]||h[d]||i;return r?n.createElement(m,o(o({ref:t},l),{},{components:r})):n.createElement(m,o({ref:t},l))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=d;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[u]="string"==typeof e?e:a,o[1]=s;for(var c=2;c<i;c++)o[c]=r[c];return n.createElement.apply(null,o)}return n.createElement.apply(null,r)}d.displayName="MDXCreateElement"},9569:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var n=r(7462),a=(r(7294),r(3905));const i={sidebar_position:0},o="Shares - Private",s={unversionedId:"core-features/sharing-private",id:"core-features/sharing-private",title:"Shares - Private",description:"zrok was built to share and access digital resources. A private share allows a resource to be",source:"@site/../docs/core-features/sharing-private.md",sourceDirName:"core-features",slug:"/core-features/sharing-private",permalink:"/docs/core-features/sharing-private",draft:!1,editUrl:"https://github.com/openziti/zrok/tree/main/../docs/core-features/sharing-private.md",tags:[],version:"current",sidebarPosition:0,frontMatter:{sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Core Features",permalink:"/docs/core-features/"},next:{title:"Shares - Public",permalink:"/docs/core-features/sharing-public"}},p={},c=[],l={toc:c};function u(e){let{components:t,...i}=e;return(0,a.kt)("wrapper",(0,n.Z)({},l,i,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"shares---private"},"Shares - Private"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"zrok")," was built to share and access digital resources. A ",(0,a.kt)("inlineCode",{parentName:"p"},"private")," share allows a resource to be\nshared through a ",(0,a.kt)("strong",{parentName:"p"},"privately")," available endpoint. Sharing a resource with ",(0,a.kt)("inlineCode",{parentName:"p"},"private")," is ",(0,a.kt)("strong",{parentName:"p"},"a differentiating"),"\nfeature of ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok"),"."),(0,a.kt)("h1",{id:"peer-to-peer"},"Peer to Peer"),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"zrok_public_share",src:r(4371).Z,width:"2200",height:"922"})),(0,a.kt)("p",null,"A ",(0,a.kt)("inlineCode",{parentName:"p"},"private")," share will require ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok")," to access the share and will also require a special shared\nsecret token. This access token, combined with the ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok access")," command will be how the private share is accessed."),(0,a.kt)("p",null,"Sharing something with ",(0,a.kt)("inlineCode",{parentName:"p"},"private")," is similar to sharing something publicly. The main difference is\nobvious, the shared resource is ",(0,a.kt)("inlineCode",{parentName:"p"},"private")," and the share is ",(0,a.kt)("strong",{parentName:"p"},"not")," open to the public. With ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok"),", you\ncan share resources on a private network without needing to expose the service to the internet. The share is not\nthrough an obfuscated, difficult to guess url. Instead the sharing is accomplished using a secure, zero trust overlay\nnetwork provided by ",(0,a.kt)("a",{parentName:"p",href:"https://docs.openziti.io/docs/learn/introduction/"},"OpenZiti"),". With this private, peer to peer\nsharing model, there will never an attack surface available to the open internet."),(0,a.kt)("p",null,"The shared resource can be a development web server to share with friends and colleagues or perhaps,\nit could be a webhook from a server running in the cloud which has ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok")," running and has been instructed\nto ",(0,a.kt)("inlineCode",{parentName:"p"},"access")," the private resource. What matters is that the access to the shared resource ",(0,a.kt)("strong",{parentName:"p"},"should not"),"\nbe done in a public way, for more secure access."),(0,a.kt)("p",null,"Using ",(0,a.kt)("inlineCode",{parentName:"p"},"private")," shares is easy and is accomplished using the ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok share private")," command. Run ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok share private"),"\nto see the usage output and to further learn how to use the command. "),(0,a.kt)("p",null,"Unlike public shares, ",(0,a.kt)("inlineCode",{parentName:"p"},"private")," shares do not need to be ",(0,a.kt)("a",{parentName:"p",href:"/docs/core-features/sharing-reserved"},"reserved")," to be predictable. When sharing a\nresource with ",(0,a.kt)("inlineCode",{parentName:"p"},"private"),", the resource is shared at a known location. Resources shared with ",(0,a.kt)("inlineCode",{parentName:"p"},"private")," do not\nneed to be ",(0,a.kt)("inlineCode",{parentName:"p"},"reserved"),"."))}u.isMDXComponent=!0},4371:(e,t,r)=>{r.d(t,{Z:()=>n});const n=r.p+"assets/images/zrok_private_share-3b4b2f89f7b5e6704d0b9078a701161e.png"}}]);