[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs:\u002Fdocs\u002Fget-started\u002Fsetup-wizard":3,"docs:nav":347,"docs:surround:\u002Fdocs\u002Fget-started\u002Fsetup-wizard":555},{"id":4,"title":5,"body":6,"description":337,"extension":338,"launchGate":339,"meta":340,"navigation":341,"path":342,"seo":343,"stem":344,"stub":345,"__hash__":346},"docs_en\u002Fdocs\u002F1.get-started\u002F4.setup-wizard.md","The setup wizard",{"type":7,"value":8,"toc":325},"minimark",[9,13,18,31,45,52,58,62,77,80,232,236,239,242,245,266,274,278,302,305],[10,11,12],"p",{},"A new installation has no accounts. The setup wizard makes you its first operator, then walks you through what the installation needs before anyone else uses it: how it sends mail, who may sign up, and its licence.",[14,15,17],"h2",{"id":16},"_1-claim-the-installation","1. Claim the installation",[10,19,20,21,25,26,30],{},"Open the address the installer showed, such as ",[22,23,24],"code",{},"https:\u002F\u002F10.0.0.5\u002F",". You see ",[27,28,29],"strong",{},"Claim this instance",".",[32,33,34,42],"ol",{},[35,36,37,38,41],"li",{},"Enter the ",[27,39,40],{},"setup token"," from the installer’s finish screen.",[35,43,44],{},"Enter your own email address and a password. This makes you the first operator.",[10,46,47,48,51],{},"Lost the token? Read it again on the server, as root at its console or over SSH: ",[22,49,50],{},"runuser -u velrix -- env VELRIX_ROOT=\u002Fvar\u002Flib\u002Fvelrix\u002Fbundle velrix setup-token",". Wrong tokens are counted per address, and after too many that address is refused for an hour.",[10,53,54,57],{},[27,55,56],{},"A second step for operators."," Under the default security profile, an operator with no second step can only add one at sign-in: a passkey, or an authenticator app. Nothing else opens until one is added; then ten recovery codes are shown once. Passkeys need the realm on a domain name, not an IP address. Your claim signs you in; you are asked at your next sign-in.",[14,59,61],{"id":60},"_2-go-through-the-steps","2. Go through the steps",[10,63,64,65,68,69,72,73,76],{},"After you claim it, the wizard fills the screen until every required step is done. The rail on the left lists the steps in groups, with a tick for each one done and a dot for each one required. Use ",[27,66,67],{},"Next"," and ",[27,70,71],{},"Back"," to move, and ",[27,74,75],{},"Skip"," for an optional step.",[10,78,79],{},"The steps come from the modules your installation runs, so yours may differ a little from this list.",[81,82,83,99],"table",{},[84,85,86],"thead",{},[87,88,89,93,96],"tr",{},[90,91,92],"th",{},"Group",[90,94,95],{},"Step",[90,97,98],{},"Required",[100,101,102,117,129,143,155,167,181,194,207,220],"tbody",{},[87,103,104,108,114],{},[105,106,107],"td",{},"Realm",[105,109,110,113],{},[27,111,112],{},"Name and colour"," of the realm, and whether it is a new realm or joins another",[105,115,116],{},"No",[87,118,119,121,127],{},[105,120,107],{},[105,122,123,126],{},[27,124,125],{},"How do your servers boot?"," Where each new server starts: local disk or diskless",[105,128,116],{},[87,130,131,134,140],{},[105,132,133],{},"Access",[105,135,136,139],{},[27,137,138],{},"First operator",": you, already done",[105,141,142],{},"Yes",[87,144,145,147,153],{},[105,146,133],{},[105,148,149,152],{},[27,150,151],{},"Who may sign up",": nobody, invited people only, or people with an address at your domains",[105,154,142],{},[87,156,157,159,165],{},[105,158,133],{},[105,160,161,164],{},[27,162,163],{},"Sign-in methods",": add single sign-on through your identity provider (OpenID Connect or SAML)",[105,166,116],{},[87,168,169,172,178],{},[105,170,171],{},"Mail",[105,173,174,177],{},[27,175,176],{},"How mail leaves",": your SMTP server, its port, user, password and sender address. Send a test mail to finish the step",[105,179,180],{},"When sign-up sends mail",[87,182,183,186,192],{},[105,184,185],{},"Company",[105,187,188,191],{},[27,189,190],{},"The company that invoices",", if this installation bills anyone",[105,193,116],{},[87,195,196,199,204],{},[105,197,198],{},"Licence",[105,200,201,203],{},[27,202,198],{},": paste the licence we sent you, connect to Velrix Public Cloud and pay as you go, or use monthly files offline",[105,205,206],{},"When your installation needs one",[87,208,209,212,218],{},[105,210,211],{},"Look",[105,213,214,217],{},[27,215,216],{},"Brand colour and wallpaper"," of the desktop",[105,219,116],{},[87,221,222,225,230],{},[105,223,224],{},"More",[105,226,227],{},[27,228,229],{},"Default language and time zone",[105,231,116],{},[233,234,171],"h3",{"id":235},"mail",[10,237,238],{},"Velrix sends mail to verify addresses, invite people and reset passwords, so it needs a way out. The step is required while sign-up sends mail (open sign-up, invitations or your domains); a realm where nobody may sign up can skip it. Enter your SMTP server and send a test mail. The step is done once the test mail went through. The password is stored sealed and never shown again. Velrix refuses to send a password to a server without encryption.",[233,240,198],{"id":241},"licence",[10,243,244],{},"You have three ways to licence an installation:",[246,247,248,254,260],"ul",{},[35,249,250,253],{},[27,251,252],{},"Paste a licence."," For a fixed term: it runs to its end date, and nothing is sent anywhere.",[35,255,256,259],{},[27,257,258],{},"Connect to Velrix Public Cloud"," and pay as you go. Compare the fingerprint shown with the one we gave you, approve the link, and paste the licence. Usage reports then go every hour on their own, with totals only: no people, no names.",[35,261,262,265],{},[27,263,264],{},"Offline, with monthly files."," Install the licence the same way, without a link. At the start of each month, export the usage file, send it to us, and import the receipt we send back.",[10,267,268,269,30],{},"A licence problem never stops your workloads. See ",[270,271,273],"a",{"href":272},"\u002Fdocs\u002Foperators\u002Flicensing","Licensing",[14,275,277],{"id":276},"_3-finish","3. Finish",[10,279,280,281,284,285,288,289,293,294,297,298,301],{},"When every required step is done, ",[27,282,283],{},"Finish"," closes the wizard and opens the desktop. To come back to the optional steps later, open ",[27,286,287],{},"Set up this instance"," in the Manager. The Manager lists its tools in groups down the side; press ",[290,291],"kbd",{"value":292},"\u002F"," or ",[290,295],{"value":296},"Ctrl"," ",[290,299],{"value":300},"F"," to filter them.",[14,303,67],{"id":304},"next",[246,306,307,313,319],{},[35,308,309],{},[270,310,312],{"href":311},"\u002Fdocs\u002Fget-started\u002Ffirst-app","Deploy your first app",[35,314,315],{},[270,316,318],{"href":317},"\u002Fdocs\u002Fget-started\u002Ffirst-vm","Create your first VM",[35,320,321],{},[270,322,324],{"href":323},"\u002Fdocs\u002Fget-started\u002Finstall#adding-more-servers","Add more servers",{"title":326,"searchDepth":327,"depth":328,"links":329},"",2,3,[330,331,335,336],{"id":16,"depth":327,"text":17},{"id":60,"depth":327,"text":61,"children":332},[333,334],{"id":235,"depth":328,"text":171},{"id":241,"depth":328,"text":198},{"id":276,"depth":327,"text":277},{"id":304,"depth":327,"text":67},"Claim your new installation with its setup token, become its first operator, and set the few things it needs before anyone else signs in.","md",null,{},true,"\u002Fdocs\u002Fget-started\u002Fsetup-wizard",{"title":5,"description":337},"docs\u002F1.get-started\u002F4.setup-wizard",false,"6JRilCEhaCdrisHfArWJfTZrhxpq2wgn7OMFvoXos28",[348],{"title":349,"path":350,"stem":351,"children":352,"page":-1},"Docs","\u002Fdocs","docs",[353,357,382,409,443,512,526,548],{"title":354,"path":350,"stem":355,"stub":345,"launchGate":339,"icon":356},"Overview","docs\u002Findex","i-lucide-house",{"title":358,"stub":345,"launchGate":339,"icon":359,"path":360,"stem":361,"children":362,"page":345},"Get started","i-lucide-rocket","\u002Fdocs\u002Fget-started","docs\u002F1.get-started",[363,367,371,375,376,379],{"title":364,"path":365,"stem":366,"stub":345,"launchGate":339},"What Velrix is","\u002Fdocs\u002Fget-started\u002Fwhat-is-velrix","docs\u002F1.get-started\u002F1.what-is-velrix",{"title":368,"path":369,"stem":370,"stub":345,"launchGate":339},"Ways to run Velrix","\u002Fdocs\u002Fget-started\u002Fways-to-run","docs\u002F1.get-started\u002F2.ways-to-run",{"title":372,"path":373,"stem":374,"stub":345,"launchGate":339},"Install from USB","\u002Fdocs\u002Fget-started\u002Finstall","docs\u002F1.get-started\u002F3.install",{"title":5,"path":342,"stem":344,"stub":345,"launchGate":339},{"title":377,"path":311,"stem":378,"stub":345,"launchGate":339},"Your first app","docs\u002F1.get-started\u002F5.first-app",{"title":380,"path":317,"stem":381,"stub":345,"launchGate":339},"Your first VM","docs\u002F1.get-started\u002F6.first-vm",{"title":383,"stub":345,"launchGate":339,"icon":384,"path":385,"stem":386,"children":387,"page":345},"Concepts","i-lucide-lightbulb","\u002Fdocs\u002Fconcepts","docs\u002F2.concepts",[388,392,396,400,404],{"title":389,"path":390,"stem":391,"stub":341,"launchGate":339},"Realms","\u002Fdocs\u002Fconcepts\u002Frealms","docs\u002F2.concepts\u002F1.realms",{"title":393,"path":394,"stem":395,"stub":341,"launchGate":339},"Instances and hosts","\u002Fdocs\u002Fconcepts\u002Finstances-and-hosts","docs\u002F2.concepts\u002F2.instances-and-hosts",{"title":397,"path":398,"stem":399,"stub":341,"launchGate":339},"Modules and the mesh","\u002Fdocs\u002Fconcepts\u002Fmodules-and-the-mesh","docs\u002F2.concepts\u002F3.modules-and-the-mesh",{"title":401,"path":402,"stem":403,"stub":341,"launchGate":339},"Organisations, projects and permissions","\u002Fdocs\u002Fconcepts\u002Forgs-projects-permissions","docs\u002F2.concepts\u002F4.orgs-projects-permissions",{"title":405,"path":406,"stem":407,"stub":341,"launchGate":408},"Host pools","\u002Fdocs\u002Fconcepts\u002Fhost-pools","docs\u002F2.concepts\u002F5.host-pools","A1",{"title":410,"stub":345,"launchGate":339,"icon":411,"path":412,"stem":413,"children":414,"page":345},"Guides for users","i-lucide-book-open","\u002Fdocs\u002Fguides","docs\u002F3.guides",[415,419,423,427,431,435,439],{"title":416,"path":417,"stem":418,"stub":345,"launchGate":339},"Apps","\u002Fdocs\u002Fguides\u002Fapps","docs\u002F3.guides\u002F1.apps",{"title":420,"path":421,"stem":422,"stub":341,"launchGate":339},"Machines","\u002Fdocs\u002Fguides\u002Fmachines","docs\u002F3.guides\u002F2.machines",{"title":424,"path":425,"stem":426,"stub":341,"launchGate":339},"Volumes","\u002Fdocs\u002Fguides\u002Fvolumes","docs\u002F3.guides\u002F3.volumes",{"title":428,"path":429,"stem":430,"stub":345,"launchGate":339},"Stacks","\u002Fdocs\u002Fguides\u002Fstacks","docs\u002F3.guides\u002F4.stacks",{"title":432,"path":433,"stem":434,"stub":341,"launchGate":339},"Terminal and cloud shells","\u002Fdocs\u002Fguides\u002Fterminal","docs\u002F3.guides\u002F5.terminal",{"title":436,"path":437,"stem":438,"stub":345,"launchGate":339},"Registry","\u002Fdocs\u002Fguides\u002Fregistry","docs\u002F3.guides\u002F6.registry",{"title":440,"path":441,"stem":442,"stub":341,"launchGate":339},"Kubernetes","\u002Fdocs\u002Fguides\u002Fkubernetes","docs\u002F3.guides\u002F7.kubernetes",{"title":444,"stub":345,"launchGate":339,"icon":445,"path":446,"stem":447,"children":448,"page":345},"Guides for operators","i-lucide-server-cog","\u002Fdocs\u002Foperators","docs\u002F4.operators",[449,453,457,461,465,469,473,477,481,485,490,494,496,500,504,508],{"title":450,"path":451,"stem":452,"stub":345,"launchGate":339},"Updates and maintenance windows","\u002Fdocs\u002Foperators\u002Fupdates","docs\u002F4.operators\u002F1.updates",{"title":454,"path":455,"stem":456,"stub":345,"launchGate":339},"Migrate: moving VMs from VMware","\u002Fdocs\u002Foperators\u002Fmigrate","docs\u002F4.operators\u002F10.migrate",{"title":458,"path":459,"stem":460,"stub":345,"launchGate":339},"Hardware","\u002Fdocs\u002Foperators\u002Fhardware","docs\u002F4.operators\u002F11.hardware",{"title":462,"path":463,"stem":464,"stub":345,"launchGate":339},"Billing","\u002Fdocs\u002Foperators\u002Fbilling","docs\u002F4.operators\u002F12.billing",{"title":466,"path":467,"stem":468,"stub":345,"launchGate":339},"Policies","\u002Fdocs\u002Foperators\u002Fpolicies","docs\u002F4.operators\u002F13.policies",{"title":470,"path":471,"stem":472,"stub":345,"launchGate":339},"Running the realm","\u002Fdocs\u002Foperators\u002Frealm-ops","docs\u002F4.operators\u002F14.realm-ops",{"title":474,"path":475,"stem":476,"stub":345,"launchGate":339},"Public address and app hostnames","\u002Fdocs\u002Foperators\u002Fpublic-address","docs\u002F4.operators\u002F15.public-address",{"title":478,"path":479,"stem":480,"stub":345,"launchGate":339},"Library","\u002Fdocs\u002Foperators\u002Flibrary","docs\u002F4.operators\u002F16.library",{"title":482,"path":483,"stem":484,"stub":345,"launchGate":339},"Backups","\u002Fdocs\u002Foperators\u002Fbackups","docs\u002F4.operators\u002F2.backups",{"title":486,"path":487,"stem":488,"stub":341,"launchGate":489},"Availability and drain","\u002Fdocs\u002Foperators\u002Favailability","docs\u002F4.operators\u002F3.availability","A1, A2, A3",{"title":491,"path":492,"stem":493,"stub":341,"launchGate":339},"Federation","\u002Fdocs\u002Foperators\u002Ffederation","docs\u002F4.operators\u002F4.federation",{"title":273,"path":272,"stem":495,"stub":341,"launchGate":339},"docs\u002F4.operators\u002F5.licensing",{"title":497,"path":498,"stem":499,"stub":341,"launchGate":339},"Branding: look and design","\u002Fdocs\u002Foperators\u002Fbranding","docs\u002F4.operators\u002F6.branding",{"title":501,"path":502,"stem":503,"stub":341,"launchGate":339},"Connectivity","\u002Fdocs\u002Foperators\u002Fconnectivity","docs\u002F4.operators\u002F7.connectivity",{"title":505,"path":506,"stem":507,"stub":341,"launchGate":339},"Logs","\u002Fdocs\u002Foperators\u002Flogs","docs\u002F4.operators\u002F8.logs",{"title":509,"path":510,"stem":511,"stub":345,"launchGate":339},"Directory sync: Entra ID and Okta","\u002Fdocs\u002Foperators\u002Fdirectory-sync","docs\u002F4.operators\u002F9.directory-sync",{"title":513,"stub":345,"launchGate":339,"icon":514,"path":515,"stem":516,"children":517,"page":345},"Reference","i-lucide-library","\u002Fdocs\u002Freference","docs\u002F5.reference",[518,522],{"title":519,"path":520,"stem":521,"stub":345,"launchGate":339},"The API reference in your realm","\u002Fdocs\u002Freference\u002Fin-your-realm","docs\u002F5.reference\u002F1.in-your-realm",{"title":523,"path":524,"stem":525,"stub":345,"launchGate":339},"The velrix command","\u002Fdocs\u002Freference\u002Fcli","docs\u002F5.reference\u002F2.cli",{"title":527,"stub":345,"launchGate":339,"icon":528,"path":529,"stem":530,"children":531,"page":345},"Security and compliance","i-lucide-shield-check","\u002Fdocs\u002Fsecurity","docs\u002F6.security",[532,536,540,544],{"title":533,"path":534,"stem":535,"stub":341,"launchGate":339},"Post-quantum","\u002Fdocs\u002Fsecurity\u002Fpost-quantum","docs\u002F6.security\u002F1.post-quantum",{"title":537,"path":538,"stem":539,"stub":341,"launchGate":339},"GDPR","\u002Fdocs\u002Fsecurity\u002Fgdpr","docs\u002F6.security\u002F2.gdpr",{"title":541,"path":542,"stem":543,"stub":341,"launchGate":339},"NIS2 support","\u002Fdocs\u002Fsecurity\u002Fnis2","docs\u002F6.security\u002F3.nis2",{"title":545,"path":546,"stem":547,"stub":341,"launchGate":339},"Data residency","\u002Fdocs\u002Fsecurity\u002Fdata-residency","docs\u002F6.security\u002F4.data-residency",{"title":549,"path":550,"stem":551,"children":552,"stub":345,"launchGate":339,"icon":554},"Release notes","\u002Fdocs\u002Frelease-notes","docs\u002F7.release-notes\u002Findex",[553],{"title":549,"path":550,"stem":551,"stub":345,"launchGate":339},"i-lucide-scroll-text",[556,558],{"title":372,"path":373,"stem":374,"description":557,"children":-1},"Turn an empty server into the first server of a new Velrix installation, with its realm key kept offline in your safe.",{"title":377,"path":311,"stem":378,"description":559,"children":-1},"Deploy a container from an image, watch it start, read its logs, give it a health check and a disk."]