[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs:\u002Fdocs\u002Fget-started\u002Fwhat-is-velrix":3,"docs:nav":234,"docs:surround:\u002Fdocs\u002Fget-started\u002Fwhat-is-velrix":437},{"id":4,"title":5,"body":6,"description":224,"extension":225,"launchGate":226,"meta":227,"navigation":228,"path":229,"seo":230,"stem":231,"stub":232,"__hash__":233},"docs_en\u002Fdocs\u002F1.get-started\u002F1.what-is-velrix.md","What Velrix is",{"type":7,"value":8,"toc":214},"minimark",[9,13,16,21,61,64,68,91,95,174,181,185,188,196,200],[10,11,12],"p",{},"Velrix is a cloud platform. You use it to run virtual machines, including Windows Server, alongside containers and Kubernetes. It runs on your own servers, in your own environment operated by us, or in Velrix Public Cloud in Sweden.",[10,14,15],{},"You work in it from a browser. Velrix opens as a desktop with windowed apps: Apps, Machines, Volumes, Files, a Terminal and more. Everything you can do there, you can also do from the HTTP API, OpenTofu or Terraform, Ansible, or an AI agent over MCP.",[17,18,20],"h2",{"id":19},"what-you-can-run","What you can run",[22,23,24,32,38,49,55],"ul",{},[25,26,27,31],"li",{},[28,29,30],"strong",{},"Virtual machines",", Linux and Windows Server, on Cloud Hypervisor. You open a machine’s console or its desktop in a browser window.",[25,33,34,37],{},[28,35,36],{},"Containers",", as apps. Each app runs rootless, keeps the size you gave it, and is rolled back on its own when a new revision fails its health check. Where operators require it, an app runs sandboxed: the same image in a microVM with its own kernel.",[25,39,40,43,44,48],{},[28,41,42],{},"Kubernetes",": managed RKE2 or k3s clusters on your machines, and a Kubernetes-compatible API for ",[45,46,47],"code",{},"kubectl",".",[25,50,51,54],{},[28,52,53],{},"Build jobs",", in microVMs by default.",[25,56,57,60],{},[28,58,59],{},"Stacks",": OpenTofu and Ansible runs with plan, approval and apply, with their state kept in Velrix.",[10,62,63],{},"Around them you get volumes with enforced sizes, project networks with security groups, hostnames with certificates for your apps, an image registry, metrics, and a desktop in your own brand and language. Every screen is in Swedish and English.",[17,65,67],{"id":66},"who-uses-it","Who uses it",[22,69,70,76,82],{},[25,71,72,75],{},[28,73,74],{},"People"," sign in and run things: apps, machines, volumes, stacks. Their work belongs to them or to an organisation they are a member of.",[25,77,78,81],{},[28,79,80],{},"Organisations"," group people, with roles that say who may do what, and projects that keep work apart.",[25,83,84,87,88,48],{},[28,85,86],{},"Operators"," run the installation itself: its servers, updates, licence, look, and who may sign up. They work in the ",[28,89,90],{},"Manager",[17,92,94],{"id":93},"the-words-you-will-meet","The words you will meet",[96,97,98,111],"table",{},[99,100,101],"thead",{},[102,103,104,108],"tr",{},[105,106,107],"th",{},"Word",[105,109,110],{},"Meaning",[112,113,114,123,142,150,158,166],"tbody",{},[102,115,116,120],{},[117,118,119],"td",{},"Realm",[117,121,122],{},"One Velrix installation: everything that trusts the same realm key.",[102,124,125,128],{},[117,126,127],{},"Instance",[117,129,130,131,134,135,134,138,141],{},"One server of a realm. Instances are named ",[45,132,133],{},"a",", ",[45,136,137],{},"b",[45,139,140],{},"c"," and so on.",[102,143,144,147],{},[117,145,146],{},"Module",[117,148,149],{},"One part of the platform, such as apps, machines or sign-in. Each is a small program in its own container.",[102,151,152,155],{},[117,153,154],{},"Organisation",[117,156,157],{},"A group of people with roles, who own resources together.",[102,159,160,163],{},[117,161,162],{},"Project",[117,164,165],{},"A part of an organisation’s (or your own) resources, with its own network.",[102,167,168,171],{},[117,169,170],{},"Catalogue",[117,172,173],{},"The sizes and blueprints your operator offers: what you can make, and how big.",[10,175,176,180],{},[133,177,179],{"href":178},"\u002Fdocs\u002Fconcepts\u002Frealms","Concepts"," explains each of these in more depth.",[17,182,184],{"id":183},"how-it-is-built","How it is built",[10,186,187],{},"Velrix is a set of modules that find each other on their own and talk directly, with no central control plane between them. When one module stops, the others keep running while it is restarted, and operators are told. You choose which modules an installation runs, so a small installation stays small.",[10,189,190,191,195],{},"Every connection between modules uses post-quantum key exchange, and every module proves who it is with an identity signed by your realm key. ",[133,192,194],{"href":193},"\u002Fdocs\u002Fsecurity\u002Fpost-quantum","Security and compliance"," has the details.",[17,197,199],{"id":198},"next","Next",[22,201,202,208],{},[25,203,204],{},[133,205,207],{"href":206},"\u002Fdocs\u002Fget-started\u002Fways-to-run","Ways to run Velrix",[25,209,210],{},[133,211,213],{"href":212},"\u002Fdocs\u002Fget-started\u002Finstall","Install from the USB stick",{"title":215,"searchDepth":216,"depth":217,"links":218},"",2,3,[219,220,221,222,223],{"id":19,"depth":216,"text":20},{"id":66,"depth":216,"text":67},{"id":93,"depth":216,"text":94},{"id":183,"depth":216,"text":184},{"id":198,"depth":216,"text":199},"A cloud platform for virtual machines, containers and Kubernetes that you run on your own servers or use in Velrix Public Cloud.","md",null,{},true,"\u002Fdocs\u002Fget-started\u002Fwhat-is-velrix",{"title":5,"description":224},"docs\u002F1.get-started\u002F1.what-is-velrix",false,"pWaCQ_eMl3vD9IX4ncrxTC8gvVsJIXH4K3mG7GwmZr8",[235],{"title":236,"path":237,"stem":238,"children":239,"page":-1},"Docs","\u002Fdocs","docs",[240,244,268,293,325,396,410,430],{"title":241,"path":237,"stem":242,"stub":232,"launchGate":226,"icon":243},"Overview","docs\u002Findex","i-lucide-house",{"title":245,"stub":232,"launchGate":226,"icon":246,"path":247,"stem":248,"children":249,"page":232},"Get started","i-lucide-rocket","\u002Fdocs\u002Fget-started","docs\u002F1.get-started",[250,251,253,256,260,264],{"title":5,"path":229,"stem":231,"stub":232,"launchGate":226},{"title":207,"path":206,"stem":252,"stub":232,"launchGate":226},"docs\u002F1.get-started\u002F2.ways-to-run",{"title":254,"path":212,"stem":255,"stub":232,"launchGate":226},"Install from USB","docs\u002F1.get-started\u002F3.install",{"title":257,"path":258,"stem":259,"stub":232,"launchGate":226},"The setup wizard","\u002Fdocs\u002Fget-started\u002Fsetup-wizard","docs\u002F1.get-started\u002F4.setup-wizard",{"title":261,"path":262,"stem":263,"stub":232,"launchGate":226},"Your first app","\u002Fdocs\u002Fget-started\u002Ffirst-app","docs\u002F1.get-started\u002F5.first-app",{"title":265,"path":266,"stem":267,"stub":232,"launchGate":226},"Your first VM","\u002Fdocs\u002Fget-started\u002Ffirst-vm","docs\u002F1.get-started\u002F6.first-vm",{"title":179,"stub":232,"launchGate":226,"icon":269,"path":270,"stem":271,"children":272,"page":232},"i-lucide-lightbulb","\u002Fdocs\u002Fconcepts","docs\u002F2.concepts",[273,276,280,284,288],{"title":274,"path":178,"stem":275,"stub":228,"launchGate":226},"Realms","docs\u002F2.concepts\u002F1.realms",{"title":277,"path":278,"stem":279,"stub":228,"launchGate":226},"Instances and hosts","\u002Fdocs\u002Fconcepts\u002Finstances-and-hosts","docs\u002F2.concepts\u002F2.instances-and-hosts",{"title":281,"path":282,"stem":283,"stub":228,"launchGate":226},"Modules and the mesh","\u002Fdocs\u002Fconcepts\u002Fmodules-and-the-mesh","docs\u002F2.concepts\u002F3.modules-and-the-mesh",{"title":285,"path":286,"stem":287,"stub":228,"launchGate":226},"Organisations, projects and permissions","\u002Fdocs\u002Fconcepts\u002Forgs-projects-permissions","docs\u002F2.concepts\u002F4.orgs-projects-permissions",{"title":289,"path":290,"stem":291,"stub":228,"launchGate":292},"Host pools","\u002Fdocs\u002Fconcepts\u002Fhost-pools","docs\u002F2.concepts\u002F5.host-pools","A1",{"title":294,"stub":232,"launchGate":226,"icon":295,"path":296,"stem":297,"children":298,"page":232},"Guides for users","i-lucide-book-open","\u002Fdocs\u002Fguides","docs\u002F3.guides",[299,303,307,311,314,318,322],{"title":300,"path":301,"stem":302,"stub":232,"launchGate":226},"Apps","\u002Fdocs\u002Fguides\u002Fapps","docs\u002F3.guides\u002F1.apps",{"title":304,"path":305,"stem":306,"stub":228,"launchGate":226},"Machines","\u002Fdocs\u002Fguides\u002Fmachines","docs\u002F3.guides\u002F2.machines",{"title":308,"path":309,"stem":310,"stub":228,"launchGate":226},"Volumes","\u002Fdocs\u002Fguides\u002Fvolumes","docs\u002F3.guides\u002F3.volumes",{"title":59,"path":312,"stem":313,"stub":232,"launchGate":226},"\u002Fdocs\u002Fguides\u002Fstacks","docs\u002F3.guides\u002F4.stacks",{"title":315,"path":316,"stem":317,"stub":228,"launchGate":226},"Terminal and cloud shells","\u002Fdocs\u002Fguides\u002Fterminal","docs\u002F3.guides\u002F5.terminal",{"title":319,"path":320,"stem":321,"stub":232,"launchGate":226},"Registry","\u002Fdocs\u002Fguides\u002Fregistry","docs\u002F3.guides\u002F6.registry",{"title":42,"path":323,"stem":324,"stub":228,"launchGate":226},"\u002Fdocs\u002Fguides\u002Fkubernetes","docs\u002F3.guides\u002F7.kubernetes",{"title":326,"stub":232,"launchGate":226,"icon":327,"path":328,"stem":329,"children":330,"page":232},"Guides for operators","i-lucide-server-cog","\u002Fdocs\u002Foperators","docs\u002F4.operators",[331,335,339,343,347,351,355,359,363,367,372,376,380,384,388,392],{"title":332,"path":333,"stem":334,"stub":232,"launchGate":226},"Updates and maintenance windows","\u002Fdocs\u002Foperators\u002Fupdates","docs\u002F4.operators\u002F1.updates",{"title":336,"path":337,"stem":338,"stub":232,"launchGate":226},"Migrate: moving VMs from VMware","\u002Fdocs\u002Foperators\u002Fmigrate","docs\u002F4.operators\u002F10.migrate",{"title":340,"path":341,"stem":342,"stub":232,"launchGate":226},"Hardware","\u002Fdocs\u002Foperators\u002Fhardware","docs\u002F4.operators\u002F11.hardware",{"title":344,"path":345,"stem":346,"stub":232,"launchGate":226},"Billing","\u002Fdocs\u002Foperators\u002Fbilling","docs\u002F4.operators\u002F12.billing",{"title":348,"path":349,"stem":350,"stub":232,"launchGate":226},"Policies","\u002Fdocs\u002Foperators\u002Fpolicies","docs\u002F4.operators\u002F13.policies",{"title":352,"path":353,"stem":354,"stub":232,"launchGate":226},"Running the realm","\u002Fdocs\u002Foperators\u002Frealm-ops","docs\u002F4.operators\u002F14.realm-ops",{"title":356,"path":357,"stem":358,"stub":232,"launchGate":226},"Public address and app hostnames","\u002Fdocs\u002Foperators\u002Fpublic-address","docs\u002F4.operators\u002F15.public-address",{"title":360,"path":361,"stem":362,"stub":232,"launchGate":226},"Library","\u002Fdocs\u002Foperators\u002Flibrary","docs\u002F4.operators\u002F16.library",{"title":364,"path":365,"stem":366,"stub":232,"launchGate":226},"Backups","\u002Fdocs\u002Foperators\u002Fbackups","docs\u002F4.operators\u002F2.backups",{"title":368,"path":369,"stem":370,"stub":228,"launchGate":371},"Availability and drain","\u002Fdocs\u002Foperators\u002Favailability","docs\u002F4.operators\u002F3.availability","A1, A2, A3",{"title":373,"path":374,"stem":375,"stub":228,"launchGate":226},"Federation","\u002Fdocs\u002Foperators\u002Ffederation","docs\u002F4.operators\u002F4.federation",{"title":377,"path":378,"stem":379,"stub":228,"launchGate":226},"Licensing","\u002Fdocs\u002Foperators\u002Flicensing","docs\u002F4.operators\u002F5.licensing",{"title":381,"path":382,"stem":383,"stub":228,"launchGate":226},"Branding: look and design","\u002Fdocs\u002Foperators\u002Fbranding","docs\u002F4.operators\u002F6.branding",{"title":385,"path":386,"stem":387,"stub":228,"launchGate":226},"Connectivity","\u002Fdocs\u002Foperators\u002Fconnectivity","docs\u002F4.operators\u002F7.connectivity",{"title":389,"path":390,"stem":391,"stub":228,"launchGate":226},"Logs","\u002Fdocs\u002Foperators\u002Flogs","docs\u002F4.operators\u002F8.logs",{"title":393,"path":394,"stem":395,"stub":232,"launchGate":226},"Directory sync: Entra ID and Okta","\u002Fdocs\u002Foperators\u002Fdirectory-sync","docs\u002F4.operators\u002F9.directory-sync",{"title":397,"stub":232,"launchGate":226,"icon":398,"path":399,"stem":400,"children":401,"page":232},"Reference","i-lucide-library","\u002Fdocs\u002Freference","docs\u002F5.reference",[402,406],{"title":403,"path":404,"stem":405,"stub":232,"launchGate":226},"The API reference in your realm","\u002Fdocs\u002Freference\u002Fin-your-realm","docs\u002F5.reference\u002F1.in-your-realm",{"title":407,"path":408,"stem":409,"stub":232,"launchGate":226},"The velrix command","\u002Fdocs\u002Freference\u002Fcli","docs\u002F5.reference\u002F2.cli",{"title":194,"stub":232,"launchGate":226,"icon":411,"path":412,"stem":413,"children":414,"page":232},"i-lucide-shield-check","\u002Fdocs\u002Fsecurity","docs\u002F6.security",[415,418,422,426],{"title":416,"path":193,"stem":417,"stub":228,"launchGate":226},"Post-quantum","docs\u002F6.security\u002F1.post-quantum",{"title":419,"path":420,"stem":421,"stub":228,"launchGate":226},"GDPR","\u002Fdocs\u002Fsecurity\u002Fgdpr","docs\u002F6.security\u002F2.gdpr",{"title":423,"path":424,"stem":425,"stub":228,"launchGate":226},"NIS2 support","\u002Fdocs\u002Fsecurity\u002Fnis2","docs\u002F6.security\u002F3.nis2",{"title":427,"path":428,"stem":429,"stub":228,"launchGate":226},"Data residency","\u002Fdocs\u002Fsecurity\u002Fdata-residency","docs\u002F6.security\u002F4.data-residency",{"title":431,"path":432,"stem":433,"children":434,"stub":232,"launchGate":226,"icon":436},"Release notes","\u002Fdocs\u002Frelease-notes","docs\u002F7.release-notes\u002Findex",[435],{"title":431,"path":432,"stem":433,"stub":232,"launchGate":226},"i-lucide-scroll-text",[438,440],{"title":241,"path":237,"stem":242,"description":439,"icon":243,"children":-1},"Install Velrix, run your first app and virtual machine, and operate the platform day to day.",{"title":207,"path":206,"stem":252,"description":441,"children":-1},"Installed or diskless on your own servers, Managed in your environment, or Velrix Public Cloud. The platform is the same in each."]