deploy: 309b146fd8

assets/files/ctrl-d38582b0659ce68bb74a29b4283084c3.yml

@@ -0,0 +1,189 @@
+#    _____ __ ___ | | __
+#   |_  / '__/ _ \| |/ /
+#    / /| | | (_) |   <
+#   /___|_|  \___/|_|\_\
+# controller configuration
+#
+
+# The `v` field determines the configuration version. When software is released that changes the structure of the
+# configuration, the software will expect this field to be incremented. This protects you against invalid configuration
+# versions.
+#
+v: 3
+
+admin:
+  # The `secrets` array contains a list of strings that represent valid `ZROK_ADMIN_TOKEN` values to be used for
+  # administration of the `zrok` controller.
+  #
+  # Change this for your installation.
+  #
+  secrets:
+    -                             77623cad-1847-4d6d-8ffe-37defc33c909
+  #
+  # If `tou_link` is present, the frontend will display the "Terms of Use" link on the login and registration forms
+  #
+  tou_link:                       '<a href="https://google.com" target="_">Terms and Conditions</a>'
+  #
+  # If `profile_endpoint` is present, the controller will start a `net/http/pprof` endpoint at the specified host:port
+  #
+  #profile_endpoint:               localhost:6060
+
+# The `bridge` section configures the `zrok controller metrics bridge`, specifying the source and sink where OpenZiti
+# `fabric.usage` events are consumed and then sent into `zrok`. For production environments, we recommend that you use
+# the `fileSource`, tailing the events from a JSON file written to by the OpenZiti controller. The `amqpSink` will then
+# forward the events to an AMQP queue for consumption by multiple `zrok` controllers.
+#
+bridge:
+  source:
+    type:           fileSource
+    path:           /tmp/fabric-usage.json
+  sink:
+    type:           amqpSink
+    url:            amqp://guest:guest@localhost:5672
+    queue_name:     events
+
+# The `endpoint` section determines where the HTTP listener that serves the API and web console will be bound.
+#
+endpoint:
+  host:                           0.0.0.0
+  port:                           18080
+
+# Outbound email configuration.
+#
+email:
+  host:                           smtp.server.com
+  port:                           587  # this must be a STARTTLS port, not the TLS port (465)
+  username:                       ""
+  password:                       ""
+  from:                           ziggy@zrok.io
+
+# Invites
+#
+invites:
+  #
+  # Setting `invites_open` to `true` will allow your service instance to allow users to request invites.
+  #
+  invites_open:                   false
+  #
+  # Setting `token_strategy` to `store` will use the `invite_tokens` table in the database for available invite tokens.
+  #
+  token_strategy:                 store
+  #
+  # Setting `token_contact` to something other than an empty string will show the contact information in the
+  # `zrok invite` command.
+  #
+  token_contact:                  invite@zrok.io
+
+# Service instance limits configuration.
+#
+# See `docs/guides/metrics-and-limits/configuring-limits.md` for details.
+#
+limits:
+  environments:     -1
+  shares:           -1
+  bandwidth:
+    per_account:
+      period:       5m
+      warning:
+        rx:         -1
+        tx:         -1
+        total:      7242880
+      limit:
+        rx:         -1
+        tx:         -1
+        total:      10485760
+    per_environment:
+      period:       5m
+      warning:
+        rx:         -1
+        tx:         -1
+        total:      -1
+      limit:
+        rx:         -1
+        tx:         -1
+        total:      -1
+    per_share:
+      period:       5m
+      warning:
+        rx:         -1
+        tx:         -1
+        total:      -1
+      limit:
+        rx:         -1
+        tx:         -1
+        total:      -1
+  enforcing:        false
+  cycle:            5m
+
+# Background maintenance job configuration. The `registration` job purges registration requests created through the
+# `zrok invite` tool. The `reset_password` job purges password reset requests.
+#
+maintenance:
+  registration:
+    expiration_timeout:           24h
+    check_frequency:              1h
+    batch_limit:                  500
+  reset_password:
+    expiration_timeout:           15m
+    check_frequency:              15m
+    batch_limit:                  500
+
+# Metrics configuration.
+#
+metrics:
+  agent:
+    # The `source` controls where the `zrok controller` looks to consume OpenZiti `fabric.usage` events. This works in
+    # concert with the `bridge` section above to consume events from an AMQP queue. This can also be configured to work
+    # with a `fileSource` (see the `bridge` section above for details), and also with a `websocketSource`.
+    #
+    source:
+      type:         amqpSource
+      url:          amqp://guest:guest@localhost:5672
+      queue_name:   events
+  #
+  # The `influx` section configures access to the InfluxDB instance used to store `zrok` metrics.
+  #
+  influx:
+    url:            "http://127.0.0.1:8086"
+    bucket:         zrok
+    org:            zrok
+    token:          "<INFLUX TOKEN>"
+
+# Configure password requirements for user accounts.
+#
+#passwords:
+#  length:           8
+#  require_capital:  true
+#  require_numeric:  true
+#  require_special:  true
+#  # Denote which characters satisfy the `require_special` requirement. Note the need to escape specific characters.
+#  valid_special_characters: "\"\\`'~!@#$%^&*()[],./"
+
+# Configure the generated URL for the registration email. The registration token will be appended to this URL.
+#
+registration:
+  registration_url_template:      https://zrok.server.com/register
+
+# Configure the generated URL for password resets. The reset token will be appended to this URL.
+#
+reset_password:
+  reset_url_template:             https://zrok.server.com/resetPassword
+
+# Configure the controller database. Supports either PostgreSQL or sqlite3.
+#
+# sqlite3 only supports a single controller instance. To run multiple controllers, you must use PostgreSQL.
+#
+#store:
+#  path:                           "host=127.0.0.1 user=zrok password=zrok dbname=zrok"
+#  type:                           "postgres"
+#
+store:
+  path:                           zrok.db
+  type:                           sqlite3
+
+# Ziti configuration.
+#
+ziti:
+  api_endpoint:                   https://127.0.0.1:1280
+  username:                       admin
+  password:                       admin

