zrok/assets/js/4f1777fd.9644a82a.js

"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[277],{7513:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>r,metadata:()=>i,toc:()=>a});const i=JSON.parse('{"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":false,"unlisted":false,"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":"Drives","permalink":"/docs/guides/drives"}}');var t=n(4848),o=n(8453);const r={title:"Invitations"},c=void 0,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,o.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.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,t.jsx)(s.h2,{id:"overview",children:"Overview"}),"\n",(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsxs)(s.li,{children:["You can create user accounts directly with the ",(0,t.jsx)(s.code,{children:"zrok admin"})," CLI or API."]}),"\n",(0,t.jsx)(s.li,{children:"You can welcome users to invite themselves via email."}),"\n",(0,t.jsx)(s.li,{children:"You can generate invitation tokens if you want to restrict self-service invitations."}),"\n",(0,t.jsx)(s.li,{children:"To enable self-service invitations you must also configure the controller to send email."}),"\n"]}),"\n",(0,t.jsx)(s.h2,{id:"the-self-service-user-experience",children:"The Self-Service User Experience"}),"\n",(0,t.jsx)(s.p,{children:"This is what your users will do."}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-bash",children:"zrok invite\n"})}),"\n",(0,t.jsx)(s.pre,{children:(0,t.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,t.jsx)(s.h2,{id:"how-it-works",children:"How it Works"}),"\n",(0,t.jsxs)(s.p,{children:["The ",(0,t.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,t.jsx)(s.code,{children:"[ Submit ]"})," button will start the invitation process."]}),"\n",(0,t.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,t.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,t.jsx)(s.p,{children:(0,t.jsx)(s.img,{alt:"Enter a Password",src:n(8083).A+"",width:"1791",height:"1362"})}),"\n",(0,t.jsxs)(s.p,{children:["Enter a password and its confirmation, and click the ",(0,t.jsx)(s.code,{children:"Register Account"})," button. You'll see the following:"]}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.img,{alt:"Successful Registration",src:n(4159).A+"",width:"1791",height:"1369"})}),"\n",(0,t.jsxs)(s.p,{children:['For now, we\'ll ignore the "enable your shell for zrok" section. Just click the ',(0,t.jsx)(s.code,{children:"zrok web portal"})," link:"]}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.img,{alt:"Web Login",src:n(6658).A+"",width:"1791",height:"1362"})}),"\n",(0,t.jsxs)(s.p,{children:["After clicking the ",(0,t.jsx)(s.code,{children:"Log In"})," button, you'll be brought into the ",(0,t.jsx)(s.code,{children:"zrok"})," ",(0,t.jsx)(s.em,{children:"web console"}),":"]}),"\n",(0,t.jsx)(s.p,{children:(0,t.jsx)(s.img,{alt:"Web Console; Empty",src:n(3824).A+"",width:"1791",height:"1362"})}),"\n",(0,t.jsxs)(s.p,{children:["Congratulations! Your ",(0,t.jsx)(s.code,{children:"zrok"})," account is ready to go!"]})]})}function h(e={}){const{wrapper:s}={...(0,o.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},4159:(e,s,n)=>{n.d(s,{A:()=>i});const i=n.p+"assets/images/zrok_registration_success-05e7e328284f6dc38cd993322698d38b.png"},8083:(e,s,n)=>{n.d(s,{A:()=>i});const i=n.p+"assets/images/zrok_verify-22a26d401b9a77a4278f3c0f54d2a981.png"},3824:(e,s,n)=>{n.d(s,{A:()=>i});const i=n.p+"assets/images/zrok_web_console_empty-cce147eaf8e7bc83abe556336a4aea98.png"},6658:(e,s,n)=>{n.d(s,{A:()=>i});const i=n.p+"assets/images/zrok_web_login-a6161cc79e66932fab76994bdfb8f9c1.png"},8453:(e,s,n)=>{n.d(s,{R:()=>r,x:()=>c});var i=n(6540);const t={},o=i.createContext(t);function r(e){const s=i.useContext(o);return i.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),i.createElement(o.Provider,{value:s},e.children)}}}]);