diff --git a/404.html b/404.html index 9437a23a..1ab7cf77 100644 --- a/404.html +++ b/404.html @@ -10,7 +10,7 @@ - +
diff --git a/assets/js/5cd0a723.89693635.js b/assets/js/5cd0a723.868ecbba.js similarity index 67% rename from assets/js/5cd0a723.89693635.js rename to assets/js/5cd0a723.868ecbba.js index 25ef2345..2cfd3eda 100644 --- a/assets/js/5cd0a723.89693635.js +++ b/assets/js/5cd0a723.868ecbba.js @@ -1 +1 @@ -"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[993],{2121:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=o(5893),s=o(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"}},a={},d=[];function l(e){const n={admonition:"admonition",code:"code",em:"em",p:"p",pre:"pre",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.admonition,{type:"note",children:(0,t.jsxs)(n.p,{children:["This guide is relevant if you are self-hosting or using a friend's ",(0,t.jsx)(n.code,{children:"zrok"})," instance instead of using zrok-as-a-service from ",(0,t.jsx)(n.code,{children:"zrok.io"}),"."]})}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"zrok"})," ",(0,t.jsx)(n.em,{children:"command"})," on your omputer uses a ",(0,t.jsx)(n.code,{children:"zrok"})," ",(0,t.jsx)(n.em,{children:"instance"})," over the network."]}),"\n",(0,t.jsxs)(n.p,{children:["The default instance API endpoint for the ",(0,t.jsx)(n.code,{children:"zrok"})," command is ",(0,t.jsx)(n.code,{children:"api.zrok.io"}),". Set the API endpoint to another instance's API endpoint:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:"zrok config set apiEndpoint https://zrok.example.com\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-buttonless",metastring:'title="Output"',children:"[WARNING]: unable to open environment metadata; ignoring\n\nzrok configuration updated\n"})}),"\n",(0,t.jsx)(n.admonition,{type:"note",children:(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"WARNING"})," about ",(0,t.jsx)(n.code,{children:"environment metadata"})," is expected when you run ",(0,t.jsx)(n.code,{children:"zrok config set"})," before ",(0,t.jsx)(n.code,{children:"zrok enable"}),"."]})}),"\n",(0,t.jsxs)(n.p,{children:["You can use the ",(0,t.jsx)(n.code,{children:"zrok status"})," command to inspect the state of your local ",(0,t.jsx)(n.em,{children:"environment"}),". ",(0,t.jsx)(n.code,{children:"zrok"})," refers to each shell where you install and ",(0,t.jsx)(n.code,{children:"enable"})," a copy of ",(0,t.jsx)(n.code,{children:"zrok"})," as as an ",(0,t.jsx)(n.em,{children:"environment"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:"zrok status\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"zrok status"})," command shows the configured API service that your environment is using, as well as the ",(0,t.jsx)(n.code,{children:"SOURCE"})," where the setting was retrieved. In this case, ",(0,t.jsx)(n.code,{children:"config"})," means that the setting was set into the environment using the ",(0,t.jsx)(n.code,{children:"zrok config"})," command."]})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},1151:(e,n,o)=>{o.d(n,{Z:()=>c,a:()=>r});var t=o(7294);const s={},i=t.createContext(s);function r(e){const n=t.useContext(i);return t.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),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[993],{2121:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>d});var t=o(5893),s=o(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"}},a={},d=[];function l(e){const n={admonition:"admonition",code:"code",em:"em",p:"p",pre:"pre",...(0,s.a)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.admonition,{type:"note",children:(0,t.jsxs)(n.p,{children:["This guide is relevant if you are self-hosting or using a friend's ",(0,t.jsx)(n.code,{children:"zrok"})," instance instead of using zrok-as-a-service from ",(0,t.jsx)(n.code,{children:"zrok.io"}),"."]})}),"\n",(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"zrok"})," ",(0,t.jsx)(n.em,{children:"command"})," on your omputer uses a ",(0,t.jsx)(n.code,{children:"zrok"})," ",(0,t.jsx)(n.em,{children:"instance"})," over the network."]}),"\n",(0,t.jsxs)(n.p,{children:["The default instance API endpoint for the ",(0,t.jsx)(n.code,{children:"zrok"})," command is ",(0,t.jsx)(n.code,{children:"api.zrok.io"}),". Set the API endpoint to another instance's API endpoint:"]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:"zrok config set apiEndpoint https://zrok.example.com\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-buttonless",metastring:'title="Output"',children:"[WARNING]: unable to open environment metadata; ignoring\n\nzrok configuration updated\n"})}),"\n",(0,t.jsx)(n.admonition,{type:"note",children:(0,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"WARNING"})," about ",(0,t.jsx)(n.code,{children:"environment metadata"})," is expected when you run ",(0,t.jsx)(n.code,{children:"zrok config set"})," before ",(0,t.jsx)(n.code,{children:"zrok enable"}),"."]})}),"\n",(0,t.jsxs)(n.p,{children:["You can use the ",(0,t.jsx)(n.code,{children:"zrok status"})," command to inspect the state of your local ",(0,t.jsx)(n.em,{children:"environment"}),". ",(0,t.jsx)(n.code,{children:"zrok"})," refers to each shell where you install and ",(0,t.jsx)(n.code,{children:"enable"})," a copy of ",(0,t.jsx)(n.code,{children:"zrok"})," as an ",(0,t.jsx)(n.em,{children:"environment"}),"."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-text",children:"zrok status\n"})}),"\n",(0,t.jsx)(n.pre,{children:(0,t.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,t.jsxs)(n.p,{children:["The ",(0,t.jsx)(n.code,{children:"zrok status"})," command shows the configured API service that your environment is using, as well as the ",(0,t.jsx)(n.code,{children:"SOURCE"})," where the setting was retrieved. In this case, ",(0,t.jsx)(n.code,{children:"config"})," means that the setting was set into the environment using the ",(0,t.jsx)(n.code,{children:"zrok config"})," command."]})]})}function h(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},1151:(e,n,o)=>{o.d(n,{Z:()=>c,a:()=>r});var t=o(7294);const s={},i=t.createContext(s);function r(e){const n=t.useContext(i);return t.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),t.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.fa5814dd.js b/assets/js/runtime~main.def6bf3e.js similarity index 97% rename from assets/js/runtime~main.fa5814dd.js rename to assets/js/runtime~main.def6bf3e.js index 72f56102..4de6c47e 100644 --- a/assets/js/runtime~main.fa5814dd.js +++ b/assets/js/runtime~main.def6bf3e.js @@ -1 +1 @@ -(()=>{"use strict";var e,t,a,r,b,f={},d={};function o(e){var t=d[e];if(void 0!==t)return t.exports;var a=d[e]={id:e,loaded:!1,exports:{}};return f[e].call(a.exports,a,a.exports,o),a.loaded=!0,a.exports}o.m=f,o.c=d,o.amdO={},e=[],o.O=(t,a,r,b)=>{if(!a){var f=1/0;for(i=0;izrok config set apiEndpoint https://zrok.example.com
The WARNING
about environment metadata
is expected when you run zrok config set
before zrok enable
.
You can use the zrok status
command to inspect the state of your local environment. zrok
refers to each shell where you install and enable
a copy of zrok
as as an environment.
You can use the zrok status
command to inspect the state of your local environment. zrok
refers to each shell where you install and enable
a copy of zrok
as an environment.
zrok status
The zrok status
command shows the configured API service that your environment is using, as well as the SOURCE
where the setting was retrieved. In this case, config
means that the setting was set into the environment using the zrok config
command.