assets/js/04b79425.740c756e.js

@@ -1 +1 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[161],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>b});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 o(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 i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?o(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):o(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function l(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},o=Object.keys(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),p=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=p(e.components);return n.createElement(s.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=p(r),m=a,b=u["".concat(s,".").concat(m)]||u[m]||c[m]||o;return r?n.createElement(b,i(i({ref:t},d),{},{components:r})):n.createElement(b,i({ref:t},d))}));function b(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[u]="string"==typeof e?e:a,i[1]=l;for(var p=2;p<o;p++)i[p]=r[p];return n.createElement.apply(null,i)}return n.createElement.apply(null,r)}m.displayName="MDXCreateElement"},8434:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={sidebar_position:100},i="Downloads",l={unversionedId:"downloads",id:"downloads",title:"Downloads",description:"Right now all zrok binaries are delivered from the release page at GitHub.",source:"@site/../docs/downloads.md",sourceDirName:".",slug:"/downloads",permalink:"/docs/downloads",draft:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/downloads.md",tags:[],version:"current",sidebarPosition:100,frontMatter:{sidebar_position:100},sidebar:"tutorialSidebar",previous:{title:"Private Share",permalink:"/docs/guides/docker-share/v0.3_docker_private_share_guide"}},s={},p=[],d={toc:p};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"downloads"},"Downloads"),(0,a.kt)("p",null,"Right now all ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok")," binaries are delivered from the release page at GitHub."),(0,a.kt)("p",null,"Head over to ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/openziti/zrok/releases/latest"},"https://github.com/openziti/zrok/releases/latest")," to find the latest downloads."),(0,a.kt)("p",null,"You need the right download for your OS and CPU. This can be confusing because the OS, e.g., Raspberry Pi OS, could be 32bit even if you have a 64bit Pi (v3, 4, or Zero 2). Linux users can always find the right version by looking up the result of ",(0,a.kt)("inlineCode",{parentName:"p"},"uname -m")," in this table."),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Result"),(0,a.kt)("th",{parentName:"tr",align:null},"Linux Download Name"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"x86_64"),(0,a.kt)("td",{parentName:"tr",align:null},"linux-amd64")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"aarch64, arm/v8"),(0,a.kt)("td",{parentName:"tr",align:null},"linux-arm64")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"armhf, arm/v7"),(0,a.kt)("td",{parentName:"tr",align:null},"linux-armv7")))))}u.isMDXComponent=!0}}]);
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[161],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>f});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 o(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 i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?o(Object(r),!0).forEach((function(t){a(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):o(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function l(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},o=Object.keys(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),p=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},u=function(e){var t=p(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),c=p(r),m=a,f=c["".concat(s,".").concat(m)]||c[m]||d[m]||o;return r?n.createElement(f,i(i({ref:t},u),{},{components:r})):n.createElement(f,i({ref:t},u))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:a,i[1]=l;for(var p=2;p<o;p++)i[p]=r[p];return n.createElement.apply(null,i)}return n.createElement.apply(null,r)}m.displayName="MDXCreateElement"},8434:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>c,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={sidebar_position:100},i="Downloads",l={unversionedId:"downloads",id:"downloads",title:"Downloads",description:"Right now all zrok binaries are delivered from the release page at GitHub.",source:"@site/../docs/downloads.md",sourceDirName:".",slug:"/downloads",permalink:"/docs/downloads",draft:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/downloads.md",tags:[],version:"current",sidebarPosition:100,frontMatter:{sidebar_position:100},sidebar:"tutorialSidebar",previous:{title:"Configuring Metrics",permalink:"/docs/guides/metrics-and-limits/configuring-metrics"}},s={},p=[],u={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"downloads"},"Downloads"),(0,a.kt)("p",null,"Right now all ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok")," binaries are delivered from the release page at GitHub."),(0,a.kt)("p",null,"Head over to ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/openziti/zrok/releases/latest"},"https://github.com/openziti/zrok/releases/latest")," to find the latest downloads."),(0,a.kt)("p",null,"You need the right download for your OS and CPU. This can be confusing because the OS, e.g., Raspberry Pi OS, could be 32bit even if you have a 64bit Pi (v3, 4, or Zero 2). Linux users can always find the right version by looking up the result of ",(0,a.kt)("inlineCode",{parentName:"p"},"uname -m")," in this table."),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Result"),(0,a.kt)("th",{parentName:"tr",align:null},"Linux Download Name"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"x86_64"),(0,a.kt)("td",{parentName:"tr",align:null},"linux-amd64")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"aarch64, arm/v8"),(0,a.kt)("td",{parentName:"tr",align:null},"linux-arm64")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},"armhf, arm/v7"),(0,a.kt)("td",{parentName:"tr",align:null},"linux-armv7")))))}c.isMDXComponent=!0}}]);

assets/js/0e530a5b.c5c264dd.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[653],{3905:(e,r,t)=>{t.d(r,{Zo:()=>u,kt:()=>h});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 s(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?s(Object(t),!0).forEach((function(r){a(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):s(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}function i(e,r){if(null==e)return{};var t,n,a=function(e,r){if(null==e)return{};var t,n,a={},s=Object.keys(e);for(n=0;n<s.length;n++)t=s[n],r.indexOf(t)>=0||(a[t]=e[t]);return a}(e,r);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(n=0;n<s.length;n++)t=s[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},u=function(e){var r=l(e.components);return n.createElement(c.Provider,{value:r},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},f=n.forwardRef((function(e,r){var t=e.components,a=e.mdxType,s=e.originalType,c=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),p=l(t),f=a,h=p["".concat(c,".").concat(f)]||p[f]||d[f]||s;return t?n.createElement(h,o(o({ref:r},u),{},{components:t})):n.createElement(h,o({ref:r},u))}));function h(e,r){var t=arguments,a=r&&r.mdxType;if("string"==typeof e||a){var s=t.length,o=new Array(s);o[0]=f;var i={};for(var c in r)hasOwnProperty.call(r,c)&&(i[c]=r[c]);i.originalType=e,i[p]="string"==typeof e?e:a,o[1]=i;for(var l=2;l<s;l++)o[l]=t[l];return n.createElement.apply(null,o)}return n.createElement.apply(null,t)}f.displayName="MDXCreateElement"},2971:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>c,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>i,toc:()=>l});var n=t(7462),a=(t(7294),t(3905));const s={sidebar_position:10},o="Shares - Reserved",i={unversionedId:"core-features/sharing-reserved",id:"core-features/sharing-reserved",title:"Shares - Reserved",description:"zrok was built to share and access digital resources. A reserved share allows the user to have a reliable,",source:"@site/../docs/core-features/sharing-reserved.md",sourceDirName:"core-features",slug:"/core-features/sharing-reserved",permalink:"/docs/core-features/sharing-reserved",draft:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/core-features/sharing-reserved.md",tags:[],version:"current",sidebarPosition:10,frontMatter:{sidebar_position:10},sidebar:"tutorialSidebar",previous:{title:"Shares - Public",permalink:"/docs/core-features/sharing-public"},next:{title:"File Sharing",permalink:"/docs/core-features/files"}},c={},l=[],u={toc:l};function p(e){let{components:r,...t}=e;return(0,a.kt)("wrapper",(0,n.Z)({},u,t,{components:r,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"shares---reserved"},"Shares - Reserved"),(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"},"reserved")," share allows the user to have a reliable,\npublic, persistent shared url. (the share name not ephemeral, it is ",(0,a.kt)("inlineCode",{parentName:"p"},"reserved"),"). This means that the share\nwill be able to be used and regardless of how many times the resource is shared. This is useful when the\nurl must be known. "),(0,a.kt)("p",null,"Use the ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok reserve")," command to create a reserved share."))}p.isMDXComponent=!0}}]);

