zrok/assets/js/4f1777fd.3839c0bb.js
2024-09-26 20:13:22 +00:00

1 line
5.3 KiB
JavaScript

"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[8375],{7042:(e,s,i)=>{i.r(s),i.d(s,{assets:()=>l,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>c,toc:()=>a});var n=i(5893),t=i(1151);const o={title:"Invitations"},r=void 0,c={id:"guides/self-hosting/self-service-invite",title:"Invitations",description:"This is how to set up self-service invitations for your users to get an account on your self-hosted zrok instance.",source:"@site/../docs/guides/self-hosting/self-service-invite.mdx",sourceDirName:"guides/self-hosting",slug:"/guides/self-hosting/self-service-invite",permalink:"/docs/guides/self-hosting/self-service-invite",draft:!1,unlisted:!1,editUrl:"https://github.com/openziti/zrok/blob/main/docs/../docs/guides/self-hosting/self-service-invite.mdx",tags:[],version:"current",frontMatter:{title:"Invitations"},sidebar:"tutorialSidebar",previous:{title:"Instance Config",permalink:"/docs/guides/self-hosting/instance-configuration"},next:{title:"The Drives CLI",permalink:"/docs/guides/drives/cli"}},l={},a=[{value:"Overview",id:"overview",level:2},{value:"The Self-Service User Experience",id:"the-self-service-user-experience",level:2},{value:"How it Works",id:"how-it-works",level:2}];function d(e){const s={code:"code",em:"em",h2:"h2",img:"img",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(s.p,{children:"This is how to set up self-service invitations for your users to get an account on your self-hosted zrok instance."}),"\n",(0,n.jsx)(s.h2,{id:"overview",children:"Overview"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsxs)(s.li,{children:["You can create user accounts directly with the ",(0,n.jsx)(s.code,{children:"zrok admin"})," CLI or API."]}),"\n",(0,n.jsx)(s.li,{children:"You can welcome users to invite themselves via email."}),"\n",(0,n.jsx)(s.li,{children:"You can generate invitation tokens if you want to restrict self-service invitations."}),"\n",(0,n.jsx)(s.li,{children:"To enable self-service invitations you must also configure the controller to send email."}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"the-self-service-user-experience",children:"The Self-Service User Experience"}),"\n",(0,n.jsx)(s.p,{children:"This is what your users will do."}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-bash",children:"zrok invite\n"})}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-buttonless",metastring:'title="Output"',children:"enter and confirm your email address...\n\n> user@domain.com\n> user@domain.com\n\n[ Submit ]\n\ninvitation sent to 'user@domain.com'!\n"})}),"\n",(0,n.jsx)(s.h2,{id:"how-it-works",children:"How it Works"}),"\n",(0,n.jsxs)(s.p,{children:["The ",(0,n.jsx)(s.code,{children:"zrok invite"})," command presents a small form that allows you to enter (and then confirm) your email address. Tabbing to the ",(0,n.jsx)(s.code,{children:"[ Submit ]"})," button will start the invitation process."]}),"\n",(0,n.jsxs)(s.p,{children:["Next, check the email where you sent the invite. You should receive a message asking you to click a link to create your ",(0,n.jsx)(s.code,{children:"zrok"})," account. When you click that link, you will be brought to a web page that will allow you to set a password for your new account."]}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.img,{alt:"Enter a Password",src:i(9744).Z+"",width:"1791",height:"1362"})}),"\n",(0,n.jsxs)(s.p,{children:["Enter a password and its confirmation, and click the ",(0,n.jsx)(s.code,{children:"Register Account"})," button. You'll see the following:"]}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.img,{alt:"Successful Registration",src:i(242).Z+"",width:"1791",height:"1369"})}),"\n",(0,n.jsxs)(s.p,{children:['For now, we\'ll ignore the "enable your shell for zrok" section. Just click the ',(0,n.jsx)(s.code,{children:"zrok web portal"})," link:"]}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.img,{alt:"Web Login",src:i(9509).Z+"",width:"1791",height:"1362"})}),"\n",(0,n.jsxs)(s.p,{children:["After clicking the ",(0,n.jsx)(s.code,{children:"Log In"})," button, you'll be brought into the ",(0,n.jsx)(s.code,{children:"zrok"})," ",(0,n.jsx)(s.em,{children:"web console"}),":"]}),"\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.img,{alt:"Web Console; Empty",src:i(2945).Z+"",width:"1791",height:"1362"})}),"\n",(0,n.jsxs)(s.p,{children:["Congratulations! Your ",(0,n.jsx)(s.code,{children:"zrok"})," account is ready to go!"]})]})}function h(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}},242:(e,s,i)=>{i.d(s,{Z:()=>n});const n=i.p+"assets/images/zrok_registration_success-05e7e328284f6dc38cd993322698d38b.png"},9744:(e,s,i)=>{i.d(s,{Z:()=>n});const n=i.p+"assets/images/zrok_verify-22a26d401b9a77a4278f3c0f54d2a981.png"},2945:(e,s,i)=>{i.d(s,{Z:()=>n});const n=i.p+"assets/images/zrok_web_console_empty-cce147eaf8e7bc83abe556336a4aea98.png"},9509:(e,s,i)=>{i.d(s,{Z:()=>n});const n=i.p+"assets/images/zrok_web_login-a6161cc79e66932fab76994bdfb8f9c1.png"},1151:(e,s,i)=>{i.d(s,{Z:()=>c,a:()=>r});var n=i(7294);const t={},o=n.createContext(t);function r(e){const s=n.useContext(o);return n.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(t):e.components||t:r(e.components),n.createElement(o.Provider,{value:s},e.children)}}}]);