[{"data":1,"prerenderedAt":844},["ShallowReactive",2],{"docs-\u002Fdocs\u002Fproxmox":3,"docs-nav":803},{"id":4,"title":5,"body":6,"description":795,"extension":796,"group":797,"meta":798,"navigation":472,"path":799,"seo":800,"stem":801,"__hash__":802},"docs\u002Fdocs\u002F02.proxmox.md","Connect Proxmox",{"type":7,"value":8,"toc":783},"minimark",[9,13,17,22,38,82,93,96,141,144,149,152,173,176,182,186,197,201,208,245,249,258,263,266,270,355,358,380,383,387,390,618,634,645,648,664,689,699,703,717,735,739,776,779],[10,11,5],"h1",{"id":12},"connect-proxmox",[14,15,16],"p",{},"Each Nebla location is one Proxmox VE cluster or standalone node, reached through an API token. Nebla never uses SSH and leaves nothing running on the host. Setup runs once per cluster, in a root shell on any node. Proxmox VE 8 and 9 are supported.",[18,19,21],"h2",{"id":20},"one-line-setup","One-line setup",[14,23,24,25,29,30,33,34,37],{},"In the admin area, open ",[26,27,28],"strong",{},"Locations"," and choose ",[26,31,32],{},"Connect a location",". Enter a name and choose ",[26,35,36],{},"Get setup command",". The page shows one command:",[39,40,45],"pre",{"className":41,"code":42,"language":43,"meta":44,"style":44},"language-sh shiki shiki-themes github-light-high-contrast github-light-high-contrast github-dark-high-contrast","curl -fsSL 'https:\u002F\u002Fpanel.example.com\u002Fv1\u002Fenroll.sh' | NEBLA_TOKEN=nbe_... bash\n","sh","",[46,47,48],"code",{"__ignoreMap":44},[49,50,53,57,61,65,69,73,76,79],"span",{"class":51,"line":52},"line",1,[49,54,56],{"class":55},"szw1H","curl",[49,58,60],{"class":59},"ssYy9"," -fsSL",[49,62,64],{"class":63},"semJd"," 'https:\u002F\u002Fpanel.example.com\u002Fv1\u002Fenroll.sh'",[49,66,68],{"class":67},"sklAV"," |",[49,70,72],{"class":71},"s7iLA"," NEBLA_TOKEN",[49,74,75],{"class":67},"=",[49,77,78],{"class":63},"nbe_...",[49,80,81],{"class":55}," bash\n",[14,83,84,85,88,89,92],{},"Run it as root on any node of the cluster. The command works once and is valid for 30 minutes. Choose ",[26,86,87],{},"New command"," for another. You can read the script first at ",[46,90,91],{},"\u002Fv1\u002Fenroll.sh"," on your panel. It is plain text.",[14,94,95],{},"The script refuses to run without root or on anything other than Proxmox VE 8 or 9. It checks with the panel before it changes anything, then:",[97,98,99,111,118,131,138],"ul",{},[100,101,102,103,106,107,110],"li",{},"creates or resets the roles ",[46,104,105],{},"Nebla"," and ",[46,108,109],{},"NeblaISO"," with the exact privileges Nebla needs for your Proxmox version,",[100,112,113,114,117],{},"creates the user ",[46,115,116],{},"nebla@pve"," if it is missing,",[100,119,120,121,123,124,127,128,130],{},"grants ",[46,122,105],{}," on ",[46,125,126],{},"\u002F",", and ",[46,129,109],{}," on every storage that holds ISOs, imports or disk images,",[100,132,133,134,137],{},"creates a new API token named ",[46,135,136],{},"nebla@pve!nebla-\u003Clocation>-\u003C6 chars>",", with privilege separation off,",[100,139,140],{},"reports the token, the certificate fingerprint of every node, and the cluster's storages back to the panel.",[14,142,143],{},"It writes no files. A re-run resets both roles to the exact privilege list, so privileges you added to them by hand are removed.",[145,146,148],"h3",{"id":147},"finish-in-the-panel","Finish in the panel",[14,150,151],{},"The enrollment page picks up the report. You then have 24 hours to finish. Choose:",[97,153,154,157,164,167,170],{},[100,155,156],{},"the Proxmox URL, prefilled from the node's IP on port 8006,",[100,158,159,160,163],{},"the disk storage for server disks (one with ",[46,161,162],{},"images"," content),",[100,165,166],{},"the ISO storage for Nebla's cloud-init seed ISOs,",[100,168,169],{},"optionally an import storage, which turns on built-in OS images (Proxmox VE 8.4 or later),",[100,171,172],{},"optionally a volume storage. Left empty, volumes go to each node's disk storage.",[14,174,175],{},"Nebla connects to the URL, checks that the certificate it sees is one the node reported, and pins it.",[14,177,178,179,181],{},"The script granted ",[46,180,109],{}," on every candidate storage because it didn't know which ones you would pick. After you finish, the page lists optional commands that remove it from the storages the location doesn't use.",[145,183,185],{"id":184},"if-the-node-cant-reach-the-panel","If the node can't reach the panel",[14,187,188,189,192,193,196],{},"Open ",[26,190,191],{},"The node can't reach this panel?"," on the enrollment page. It gives a script that makes no network calls. Run it on the node. It prints one line that starts with ",[46,194,195],{},"nebla-enroll:v1:",". Paste that line into the page. The line contains the token secret, so clear your terminal scrollback afterwards. The online script prints the same line when it can't send its report.",[145,198,200],{"id":199},"run-setup-again","Run setup again",[14,202,203,204,207],{},"Use ",[26,205,206],{},"Re-run setup"," on the location page after a certificate renewal, or to rotate the token. The old token keeps working until you finish. The location then switches to the new token and fingerprints, and the page shows the command that removes the old token:",[39,209,211],{"className":41,"code":210,"language":43,"meta":44,"style":44},"pveum user token remove nebla@pve \u003Cold token>\n",[46,212,213],{"__ignoreMap":44},[49,214,215,218,221,224,227,230,233,236,239,242],{"class":51,"line":52},[49,216,217],{"class":55},"pveum",[49,219,220],{"class":63}," user",[49,222,223],{"class":63}," token",[49,225,226],{"class":63}," remove",[49,228,229],{"class":63}," nebla@pve",[49,231,232],{"class":67}," \u003C",[49,234,235],{"class":63},"old",[49,237,238],{"class":63}," toke",[49,240,241],{"class":71},"n",[49,243,244],{"class":67},">\n",[18,246,248],{"id":247},"turn-on-the-datacenter-firewall","Turn on the datacenter firewall",[14,250,251,252,257],{},"Nebla turns on the VM firewall for every server, with IP and MAC filtering so a server can't use addresses it wasn't given. User ",[253,254,256],"a",{"href":255},"\u002Fdocs\u002Ffirewalls","firewalls"," also live in each VM's firewall rules. Proxmox only applies any of this when the firewall is on at the datacenter level:",[14,259,260],{},[26,261,262],{},"Datacenter > Firewall > Options > Firewall: Yes",[14,264,265],{},"Datacenter rules govern traffic to the Proxmox hosts, not to the VMs. Before you turn it on, check that those rules still allow your own SSH and web UI access on port 8006. The location page warns while the datacenter firewall is off.",[18,267,269],{"id":268},"storages","Storages",[271,272,273,289],"table",{},[274,275,276],"thead",{},[277,278,279,283,286],"tr",{},[280,281,282],"th",{},"Storage",[280,284,285],{},"Content type",[280,287,288],{},"Used for",[290,291,292,309,326,339],"tbody",{},[277,293,294,298,302],{},[295,296,297],"td",{},"Disk storage",[295,299,300],{},[46,301,162],{},[295,303,304,305,308],{},"Server disks, for example ",[46,306,307],{},"local-lvm",", a ZFS pool or Ceph RBD.",[277,310,311,314,319],{},[295,312,313],{},"ISO storage",[295,315,316],{},[46,317,318],{},"iso",[295,320,321,322,325],{},"The small cloud-init seed ISO Nebla uploads for each server, for example ",[46,323,324],{},"local",".",[277,327,328,331,336],{},[295,329,330],{},"Import storage",[295,332,333],{},[46,334,335],{},"import",[295,337,338],{},"Downloads for built-in OS images. Optional, needs Proxmox VE 8.4 or later.",[277,340,341,344,348],{},[295,342,343],{},"Volume storage",[295,345,346],{},[46,347,162],{},[295,349,350,354],{},[253,351,353],{"href":352},"\u002Fdocs\u002Fvolumes","Volumes",". Optional, defaults to each node's disk storage.",[14,356,357],{},"To add a content type to an existing directory storage, list the types it already has plus the new one:",[39,359,361],{"className":41,"code":360,"language":43,"meta":44,"style":44},"pvesm set local --content iso,vztmpl,backup,import\n",[46,362,363],{"__ignoreMap":44},[49,364,365,368,371,374,377],{"class":51,"line":52},[49,366,367],{"class":55},"pvesm",[49,369,370],{"class":63}," set",[49,372,373],{"class":63}," local",[49,375,376],{"class":59}," --content",[49,378,379],{"class":63}," iso,vztmpl,backup,import\n",[14,381,382],{},"Built-in OS images also need outbound HTTPS from each node to the image's download site, and from the panel to look up the newest image and its checksum.",[18,384,386],{"id":385},"manual-setup","Manual setup",[14,388,389],{},"Use this if you can't run the setup script. In a root shell on any node:",[39,391,393],{"className":41,"code":392,"language":43,"meta":44,"style":44},"# Proxmox VE 9. On VE 8, replace VM.GuestAgent.Audit with VM.Monitor.\npveum role add Nebla --privs \"VM.Allocate VM.Clone VM.Config.CDROM VM.Config.CPU VM.Config.Disk VM.Config.Memory VM.Config.Network VM.Config.Options VM.Config.Cloudinit VM.PowerMgmt VM.Console VM.Audit VM.GuestAgent.Audit Datastore.AllocateSpace Datastore.AllocateTemplate Datastore.Audit Sys.Audit SDN.Use\"\n# Only for built-in OS images:\npveum role modify Nebla --append 1 --privs \"Sys.AccessNetwork VM.Config.HWType\"\npveum role add NeblaISO --privs \"Datastore.Allocate Datastore.AllocateSpace Datastore.AllocateTemplate Datastore.Audit\"\n\npveum user add nebla@pve --comment \"Nebla panel\"\npveum aclmod \u002F --users nebla@pve --roles Nebla\npveum aclmod \u002Fstorage\u002F\u003Ciso_storage> --users nebla@pve --roles NeblaISO\npveum aclmod \u002Fstorage\u002F\u003Cimport_storage> --users nebla@pve --roles NeblaISO\npveum aclmod \u002Fstorage\u002F\u003Cvolume_storage> --users nebla@pve --roles NeblaISO\npveum user token add nebla@pve panel --privsep 0\n",[46,394,395,401,421,427,450,467,474,491,513,544,570,596],{"__ignoreMap":44},[49,396,397],{"class":51,"line":52},[49,398,400],{"class":399},"sq92B","# Proxmox VE 9. On VE 8, replace VM.GuestAgent.Audit with VM.Monitor.\n",[49,402,404,406,409,412,415,418],{"class":51,"line":403},2,[49,405,217],{"class":55},[49,407,408],{"class":63}," role",[49,410,411],{"class":63}," add",[49,413,414],{"class":63}," Nebla",[49,416,417],{"class":59}," --privs",[49,419,420],{"class":63}," \"VM.Allocate VM.Clone VM.Config.CDROM VM.Config.CPU VM.Config.Disk VM.Config.Memory VM.Config.Network VM.Config.Options VM.Config.Cloudinit VM.PowerMgmt VM.Console VM.Audit VM.GuestAgent.Audit Datastore.AllocateSpace Datastore.AllocateTemplate Datastore.Audit Sys.Audit SDN.Use\"\n",[49,422,424],{"class":51,"line":423},3,[49,425,426],{"class":399},"# Only for built-in OS images:\n",[49,428,430,432,434,437,439,442,445,447],{"class":51,"line":429},4,[49,431,217],{"class":55},[49,433,408],{"class":63},[49,435,436],{"class":63}," modify",[49,438,414],{"class":63},[49,440,441],{"class":59}," --append",[49,443,444],{"class":59}," 1",[49,446,417],{"class":59},[49,448,449],{"class":63}," \"Sys.AccessNetwork VM.Config.HWType\"\n",[49,451,453,455,457,459,462,464],{"class":51,"line":452},5,[49,454,217],{"class":55},[49,456,408],{"class":63},[49,458,411],{"class":63},[49,460,461],{"class":63}," NeblaISO",[49,463,417],{"class":59},[49,465,466],{"class":63}," \"Datastore.Allocate Datastore.AllocateSpace Datastore.AllocateTemplate Datastore.Audit\"\n",[49,468,470],{"class":51,"line":469},6,[49,471,473],{"emptyLinePlaceholder":472},true,"\n",[49,475,477,479,481,483,485,488],{"class":51,"line":476},7,[49,478,217],{"class":55},[49,480,220],{"class":63},[49,482,411],{"class":63},[49,484,229],{"class":63},[49,486,487],{"class":59}," --comment",[49,489,490],{"class":63}," \"Nebla panel\"\n",[49,492,494,496,499,502,505,507,510],{"class":51,"line":493},8,[49,495,217],{"class":55},[49,497,498],{"class":63}," aclmod",[49,500,501],{"class":63}," \u002F",[49,503,504],{"class":59}," --users",[49,506,229],{"class":63},[49,508,509],{"class":59}," --roles",[49,511,512],{"class":63}," Nebla\n",[49,514,516,518,520,523,526,529,532,535,537,539,541],{"class":51,"line":515},9,[49,517,217],{"class":55},[49,519,498],{"class":63},[49,521,522],{"class":63}," \u002Fstorage\u002F",[49,524,525],{"class":67},"\u003C",[49,527,528],{"class":63},"iso_storag",[49,530,531],{"class":71},"e",[49,533,534],{"class":67},">",[49,536,504],{"class":59},[49,538,229],{"class":63},[49,540,509],{"class":59},[49,542,543],{"class":63}," NeblaISO\n",[49,545,547,549,551,553,555,558,560,562,564,566,568],{"class":51,"line":546},10,[49,548,217],{"class":55},[49,550,498],{"class":63},[49,552,522],{"class":63},[49,554,525],{"class":67},[49,556,557],{"class":63},"import_storag",[49,559,531],{"class":71},[49,561,534],{"class":67},[49,563,504],{"class":59},[49,565,229],{"class":63},[49,567,509],{"class":59},[49,569,543],{"class":63},[49,571,573,575,577,579,581,584,586,588,590,592,594],{"class":51,"line":572},11,[49,574,217],{"class":55},[49,576,498],{"class":63},[49,578,522],{"class":63},[49,580,525],{"class":67},[49,582,583],{"class":63},"volume_storag",[49,585,531],{"class":71},[49,587,534],{"class":67},[49,589,504],{"class":59},[49,591,229],{"class":63},[49,593,509],{"class":59},[49,595,543],{"class":63},[49,597,599,601,603,605,607,609,612,615],{"class":51,"line":598},12,[49,600,217],{"class":55},[49,602,220],{"class":63},[49,604,223],{"class":63},[49,606,411],{"class":63},[49,608,229],{"class":63},[49,610,611],{"class":63}," panel",[49,613,614],{"class":59}," --privsep",[49,616,617],{"class":59}," 0\n",[14,619,620,621,624,625,123,628,630,631,325],{},"Skip the image, import or volume lines for features you don't use. Proxmox versions without ",[46,622,623],{},"Sys.AccessNetwork"," need ",[46,626,627],{},"Sys.Modify",[46,629,126],{}," for built-in OS images instead. The last command prints the token secret once. The token ID is ",[46,632,633],{},"nebla@pve!panel",[14,635,636,638,639,642,643,325],{},[46,637,109],{}," carries ",[46,640,641],{},"Datastore.Allocate",", which Proxmox requires before it deletes an ISO or a volume. It also lets the token delete any other volume on that storage, so grant it only on the storages listed above, never on ",[46,644,126],{},[14,646,647],{},"Then read the TLS fingerprint of the node your location URL points at:",[39,649,651],{"className":41,"code":650,"language":43,"meta":44,"style":44},"pvenode cert info\n",[46,652,653],{"__ignoreMap":44},[49,654,655,658,661],{"class":51,"line":52},[49,656,657],{"class":55},"pvenode",[49,659,660],{"class":63}," cert",[49,662,663],{"class":63}," info\n",[14,665,666,667,670,671,674,675,678,679,681,682,685,686,688],{},"Use the fingerprint of the certificate ",[46,668,669],{},"pveproxy"," serves: ",[46,672,673],{},"pveproxy-ssl.pem"," if you uploaded one or use ACME, otherwise ",[46,676,677],{},"pve-ssl.pem",". In the panel, choose ",[26,680,32],{},", then ",[26,683,684],{},"Connect manually",", and enter the URL, token ID ",[46,687,633],{},", secret, fingerprint and storages.",[14,690,691,692,698],{},"The ",[253,693,697],{"href":694,"rel":695},"https:\u002F\u002Fgithub.com\u002Fnebla-cloud\u002Fnebla\u002Fblob\u002Fmain\u002Fdocs\u002Fproxmox-setup.md",[696],"nofollow","Proxmox setup reference"," explains every privilege and covers hand-built cloud-init templates.",[18,700,702],{"id":701},"what-nebla-touches","What Nebla touches",[14,704,705,706,106,709,712,713,716],{},"Nebla tags the VMs it creates ",[46,707,708],{},"nebla",[46,710,711],{},"nb-srv-\u003Cid>",", and the templates it builds from built-in OS images ",[46,714,715],{},"nebla-tpl",". It only ever changes VMs with one of those tags, so your existing VMs are left alone.",[97,718,719,722,728],{},[100,720,721],{},"Run one Nebla install per Proxmox cluster.",[100,723,724,725,727],{},"Before reinstalling Nebla with a fresh database, remove the VMs tagged ",[46,726,708],{},", because the new install reuses server IDs.",[100,729,730,731,734],{},"Never create a VM with ID 999999999. Nebla uses that ID as the owner of ",[253,732,733],{"href":352},"volume"," disks.",[18,736,738],{"id":737},"remove-nebla-from-proxmox","Remove Nebla from Proxmox",[39,740,742],{"className":41,"code":741,"language":43,"meta":44,"style":44},"pveum user delete nebla@pve\npveum role delete Nebla\npveum role delete NeblaISO\n",[46,743,744,756,766],{"__ignoreMap":44},[49,745,746,748,750,753],{"class":51,"line":52},[49,747,217],{"class":55},[49,749,220],{"class":63},[49,751,752],{"class":63}," delete",[49,754,755],{"class":63}," nebla@pve\n",[49,757,758,760,762,764],{"class":51,"line":403},[49,759,217],{"class":55},[49,761,408],{"class":63},[49,763,752],{"class":63},[49,765,512],{"class":63},[49,767,768,770,772,774],{"class":51,"line":423},[49,769,217],{"class":55},[49,771,408],{"class":63},[49,773,752],{"class":63},[49,775,543],{"class":63},[14,777,778],{},"Deleting the user removes its tokens and ACLs.",[780,781,782],"style",{},"html pre.shiki code .szw1H, html code.shiki .szw1H{--shiki-light:#702C00;--shiki-default:#702C00;--shiki-dark:#FFB757}html pre.shiki code .ssYy9, html code.shiki .ssYy9{--shiki-light:#023B95;--shiki-default:#023B95;--shiki-dark:#91CBFF}html pre.shiki code .semJd, html code.shiki .semJd{--shiki-light:#032563;--shiki-default:#032563;--shiki-dark:#ADDCFF}html pre.shiki code .sklAV, html code.shiki .sklAV{--shiki-light:#A0111F;--shiki-default:#A0111F;--shiki-dark:#FF9492}html pre.shiki code .s7iLA, html code.shiki .s7iLA{--shiki-light:#0E1116;--shiki-default:#0E1116;--shiki-dark:#F0F3F6}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sq92B, html code.shiki .sq92B{--shiki-light:#66707B;--shiki-default:#66707B;--shiki-dark:#BDC4CC}",{"title":44,"searchDepth":403,"depth":403,"links":784},[785,790,791,792,793,794],{"id":20,"depth":403,"text":21,"children":786},[787,788,789],{"id":147,"depth":423,"text":148},{"id":184,"depth":423,"text":185},{"id":199,"depth":423,"text":200},{"id":247,"depth":403,"text":248},{"id":268,"depth":403,"text":269},{"id":385,"depth":403,"text":386},{"id":701,"depth":403,"text":702},{"id":737,"depth":403,"text":738},"Connect a Proxmox VE cluster to Nebla with the one-line setup command, or by hand with a role, a user, an API token and a TLS fingerprint.","md","Get started",{},"\u002Fdocs\u002Fproxmox",{"title":5,"description":795},"docs\u002F02.proxmox","AbBbc3q7ol5a4WxIl66fHnpErDNkZwwNi0OyzkyoCss",[804,808,812,813,817,822,826,828,831,836,840],{"path":805,"title":806,"group":797,"stem":807},"\u002Fdocs","Overview","docs\u002F00.index",{"path":809,"title":810,"group":797,"stem":811},"\u002Fdocs\u002Finstall","Install","docs\u002F01.install",{"path":799,"title":5,"group":797,"stem":801},{"path":814,"title":815,"group":797,"stem":816},"\u002Fdocs\u002Fadmin","Set up the panel","docs\u002F03.admin",{"path":818,"title":819,"group":820,"stem":821},"\u002Fdocs\u002Fprojects","Projects and access","Use Nebla","docs\u002F04.projects",{"path":823,"title":824,"group":820,"stem":825},"\u002Fdocs\u002Fservers","Servers","docs\u002F05.servers",{"path":352,"title":353,"group":820,"stem":827},"docs\u002F06.volumes",{"path":255,"title":829,"group":820,"stem":830},"Firewalls","docs\u002F07.firewalls",{"path":832,"title":833,"group":834,"stem":835},"\u002Fdocs\u002Fcli","CLI","Reference","docs\u002F08.cli",{"path":837,"title":838,"group":834,"stem":839},"\u002Fdocs\u002Fapi","API","docs\u002F09.api",{"path":841,"title":842,"group":834,"stem":843},"\u002Fdocs\u002Ftroubleshooting","Troubleshooting","docs\u002F10.troubleshooting",1795243967228]