assets/js/50ef9c44.d7719acf.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[198],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>m});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){o(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,r,o=function(e,t){if(null==e)return{};var n,r,o={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var c=r.createContext({}),p=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},l=function(e){var t=p(e.components);return r.createElement(c.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),d=p(n),f=o,m=d["".concat(c,".").concat(f)]||d[f]||u[f]||i;return n?r.createElement(m,a(a({ref:t},l),{},{components:n})):r.createElement(m,a({ref:t},l))}));function m(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=f;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[d]="string"==typeof e?e:o,a[1]=s;for(var p=2;p<i;p++)a[p]=n[p];return r.createElement.apply(null,a)}return r.createElement.apply(null,n)}f.displayName="MDXCreateElement"},6576:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var r=n(7462),o=(n(7294),n(3905));const i={sidebar_position:200},a="Hosting",s={unversionedId:"concepts/hosting",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,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"}},c={},p=[{value:"Self-Hosted",id:"self-hosted",level:2},{value:"Managed Service",id:"managed-service",level:2}],l={toc:p};function d(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"hosting"},"Hosting"),(0,o.kt)("h2",{id:"self-hosted"},"Self-Hosted"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," is not limited to a managed offering. You can ",(0,o.kt)("a",{parentName:"p",href:"/docs/guides/self-hosting/self_hosting_guide"},"host your own")," instance of ",(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," as well. ",(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," is\nalso freely available as open source software hosted by GitHub under a very permissive Apache v2 license."),(0,o.kt)("h2",{id:"managed-service"},"Managed Service"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," is also offered as a cloud service, making it instantly accessible to a large population immediately.\nNetFoundry provides a manged version of ",(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," at ",(0,o.kt)("a",{parentName:"p",href:"https://zrok.io."},"https://zrok.io.")," This provides the easy-to-use,\nquick to demonstrate features of ",(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," without needing to deploy and host ",(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," yourself."))}d.isMDXComponent=!0}}]);

assets/js/5b30ef33.58e5f77e.js

@@ -1 +1 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[402],{5975:e=>{e.exports=JSON.parse('{"title":"Docker Share","slug":"/category/docker-share","permalink":"/docs/category/docker-share","navigation":{"previous":{"title":"Nginx TLS","permalink":"/docs/guides/self-hosting/v0.3_nginx_tls_guide"},"next":{"title":"Public Share","permalink":"/docs/guides/docker-share/v0.3_docker_public_share_guide"}}}')}}]);
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[402],{5975:e=>{e.exports=JSON.parse('{"title":"Docker Share","slug":"/category/docker-share","permalink":"/docs/category/docker-share","navigation":{"previous":{"title":"Nginx TLS","permalink":"/docs/guides/self-hosting/nginx_tls_guide"},"next":{"title":"Public Share","permalink":"/docs/guides/docker-share/docker_public_share_guide"}}}')}}]);

