zrok/assets/js/d7b2321f.37732590.js

"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[809],{3905:(e,r,t)=>{t.d(r,{Zo:()=>p,kt:()=>b});var n=t(7294);function a(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function i(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function o(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?i(Object(t),!0).forEach((function(r){a(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):i(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}function s(e,r){if(null==e)return{};var t,n,a=function(e,r){if(null==e)return{};var t,n,a={},i=Object.keys(e);for(n=0;n<i.length;n++)t=i[n],r.indexOf(t)>=0||(a[t]=e[t]);return a}(e,r);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)t=i[n],r.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var c=n.createContext({}),l=function(e){var r=n.useContext(c),t=r;return e&&(t="function"==typeof e?e(r):o(o({},r),e)),t},p=function(e){var r=l(e.components);return n.createElement(c.Provider,{value:r},e.children)},u="mdxType",h={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},d=n.forwardRef((function(e,r){var t=e.components,a=e.mdxType,i=e.originalType,c=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=l(t),d=a,b=u["".concat(c,".").concat(d)]||u[d]||h[d]||i;return t?n.createElement(b,o(o({ref:r},p),{},{components:t})):n.createElement(b,o({ref:r},p))}));function b(e,r){var t=arguments,a=r&&r.mdxType;if("string"==typeof e||a){var i=t.length,o=new Array(i);o[0]=d;var s={};for(var c in r)hasOwnProperty.call(r,c)&&(s[c]=r[c]);s.originalType=e,s[u]="string"==typeof e?e:a,o[1]=s;for(var l=2;l<i;l++)o[l]=t[l];return n.createElement.apply(null,o)}return n.createElement.apply(null,t)}d.displayName="MDXCreateElement"},7383:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var n=t(7462),a=(t(7294),t(3905));const i={sidebar_position:10},o="Shares - Public",s={unversionedId:"core-features/sharing-public",id:"core-features/sharing-public",title:"Shares - Public",description:"zrok was built to share and access digital resources. a public share allows something to be shared through",source:"@site/../docs/core-features/sharing-public.md",sourceDirName:"core-features",slug:"/core-features/sharing-public",permalink:"/docs/core-features/sharing-public",draft:!1,editUrl:"https://github.com/openziti/zrok/tree/main/../docs/core-features/sharing-public.md",tags:[],version:"current",sidebarPosition:10,frontMatter:{sidebar_position:10},sidebar:"tutorialSidebar",previous:{title:"Shares - Private",permalink:"/docs/core-features/sharing-private"},next:{title:"Shares - Reserved",permalink:"/docs/core-features/sharing-reserved"}},c={},l=[{value:"Public Sharing",id:"public-sharing",level:2}],p={toc:l};function u(e){let{components:r,...i}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,i,{components:r,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"shares---public"},"Shares - Public"),(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"},"public")," share allows something to be shared through\na publicly available endpoint."),(0,a.kt)("h2",{id:"public-sharing"},"Public Sharing"),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"zrok_public_share",src:t(6831).Z,width:"2200",height:"916"})),(0,a.kt)("p",null,"Sharing something with ",(0,a.kt)("inlineCode",{parentName:"p"},"public")," is useful when the person or service accessing the thing being shared doesn't\nhave ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok")," running locally and can't make use of the ",(0,a.kt)("inlineCode",{parentName:"p"},"private")," sharing mode built into ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok"),". This could be\na development web server to share with friends and colleagues, or perhaps a webhook from a\nserver running in the cloud which can't have ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok")," installed onto it. What matters is that the access to the\nshared resource needs to be done in a public way, generally for easy access."),(0,a.kt)("p",null,"Using ",(0,a.kt)("inlineCode",{parentName:"p"},"public")," shares is easy and is accomplished using the ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok share public")," command. Run ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok share public"),"\nto see the usage output and to further learn how to use the command. "),(0,a.kt)("p",null,"Unless ",(0,a.kt)("inlineCode",{parentName:"p"},"reserved")," (see ",(0,a.kt)("a",{parentName:"p",href:"/docs/core-features/sharing-reserved"},"Sharing - Reserved"),", all 'public' shares are ephemeral. When the\nsharing is stopped, the shared url will be reclaimed."))}u.isMDXComponent=!0},6831:(e,r,t)=>{t.d(r,{Z:()=>n});const n=t.p+"assets/images/zrok_public_share-1eec22cb798395c2bcd3ac10465f62ca.png"}}]);