assets/js/64b9aff8.a7afac61.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[111],{3905:(e,r,t)=>{t.d(r,{Zo:()=>u,kt:()=>m});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 o(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 i(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?o(Object(t),!0).forEach((function(r){a(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):o(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={},o=Object.keys(e);for(n=0;n<o.length;n++)t=o[n],r.indexOf(t)>=0||(a[t]=e[t]);return a}(e,r);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n<o.length;n++)t=o[n],r.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var c=n.createContext({}),p=function(e){var r=n.useContext(c),t=r;return e&&(t="function"==typeof e?e(r):i(i({},r),e)),t},u=function(e){var r=p(e.components);return n.createElement(c.Provider,{value:r},e.children)},l="mdxType",f={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,o=e.originalType,c=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),l=p(t),d=a,m=l["".concat(c,".").concat(d)]||l[d]||f[d]||o;return t?n.createElement(m,i(i({ref:r},u),{},{components:t})):n.createElement(m,i({ref:r},u))}));function m(e,r){var t=arguments,a=r&&r.mdxType;if("string"==typeof e||a){var o=t.length,i=new Array(o);i[0]=d;var s={};for(var c in r)hasOwnProperty.call(r,c)&&(s[c]=r[c]);s.originalType=e,s[l]="string"==typeof e?e:a,i[1]=s;for(var p=2;p<o;p++)i[p]=t[p];return n.createElement.apply(null,i)}return n.createElement.apply(null,t)}d.displayName="MDXCreateElement"},9386:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var n=t(7462),a=(t(7294),t(3905));const o={sidebar_title:"Core Features",sidebar_position:25},i="Core Features",s={unversionedId:"core-features/index",id:"core-features/index",title:"Core Features",description:"zrok was built for sharing resources. This doc is meant to explain the core features of zrok sharing",source:"@site/../docs/core-features/index.md",sourceDirName:"core-features",slug:"/core-features/",permalink:"/docs/core-features/",draft:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/core-features/index.md",tags:[],version:"current",sidebarPosition:25,frontMatter:{sidebar_title:"Core Features",sidebar_position:25},sidebar:"tutorialSidebar",previous:{title:"Getting Started with zrok",permalink:"/docs/getting-started"},next:{title:"Shares - Private",permalink:"/docs/core-features/sharing-private"}},c={},p=[],u={toc:p};function l(e){let{components:r,...t}=e;return(0,a.kt)("wrapper",(0,n.Z)({},u,t,{components:r,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"core-features"},"Core Features"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"zrok")," was built for sharing resources. This doc is meant to explain the core features of ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok")," sharing\nas well as other important features."),(0,a.kt)("p",null,"Sharing with ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok")," can be either ",(0,a.kt)("a",{parentName:"p",href:"/docs/core-features/sharing-public"},(0,a.kt)("inlineCode",{parentName:"a"},"public"))," or ",(0,a.kt)("a",{parentName:"p",href:"/docs/core-features/sharing-private"},(0,a.kt)("inlineCode",{parentName:"a"},"private")),".\nNaturally, regular web-based resources can be shared but ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok")," also includes a ",(0,a.kt)("a",{parentName:"p",href:"/docs/core-features/files"},"file sharing")," feature."),(0,a.kt)("p",null,"Learn about ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok")," ",(0,a.kt)("a",{parentName:"p",href:"/docs/core-features/hosting"},"hosting here"),"."))}l.isMDXComponent=!0}}]);

assets/js/8ae7f3b1.0cb2d38d.js

@@ -1 +1 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[212],{8429:e=>{e.exports=JSON.parse('{"title":"Guides","slug":"/category/guides","permalink":"/docs/category/guides","navigation":{"previous":{"title":"Hosting","permalink":"/docs/core-features/hosting"},"next":{"title":"Self Hosting","permalink":"/docs/category/self-hosting"}}}')}}]);
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[212],{8429:e=>{e.exports=JSON.parse('{"title":"Guides","slug":"/category/guides","permalink":"/docs/category/guides","navigation":{"previous":{"title":"Hosting","permalink":"/docs/concepts/hosting"},"next":{"title":"Self Hosting","permalink":"/docs/category/self-hosting"}}}')}}]);

assets/js/8ef4b25e.6f4db50f.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[318],{2636:i=>{i.exports=JSON.parse('{"title":"Metrics and Limits","slug":"/category/metrics-and-limits","permalink":"/docs/category/metrics-and-limits","navigation":{"previous":{"title":"Private Share","permalink":"/docs/guides/docker-share/docker_private_share_guide"},"next":{"title":"Configuring Limits","permalink":"/docs/guides/metrics-and-limits/configuring-limits"}}}')}}]);

assets/js/969.ba5129f7.js

@@ -1 +1 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[945],{6945:(e,s,b)=>{b.r(s)}}]);
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[969],{6945:(e,s,b)=>{b.r(s)}}]);

assets/js/a88ab1d1.5a08a257.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[731],{3905:(e,r,t)=>{t.d(r,{Zo:()=>p,kt:()=>m});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 l=n.createContext({}),c=function(e){var r=n.useContext(l),t=r;return e&&(t="function"==typeof e?e(r):o(o({},r),e)),t},p=function(e){var r=c(e.components);return n.createElement(l.Provider,{value:r},e.children)},u="mdxType",f={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,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(t),d=a,m=u["".concat(l,".").concat(d)]||u[d]||f[d]||i;return t?n.createElement(m,o(o({ref:r},p),{},{components:t})):n.createElement(m,o({ref:r},p))}));function m(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 l in r)hasOwnProperty.call(r,l)&&(s[l]=r[l]);s.originalType=e,s[u]="string"==typeof e?e:a,o[1]=s;for(var c=2;c<i;c++)o[c]=t[c];return n.createElement.apply(null,o)}return n.createElement.apply(null,t)}d.displayName="MDXCreateElement"},2419:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var n=t(7462),a=(t(7294),t(3905));const i={sidebar_position:30},o="File Sharing",s={unversionedId:"core-features/files",id:"core-features/files",title:"File Sharing",description:"With zrok it is possible to share files quickly and easily as well. To share files using zrok use",source:"@site/../docs/core-features/files.md",sourceDirName:"core-features",slug:"/core-features/files",permalink:"/docs/core-features/files",draft:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/core-features/files.md",tags:[],version:"current",sidebarPosition:30,frontMatter:{sidebar_position:30},sidebar:"tutorialSidebar",previous:{title:"Shares - Reserved",permalink:"/docs/core-features/sharing-reserved"},next:{title:"Open Source",permalink:"/docs/core-features/opensource"}},l={},c=[],p={toc:c};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:"file-sharing"},"File Sharing"),(0,a.kt)("p",null,"With ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok")," it is possible to share files quickly and easily as well. To share files using ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok")," use\nthe ",(0,a.kt)("inlineCode",{parentName:"p"},"--backend-mode web"),", for example: ",(0,a.kt)("inlineCode",{parentName:"p"},"zrok share private . --backend-mode web"),"."),(0,a.kt)("p",null,"Running with this mode will make it trivially easy to share files from the directory which the command\nwas run from."),(0,a.kt)("p",null,"For example if you have a directory with a structure like this:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-shell"},"-rwxrwxrwx 1 cd cd     2506 Jan 26 11:57 README.md\n-rwxrwxrwx 1 cd cd     2971 Jan 26 11:57 CHANGELOG.md\n-rwxrwxrwx 1 cd cd 41544024 Jan 26 12:00 zrok\n")),(0,a.kt)("p",null,"The files can be shared using a command such as: "),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-shell"},"zrok share public . --backend-mode web\n")),(0,a.kt)("p",null,"Then the files can be access with a ",(0,a.kt)("inlineCode",{parentName:"p"},"private")," or ",(0,a.kt)("inlineCode",{parentName:"p"},"public")," share, for example as shown:"),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"zrok_public_share",src:t(1535).Z,width:"478",height:"202"})))}u.isMDXComponent=!0},1535:(e,r,t)=>{t.d(r,{Z:()=>n});const n=t.p+"assets/images/zrok_share_file-a1f78e40063e7e0544a69bf99aee585d.png"}}]);

assets/js/b6820cd7.8e817633.js

@@ -1 +0,0 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[170],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>m});var n=r(7294);function o(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 a(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){o(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,o=function(e,t){if(null==e)return{};var r,n,o={},i=Object.keys(e);for(n=0;n<i.length;n++)r=i[n],t.indexOf(r)>=0||(o[r]=e[r]);return o}(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)&&(o[r]=e[r])}return o}var c=n.createContext({}),l=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):a(a({},t),e)),r},p=function(e){var t=l(e.components);return n.createElement(c.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,i=e.originalType,c=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=l(r),f=o,m=u["".concat(c,".").concat(f)]||u[f]||d[f]||i;return r?n.createElement(m,a(a({ref:t},p),{},{components:r})):n.createElement(m,a({ref:t},p))}));function m(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=r.length,a=new Array(i);a[0]=f;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[u]="string"==typeof e?e:o,a[1]=s;for(var l=2;l<i;l++)a[l]=r[l];return n.createElement.apply(null,a)}return n.createElement.apply(null,r)}f.displayName="MDXCreateElement"},4845:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var n=r(7462),o=(r(7294),r(3905));const i={sidebar_position:200},a="Hosting",s={unversionedId:"core-features/hosting",id:"core-features/hosting",title:"Hosting",description:"Self-Hosted",source:"@site/../docs/core-features/hosting.md",sourceDirName:"core-features",slug:"/core-features/hosting",permalink:"/docs/core-features/hosting",draft:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/core-features/hosting.md",tags:[],version:"current",sidebarPosition:200,frontMatter:{sidebar_position:200},sidebar:"tutorialSidebar",previous:{title:"Open Source",permalink:"/docs/core-features/opensource"},next:{title:"Guides",permalink:"/docs/category/guides"}},c={},l=[{value:"Self-Hosted",id:"self-hosted",level:2},{value:"Managed Service",id:"managed-service",level:2}],p={toc:l};function u(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"hosting"},"Hosting"),(0,o.kt)("h2",{id:"self-hosted"},"Self-Hosted"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," is not limited to a managed offering. You can ",(0,o.kt)("a",{parentName:"p",href:"/docs/guides/self-hosting/v0.3_self_hosting_guide"},"host your own")," instance of ",(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," as well. ",(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," is\nalso freely available as open source software hosted by GitHub under a very permissive Apache v2 license."),(0,o.kt)("h2",{id:"managed-service"},"Managed Service"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," is also offered as a cloud service, making it instantly accessible to a large population immediately.\nNetFoundry provides a manged version of ",(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," at ",(0,o.kt)("a",{parentName:"p",href:"https://zrok.io."},"https://zrok.io.")," This provides the easy-to-use,\nquick to demonstrate features of ",(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," without needing to deploy and host ",(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," yourself."))}u.isMDXComponent=!0}}]);

assets/js/bc747cac.0ba762cf.js

@@ -0,0 +1 @@
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[945],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>m});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?a(Object(n),!0).forEach((function(t){o(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):a(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,r,o=function(e,t){if(null==e)return{};var n,r,o={},a=Object.keys(e);for(r=0;r<a.length;r++)n=a[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r<a.length;r++)n=a[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var c=r.createContext({}),p=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},l=function(e){var t=p(e.components);return r.createElement(c.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),u=p(n),f=o,m=u["".concat(c,".").concat(f)]||u[f]||d[f]||a;return n?r.createElement(m,i(i({ref:t},l),{},{components:n})):r.createElement(m,i({ref:t},l))}));function m(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,i=new Array(a);i[0]=f;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[u]="string"==typeof e?e:o,i[1]=s;for(var p=2;p<a;p++)i[p]=n[p];return r.createElement.apply(null,i)}return r.createElement.apply(null,n)}f.displayName="MDXCreateElement"},3867:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>a,metadata:()=>s,toc:()=>p});var r=n(7462),o=(n(7294),n(3905));const a={sidebar_title:"Core Features",sidebar_position:25},i="Concepts",s={unversionedId:"concepts/index",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,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 with zrok",permalink:"/docs/getting-started"},next:{title:"Private Shares",permalink:"/docs/concepts/sharing-private"}},c={},p=[],l={toc:p};function u(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"concepts"},"Concepts"),(0,o.kt)("p",null,(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," was designed to make sharing local resources both secure and easy. In this section of the ",(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," documentation, we'll tour through all of the most important features."),(0,o.kt)("p",null,"Sharing with ",(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," can be either ",(0,o.kt)("a",{parentName:"p",href:"/docs/concepts/sharing-public"},(0,o.kt)("inlineCode",{parentName:"a"},"public"))," or ",(0,o.kt)("a",{parentName:"p",href:"/docs/concepts/sharing-private"},(0,o.kt)("inlineCode",{parentName:"a"},"private")),".\nNaturally, regular web-based resources can be shared but ",(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," also includes support for sharing raw ",(0,o.kt)("a",{parentName:"p",href:"/docs/concepts/tunnels"},"TCP")," and ",(0,o.kt)("a",{parentName:"p",href:"/docs/concepts/tunnels"},"UDP")," network connections, and also includes a ",(0,o.kt)("a",{parentName:"p",href:"/docs/concepts/files"},"website and file sharing")," feature."),(0,o.kt)("p",null,"Learn about ",(0,o.kt)("inlineCode",{parentName:"p"},"zrok")," ",(0,o.kt)("a",{parentName:"p",href:"/docs/concepts/hosting"},"hosting here"),", including instructions on how to ",(0,o.kt)("a",{parentName:"p",href:"/docs/guides/self-hosting/self_hosting_guide"},"install your own ",(0,o.kt)("inlineCode",{parentName:"a"},"zrok")," instance"),"."))}u.isMDXComponent=!0}}]);

assets/js/e6ffb4b4.23b860d7.js

@@ -1 +1 @@
-"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[848],{1408:e=>{e.exports=JSON.parse('{"title":"Self Hosting","slug":"/category/self-hosting","permalink":"/docs/category/self-hosting","navigation":{"previous":{"title":"Guides","permalink":"/docs/category/guides"},"next":{"title":"Linux VPS","permalink":"/docs/guides/self-hosting/v0.3_self_hosting_guide"}}}')}}]);
+"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[848],{1408:e=>{e.exports=JSON.parse('{"title":"Self Hosting","slug":"/category/self-hosting","permalink":"/docs/category/self-hosting","navigation":{"previous":{"title":"Guides","permalink":"/docs/category/guides"},"next":{"title":"Linux VPS","permalink":"/docs/guides/self-hosting/self_hosting_guide"}}}')}}]);

assets/js/runtime~main.8a473bbe.js

@@ -0,0 +1 @@
+(()=>{"use strict";var e,t,r,a,o,b={},f={};function c(e){var t=f[e];if(void 0!==t)return t.exports;var r=f[e]={id:e,loaded:!1,exports:{}};return b[e].call(r.exports,r,r.exports,c),r.loaded=!0,r.exports}c.m=b,c.c=f,e=[],c.O=(t,r,a,o)=>{if(!r){var b=1/0;for(i=0;i<e.length;i++){r=e[i][0],a=e[i][1],o=e[i][2];for(var f=!0,n=0;n<r.length;n++)(!1&o||b>=o)&&Object.keys(c.O).every((e=>c.O[e](r[n])))?r.splice(n--,1):(f=!1,o<b&&(b=o));if(f){e.splice(i--,1);var d=a();void 0!==d&&(t=d)}}return t}o=o||0;for(var i=e.length;i>0&&e[i-1][2]>o;i--)e[i]=e[i-1];e[i]=[r,a,o]},c.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return c.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,c.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);c.r(o);var b={};t=t||[null,r({}),r([]),r(r)];for(var f=2&a&&e;"object"==typeof f&&!~t.indexOf(f);f=r(f))Object.getOwnPropertyNames(f).forEach((t=>b[t]=()=>e[t]));return b.default=()=>e,c.d(o,b),o},c.d=(e,t)=>{for(var r in t)c.o(t,r)&&!c.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},c.f={},c.e=e=>Promise.all(Object.keys(c.f).reduce(((t,r)=>(c.f[r](e,t),t)),[])),c.u=e=>"assets/js/"+({22:"0654c903",53:"935f2afb",55:"613b9d03",76:"2e812224",161:"04b79425",176:"6272ba0e",195:"c4f5d8e4",196:"bbbe662c",198:"50ef9c44",212:"8ae7f3b1",218:"8d0344ba",318:"8ef4b25e",360:"34e1d3b9",364:"60d45520",402:"5b30ef33",514:"1be78505",542:"7b87748c",711:"9a9d4214",732:"c015c796",817:"14eb3368",828:"48230885",838:"75b20590",848:"e6ffb4b4",889:"339d500a",905:"07d0b302",918:"17896441",920:"1a4e3797",945:"bc747cac",964:"f5020ab1",992:"f2348458"}[e]||e)+"."+{22:"c12cbc94",53:"8d0169ed",55:"70520b78",76:"f1e4de88",161:"740c756e",176:"80ce924b",195:"6798201d",196:"b5867e23",198:"d7719acf",212:"0cb2d38d",218:"b4e0ea48",318:"6f4db50f",360:"cbef2106",364:"b80527ca",402:"58e5f77e",514:"0c24f0b7",542:"178bbe40",711:"1eaae2f3",732:"67d24e4e",780:"64f5d662",817:"a0c98557",828:"5b9dfec1",838:"da313344",848:"23b860d7",889:"f0aa2810",894:"e787cecf",905:"cb0d3b7a",918:"9f5d97a4",920:"f76be9ed",945:"0ba762cf",964:"b9410de0",969:"ba5129f7",972:"dc0f5947",992:"e27de763"}[e]+".js",c.miniCssF=e=>{},c.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),c.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="website:",c.l=(e,t,r,b)=>{if(a[e])a[e].push(t);else{var f,n;if(void 0!==r)for(var d=document.getElementsByTagName("script"),i=0;i<d.length;i++){var u=d[i];if(u.getAttribute("src")==e||u.getAttribute("data-webpack")==o+r){f=u;break}}f||(n=!0,(f=document.createElement("script")).charset="utf-8",f.timeout=120,c.nc&&f.setAttribute("nonce",c.nc),f.setAttribute("data-webpack",o+r),f.src=e),a[e]=[t];var l=(t,r)=>{f.onerror=f.onload=null,clearTimeout(s);var o=a[e];if(delete a[e],f.parentNode&&f.parentNode.removeChild(f),o&&o.forEach((e=>e(r))),t)return t(r)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=l.bind(null,f.onerror),f.onload=l.bind(null,f.onload),n&&document.head.appendChild(f)}},c.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},c.p="/",c.gca=function(e){return e={17896441:"918",48230885:"828","0654c903":"22","935f2afb":"53","613b9d03":"55","2e812224":"76","04b79425":"161","6272ba0e":"176",c4f5d8e4:"195",bbbe662c:"196","50ef9c44":"198","8ae7f3b1":"212","8d0344ba":"218","8ef4b25e":"318","34e1d3b9":"360","60d45520":"364","5b30ef33":"402","1be78505":"514","7b87748c":"542","9a9d4214":"711",c015c796:"732","14eb3368":"817","75b20590":"838",e6ffb4b4:"848","339d500a":"889","07d0b302":"905","1a4e3797":"920",bc747cac:"945",f5020ab1:"964",f2348458:"992"}[e]||e,c.p+c.u(e)},(()=>{var e={303:0,532:0};c.f.j=(t,r)=>{var a=c.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var b=c.p+c.u(t),f=new Error;c.l(b,(r=>{if(c.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),b=r&&r.target&&r.target.src;f.message="Loading chunk "+t+" failed.\n("+o+": "+b+")",f.name="ChunkLoadError",f.type=o,f.request=b,a[1](f)}}),"chunk-"+t,t)}},c.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,b=r[0],f=r[1],n=r[2],d=0;if(b.some((t=>0!==e[t]))){for(a in f)c.o(f,a)&&(c.m[a]=f[a]);if(n)var i=n(c)}for(t&&t(r);d<b.length;d++)o=b[d],c.o(e,o)&&e[o]&&e[o][0](),e[o]=0;return c.O(i)},r=self.webpackChunkwebsite=self.webpackChunkwebsite||[];r.forEach(t.bind(null,0)),r.push=t.bind(null,r.push.bind(r))})()})();

assets/js/runtime~main.fb396183.js

@@ -1 +0,0 @@
-(()=>{"use strict";var e,t,r,a,o,f={},n={};function d(e){var t=n[e];if(void 0!==t)return t.exports;var r=n[e]={id:e,loaded:!1,exports:{}};return f[e].call(r.exports,r,r.exports,d),r.loaded=!0,r.exports}d.m=f,d.c=n,e=[],d.O=(t,r,a,o)=>{if(!r){var f=1/0;for(c=0;c<e.length;c++){r=e[c][0],a=e[c][1],o=e[c][2];for(var n=!0,b=0;b<r.length;b++)(!1&o||f>=o)&&Object.keys(d.O).every((e=>d.O[e](r[b])))?r.splice(b--,1):(n=!1,o<f&&(f=o));if(n){e.splice(c--,1);var i=a();void 0!==i&&(t=i)}}return t}o=o||0;for(var c=e.length;c>0&&e[c-1][2]>o;c--)e[c]=e[c-1];e[c]=[r,a,o]},d.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return d.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,d.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);d.r(o);var f={};t=t||[null,r({}),r([]),r(r)];for(var n=2&a&&e;"object"==typeof n&&!~t.indexOf(n);n=r(n))Object.getOwnPropertyNames(n).forEach((t=>f[t]=()=>e[t]));return f.default=()=>e,d.d(o,f),o},d.d=(e,t)=>{for(var r in t)d.o(t,r)&&!d.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},d.f={},d.e=e=>Promise.all(Object.keys(d.f).reduce(((t,r)=>(d.f[r](e,t),t)),[])),d.u=e=>"assets/js/"+({53:"935f2afb",55:"613b9d03",111:"64b9aff8",136:"a3dd9b5a",161:"04b79425",170:"b6820cd7",195:"c4f5d8e4",212:"8ae7f3b1",218:"8d0344ba",307:"8bf77064",364:"60d45520",402:"5b30ef33",448:"90940d5c",504:"764398ff",514:"1be78505",596:"b18788c3",608:"54de778e",653:"0e530a5b",711:"9a9d4214",731:"a88ab1d1",809:"d7b2321f",817:"14eb3368",848:"e6ffb4b4",918:"17896441",920:"1a4e3797"}[e]||e)+"."+{53:"26dab26d",55:"70520b78",111:"a7afac61",136:"d896d2e0",161:"8ab1c175",170:"8e817633",195:"6798201d",212:"b111f187",218:"4fd6b201",307:"da95d7f7",364:"b80527ca",402:"63ba8dea",448:"dc7349e0",504:"365513fe",514:"0c24f0b7",596:"229109b3",608:"b8482a9a",653:"c5c264dd",711:"1eaae2f3",731:"5a08a257",780:"64f5d662",809:"93c3cdd4",817:"a0c98557",848:"79a63f78",894:"e787cecf",918:"9f5d97a4",920:"f76be9ed",945:"c9ff869e",972:"dc0f5947"}[e]+".js",d.miniCssF=e=>{},d.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),d.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="website:",d.l=(e,t,r,f)=>{if(a[e])a[e].push(t);else{var n,b;if(void 0!==r)for(var i=document.getElementsByTagName("script"),c=0;c<i.length;c++){var u=i[c];if(u.getAttribute("src")==e||u.getAttribute("data-webpack")==o+r){n=u;break}}n||(b=!0,(n=document.createElement("script")).charset="utf-8",n.timeout=120,d.nc&&n.setAttribute("nonce",d.nc),n.setAttribute("data-webpack",o+r),n.src=e),a[e]=[t];var l=(t,r)=>{n.onerror=n.onload=null,clearTimeout(s);var o=a[e];if(delete a[e],n.parentNode&&n.parentNode.removeChild(n),o&&o.forEach((e=>e(r))),t)return t(r)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:n}),12e4);n.onerror=l.bind(null,n.onerror),n.onload=l.bind(null,n.onload),b&&document.head.appendChild(n)}},d.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},d.p="/",d.gca=function(e){return e={17896441:"918","935f2afb":"53","613b9d03":"55","64b9aff8":"111",a3dd9b5a:"136","04b79425":"161",b6820cd7:"170",c4f5d8e4:"195","8ae7f3b1":"212","8d0344ba":"218","8bf77064":"307","60d45520":"364","5b30ef33":"402","90940d5c":"448","764398ff":"504","1be78505":"514",b18788c3:"596","54de778e":"608","0e530a5b":"653","9a9d4214":"711",a88ab1d1:"731",d7b2321f:"809","14eb3368":"817",e6ffb4b4:"848","1a4e3797":"920"}[e]||e,d.p+d.u(e)},(()=>{var e={303:0,532:0};d.f.j=(t,r)=>{var a=d.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var f=d.p+d.u(t),n=new Error;d.l(f,(r=>{if(d.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),f=r&&r.target&&r.target.src;n.message="Loading chunk "+t+" failed.\n("+o+": "+f+")",n.name="ChunkLoadError",n.type=o,n.request=f,a[1](n)}}),"chunk-"+t,t)}},d.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,f=r[0],n=r[1],b=r[2],i=0;if(f.some((t=>0!==e[t]))){for(a in n)d.o(n,a)&&(d.m[a]=n[a]);if(b)var c=b(d)}for(t&&t(r);i<f.length;i++)o=f[i],d.o(e,o)&&e[o]&&e[o][0](),e[o]=0;return d.O(c)},r=self.webpackChunkwebsite=self.webpackChunkwebsite||[];r.forEach(t.bind(null,0)),r.push=t.bind(null,r.push.bind(r))})()})();