[{"data":1,"prerenderedAt":831},["ShallowReactive",2],{"page-\u002Finstall":3},{"id":4,"title":5,"body":6,"description":824,"extension":825,"meta":826,"navigation":133,"path":827,"seo":828,"stem":829,"__hash__":830},"pages\u002Finstall.md","Install Nebla",{"type":7,"value":8,"toc":816},"minimark",[9,13,17,35,40,43,80,91,95,102,541,547,592,595,635,641,644,674,682,686,689,693,696,719,723,739,748,777,781,805,812],[10,11,5],"h1",{"id":12},"install-nebla",[14,15,16],"p",{},"You need three things:",[18,19,20,24,27],"ul",{},[21,22,23],"li",{},"A Proxmox VE 8 or 9 node or cluster.",[21,25,26],{},"A Linux machine with Docker Compose that can reach the Proxmox API on port 8006. A small VM on the same host is enough.",[21,28,29,30,34],{},"A URL for the panel, such as ",[31,32,33],"code",{},"https:\u002F\u002Fpanel.example.com",".",[36,37,39],"h2",{"id":38},"_1-prepare-proxmox","1. Prepare Proxmox",[14,41,42],{},"Nebla talks to Proxmox only through its API. It never uses SSH and installs nothing on the host. Run these once per cluster, in a root shell on any node:",[18,44,45,60,67,74],{},[21,46,47,48,51,52,55,56,59],{},"Create the ",[31,49,50],{},"Nebla"," role on ",[31,53,54],{},"\u002F"," and the ",[31,57,58],{},"NeblaISO"," role on your ISO storage.",[21,61,62,63,66],{},"Create the user ",[31,64,65],{},"nebla@pve"," and give it both roles.",[21,68,69,70,73],{},"Create an API token with ",[31,71,72],{},"pveum user token add nebla@pve panel --privsep 0",", and keep the secret it prints.",[21,75,76,77,34],{},"Read the TLS fingerprint of the node you will connect to with ",[31,78,79],{},"pvenode cert info",[14,81,82,83,90],{},"The ",[84,85,89],"a",{"href":86,"rel":87},"https:\u002F\u002Fgithub.com\u002Fnebla-cloud\u002Fnebla\u002Fblob\u002Fmain\u002Fdocs\u002Fproxmox-setup.md",[88],"nofollow","Proxmox setup guide"," has the exact privilege lists for PVE 8 and 9, the storage requirements, and the firewall setting that tenant isolation needs.",[36,92,94],{"id":93},"_2-start-nebla","2. Start Nebla",[14,96,97,98,101],{},"Make a folder and save this as ",[31,99,100],{},"compose.yaml",":",[103,104,109],"pre",{"className":105,"code":106,"language":107,"meta":108,"style":108},"language-yaml shiki shiki-themes github-light-high-contrast github-light-high-contrast github-dark-high-contrast","name: nebla\n\nservices:\n  panel:\n    image: ghcr.io\u002Fnebla-cloud\u002Fnebla:latest\n    restart: unless-stopped\n    stop_grace_period: 75s\n    depends_on:\n      postgres:\n        condition: service_healthy\n    ports:\n      - \"${PANEL_PORT:-8080}:8080\"\n    environment:\n      PANEL_DATABASE_URL: postgres:\u002F\u002Fnebla:${POSTGRES_PASSWORD:?set POSTGRES_PASSWORD in .env}@postgres:5432\u002Fnebla?sslmode=disable\n      PANEL_LISTEN: \":8080\"\n      PANEL_BASE_URL: ${PANEL_BASE_URL:?set PANEL_BASE_URL in .env}\n      PANEL_SECRET_KEY: ${PANEL_SECRET_KEY:?set PANEL_SECRET_KEY in .env}\n      PANEL_SMTP_URL: ${PANEL_SMTP_URL:-}\n      PANEL_TRUSTED_PROXIES: ${PANEL_TRUSTED_PROXIES:-}\n    healthcheck:\n      test: [\"CMD\", \"\u002Fnebla-server\", \"healthcheck\"]\n      interval: 15s\n      timeout: 5s\n      start_period: 20s\n      retries: 3\n\n  postgres:\n    image: postgres:17\n    restart: unless-stopped\n    environment:\n      POSTGRES_DB: nebla\n      POSTGRES_USER: nebla\n      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:?set POSTGRES_PASSWORD in .env}\n    volumes:\n      - pgdata:\u002Fvar\u002Flib\u002Fpostgresql\u002Fdata\n    healthcheck:\n      test: [\"CMD-SHELL\", \"pg_isready -U nebla -d nebla\"]\n      interval: 5s\n      timeout: 5s\n      retries: 10\n\nvolumes:\n  pgdata:\n","yaml","",[31,110,111,128,135,144,152,163,174,185,193,201,212,220,229,237,248,259,270,281,292,303,311,337,348,359,370,382,387,395,405,414,421,431,441,452,460,468,475,492,501,510,520,525,533],{"__ignoreMap":108},[112,113,116,120,124],"span",{"class":114,"line":115},"line",1,[112,117,119],{"class":118},"sb7M8","name",[112,121,123],{"class":122},"s7iLA",": ",[112,125,127],{"class":126},"semJd","nebla\n",[112,129,131],{"class":114,"line":130},2,[112,132,134],{"emptyLinePlaceholder":133},true,"\n",[112,136,138,141],{"class":114,"line":137},3,[112,139,140],{"class":118},"services",[112,142,143],{"class":122},":\n",[112,145,147,150],{"class":114,"line":146},4,[112,148,149],{"class":118},"  panel",[112,151,143],{"class":122},[112,153,155,158,160],{"class":114,"line":154},5,[112,156,157],{"class":118},"    image",[112,159,123],{"class":122},[112,161,162],{"class":126},"ghcr.io\u002Fnebla-cloud\u002Fnebla:latest\n",[112,164,166,169,171],{"class":114,"line":165},6,[112,167,168],{"class":118},"    restart",[112,170,123],{"class":122},[112,172,173],{"class":126},"unless-stopped\n",[112,175,177,180,182],{"class":114,"line":176},7,[112,178,179],{"class":118},"    stop_grace_period",[112,181,123],{"class":122},[112,183,184],{"class":126},"75s\n",[112,186,188,191],{"class":114,"line":187},8,[112,189,190],{"class":118},"    depends_on",[112,192,143],{"class":122},[112,194,196,199],{"class":114,"line":195},9,[112,197,198],{"class":118},"      postgres",[112,200,143],{"class":122},[112,202,204,207,209],{"class":114,"line":203},10,[112,205,206],{"class":118},"        condition",[112,208,123],{"class":122},[112,210,211],{"class":126},"service_healthy\n",[112,213,215,218],{"class":114,"line":214},11,[112,216,217],{"class":118},"    ports",[112,219,143],{"class":122},[112,221,223,226],{"class":114,"line":222},12,[112,224,225],{"class":122},"      - ",[112,227,228],{"class":126},"\"${PANEL_PORT:-8080}:8080\"\n",[112,230,232,235],{"class":114,"line":231},13,[112,233,234],{"class":118},"    environment",[112,236,143],{"class":122},[112,238,240,243,245],{"class":114,"line":239},14,[112,241,242],{"class":118},"      PANEL_DATABASE_URL",[112,244,123],{"class":122},[112,246,247],{"class":126},"postgres:\u002F\u002Fnebla:${POSTGRES_PASSWORD:?set POSTGRES_PASSWORD in .env}@postgres:5432\u002Fnebla?sslmode=disable\n",[112,249,251,254,256],{"class":114,"line":250},15,[112,252,253],{"class":118},"      PANEL_LISTEN",[112,255,123],{"class":122},[112,257,258],{"class":126},"\":8080\"\n",[112,260,262,265,267],{"class":114,"line":261},16,[112,263,264],{"class":118},"      PANEL_BASE_URL",[112,266,123],{"class":122},[112,268,269],{"class":126},"${PANEL_BASE_URL:?set PANEL_BASE_URL in .env}\n",[112,271,273,276,278],{"class":114,"line":272},17,[112,274,275],{"class":118},"      PANEL_SECRET_KEY",[112,277,123],{"class":122},[112,279,280],{"class":126},"${PANEL_SECRET_KEY:?set PANEL_SECRET_KEY in .env}\n",[112,282,284,287,289],{"class":114,"line":283},18,[112,285,286],{"class":118},"      PANEL_SMTP_URL",[112,288,123],{"class":122},[112,290,291],{"class":126},"${PANEL_SMTP_URL:-}\n",[112,293,295,298,300],{"class":114,"line":294},19,[112,296,297],{"class":118},"      PANEL_TRUSTED_PROXIES",[112,299,123],{"class":122},[112,301,302],{"class":126},"${PANEL_TRUSTED_PROXIES:-}\n",[112,304,306,309],{"class":114,"line":305},20,[112,307,308],{"class":118},"    healthcheck",[112,310,143],{"class":122},[112,312,314,317,320,323,326,329,331,334],{"class":114,"line":313},21,[112,315,316],{"class":118},"      test",[112,318,319],{"class":122},": [",[112,321,322],{"class":126},"\"CMD\"",[112,324,325],{"class":122},", ",[112,327,328],{"class":126},"\"\u002Fnebla-server\"",[112,330,325],{"class":122},[112,332,333],{"class":126},"\"healthcheck\"",[112,335,336],{"class":122},"]\n",[112,338,340,343,345],{"class":114,"line":339},22,[112,341,342],{"class":118},"      interval",[112,344,123],{"class":122},[112,346,347],{"class":126},"15s\n",[112,349,351,354,356],{"class":114,"line":350},23,[112,352,353],{"class":118},"      timeout",[112,355,123],{"class":122},[112,357,358],{"class":126},"5s\n",[112,360,362,365,367],{"class":114,"line":361},24,[112,363,364],{"class":118},"      start_period",[112,366,123],{"class":122},[112,368,369],{"class":126},"20s\n",[112,371,373,376,378],{"class":114,"line":372},25,[112,374,375],{"class":118},"      retries",[112,377,123],{"class":122},[112,379,381],{"class":380},"ssYy9","3\n",[112,383,385],{"class":114,"line":384},26,[112,386,134],{"emptyLinePlaceholder":133},[112,388,390,393],{"class":114,"line":389},27,[112,391,392],{"class":118},"  postgres",[112,394,143],{"class":122},[112,396,398,400,402],{"class":114,"line":397},28,[112,399,157],{"class":118},[112,401,123],{"class":122},[112,403,404],{"class":126},"postgres:17\n",[112,406,408,410,412],{"class":114,"line":407},29,[112,409,168],{"class":118},[112,411,123],{"class":122},[112,413,173],{"class":126},[112,415,417,419],{"class":114,"line":416},30,[112,418,234],{"class":118},[112,420,143],{"class":122},[112,422,424,427,429],{"class":114,"line":423},31,[112,425,426],{"class":118},"      POSTGRES_DB",[112,428,123],{"class":122},[112,430,127],{"class":126},[112,432,434,437,439],{"class":114,"line":433},32,[112,435,436],{"class":118},"      POSTGRES_USER",[112,438,123],{"class":122},[112,440,127],{"class":126},[112,442,444,447,449],{"class":114,"line":443},33,[112,445,446],{"class":118},"      POSTGRES_PASSWORD",[112,448,123],{"class":122},[112,450,451],{"class":126},"${POSTGRES_PASSWORD:?set POSTGRES_PASSWORD in .env}\n",[112,453,455,458],{"class":114,"line":454},34,[112,456,457],{"class":118},"    volumes",[112,459,143],{"class":122},[112,461,463,465],{"class":114,"line":462},35,[112,464,225],{"class":122},[112,466,467],{"class":126},"pgdata:\u002Fvar\u002Flib\u002Fpostgresql\u002Fdata\n",[112,469,471,473],{"class":114,"line":470},36,[112,472,308],{"class":118},[112,474,143],{"class":122},[112,476,478,480,482,485,487,490],{"class":114,"line":477},37,[112,479,316],{"class":118},[112,481,319],{"class":122},[112,483,484],{"class":126},"\"CMD-SHELL\"",[112,486,325],{"class":122},[112,488,489],{"class":126},"\"pg_isready -U nebla -d nebla\"",[112,491,336],{"class":122},[112,493,495,497,499],{"class":114,"line":494},38,[112,496,342],{"class":118},[112,498,123],{"class":122},[112,500,358],{"class":126},[112,502,504,506,508],{"class":114,"line":503},39,[112,505,353],{"class":118},[112,507,123],{"class":122},[112,509,358],{"class":126},[112,511,513,515,517],{"class":114,"line":512},40,[112,514,375],{"class":118},[112,516,123],{"class":122},[112,518,519],{"class":380},"10\n",[112,521,523],{"class":114,"line":522},41,[112,524,134],{"emptyLinePlaceholder":133},[112,526,528,531],{"class":114,"line":527},42,[112,529,530],{"class":118},"volumes",[112,532,143],{"class":122},[112,534,536,539],{"class":114,"line":535},43,[112,537,538],{"class":118},"  pgdata",[112,540,143],{"class":122},[14,542,543,544,101],{},"Next to it, create ",[31,545,546],{},".env",[103,548,552],{"className":549,"code":550,"language":551,"meta":108,"style":108},"language-dotenv shiki shiki-themes github-light-high-contrast github-light-high-contrast github-dark-high-contrast","PANEL_BASE_URL=https:\u002F\u002Fpanel.example.com\nPANEL_SECRET_KEY=\nPOSTGRES_PASSWORD=\nPANEL_PORT=8080\n","dotenv",[31,553,554,567,575,582],{"__ignoreMap":108},[112,555,556,560,564],{"class":114,"line":115},[112,557,559],{"class":558},"szw1H","PANEL_BASE_URL",[112,561,563],{"class":562},"sklAV","=",[112,565,566],{"class":122},"https:\u002F\u002Fpanel.example.com\n",[112,568,569,572],{"class":114,"line":130},[112,570,571],{"class":558},"PANEL_SECRET_KEY",[112,573,574],{"class":562},"=\n",[112,576,577,580],{"class":114,"line":137},[112,578,579],{"class":558},"POSTGRES_PASSWORD",[112,581,574],{"class":562},[112,583,584,587,589],{"class":114,"line":146},[112,585,586],{"class":558},"PANEL_PORT",[112,588,563],{"class":562},[112,590,591],{"class":380},"8080\n",[14,593,594],{},"Fill in the two secrets:",[103,596,600],{"className":597,"code":598,"language":599,"meta":108,"style":108},"language-sh shiki shiki-themes github-light-high-contrast github-light-high-contrast github-dark-high-contrast","openssl rand -base64 48   # PANEL_SECRET_KEY\nopenssl rand -hex 24      # POSTGRES_PASSWORD\n","sh",[31,601,602,620],{"__ignoreMap":108},[112,603,604,607,610,613,616],{"class":114,"line":115},[112,605,606],{"class":558},"openssl",[112,608,609],{"class":126}," rand",[112,611,612],{"class":380}," -base64",[112,614,615],{"class":380}," 48",[112,617,619],{"class":618},"sq92B","   # PANEL_SECRET_KEY\n",[112,621,622,624,626,629,632],{"class":114,"line":130},[112,623,606],{"class":558},[112,625,609],{"class":126},[112,627,628],{"class":380}," -hex",[112,630,631],{"class":380}," 24",[112,633,634],{"class":618},"      # POSTGRES_PASSWORD\n",[14,636,637,638,640],{},"Keep ",[31,639,571],{}," safe. Nebla uses it to seal the Proxmox token secrets it stores, and without it they can't be read.",[14,642,643],{},"Start it and check that it answers:",[103,645,647],{"className":597,"code":646,"language":599,"meta":108,"style":108},"docker compose up -d\ncurl -fs localhost:8080\u002Fv1\u002Fhealthz\n",[31,648,649,663],{"__ignoreMap":108},[112,650,651,654,657,660],{"class":114,"line":115},[112,652,653],{"class":558},"docker",[112,655,656],{"class":126}," compose",[112,658,659],{"class":126}," up",[112,661,662],{"class":380}," -d\n",[112,664,665,668,671],{"class":114,"line":130},[112,666,667],{"class":558},"curl",[112,669,670],{"class":380}," -fs",[112,672,673],{"class":126}," localhost:8080\u002Fv1\u002Fhealthz\n",[14,675,676,677,34],{},"Optional settings, such as SMTP for invite emails, trusted reverse proxies and default quotas, are listed in the ",[84,678,681],{"href":679,"rel":680},"https:\u002F\u002Fgithub.com\u002Fnebla-cloud\u002Fnebla#configuration",[88],"configuration table",[36,683,685],{"id":684},"_3-create-the-first-admin-account","3. Create the first admin account",[14,687,688],{},"Open the panel URL and create the first account. It becomes the panel admin. Later accounts come from the admin or from invite links. Open sign-up is off until you turn it on.",[36,690,692],{"id":691},"_4-connect-your-cluster","4. Connect your cluster",[14,694,695],{},"In the admin area:",[697,698,699,706,713,716],"ol",{},[21,700,701,702,705],{},"Add a location with the Proxmox URL, the token ID ",[31,703,704],{},"nebla@pve!panel",", its secret, the TLS fingerprint, and the disk and ISO storages.",[21,707,708,709,712],{},"Create server types, for example ",[31,710,711],{},"small-2"," with 2 vCPU, 4 GB of memory and a 40 GB disk.",[21,714,715],{},"Add an IP pool with the bridge, optional VLAN tag, CIDR, gateway, DNS and the address range servers may use.",[21,717,718],{},"Add images. On Proxmox VE 8.4 or later, enable official Debian, Ubuntu, Rocky Linux, AlmaLinux or Fedora images in one click. On any version you can register a cloud-init template you built yourself.",[36,720,722],{"id":721},"_5-install-the-cli","5. Install the CLI",[103,724,726],{"className":597,"code":725,"language":599,"meta":108,"style":108},"brew install nebla-cloud\u002Ftap\u002Fnebla\n",[31,727,728],{"__ignoreMap":108},[112,729,730,733,736],{"class":114,"line":115},[112,731,732],{"class":558},"brew",[112,734,735],{"class":126}," install",[112,737,738],{"class":126}," nebla-cloud\u002Ftap\u002Fnebla\n",[14,740,741,742,747],{},"Or download a binary for your platform from ",[84,743,746],{"href":744,"rel":745},"https:\u002F\u002Fgithub.com\u002Fnebla-cloud\u002Fnebla\u002Freleases",[88],"GitHub Releases",". Then point it at your panel with an API token from a project:",[103,749,751],{"className":597,"code":750,"language":599,"meta":108,"style":108},"nebla context create home\nnebla server list\n",[31,752,753,767],{"__ignoreMap":108},[112,754,755,758,761,764],{"class":114,"line":115},[112,756,757],{"class":558},"nebla",[112,759,760],{"class":126}," context",[112,762,763],{"class":126}," create",[112,765,766],{"class":126}," home\n",[112,768,769,771,774],{"class":114,"line":130},[112,770,757],{"class":558},[112,772,773],{"class":126}," server",[112,775,776],{"class":126}," list\n",[36,778,780],{"id":779},"upgrading","Upgrading",[103,782,784],{"className":597,"code":783,"language":599,"meta":108,"style":108},"docker compose pull\ndocker compose up -d\n",[31,785,786,795],{"__ignoreMap":108},[112,787,788,790,792],{"class":114,"line":115},[112,789,653],{"class":558},[112,791,656],{"class":126},[112,793,794],{"class":126}," pull\n",[112,796,797,799,801,803],{"class":114,"line":130},[112,798,653],{"class":558},[112,800,656],{"class":126},[112,802,659],{"class":126},[112,804,662],{"class":380},[14,806,807,808,811],{},"Nebla migrates its database on start. Back up the ",[31,809,810],{},"pgdata"," volume before major upgrades.",[813,814,815],"style",{},"html pre.shiki code .sb7M8, html code.shiki .sb7M8{--shiki-light:#024C1A;--shiki-default:#024C1A;--shiki-dark:#72F088}html pre.shiki code .s7iLA, html code.shiki .s7iLA{--shiki-light:#0E1116;--shiki-default:#0E1116;--shiki-dark:#F0F3F6}html pre.shiki code .semJd, html code.shiki .semJd{--shiki-light:#032563;--shiki-default:#032563;--shiki-dark:#ADDCFF}html pre.shiki code .ssYy9, html code.shiki .ssYy9{--shiki-light:#023B95;--shiki-default:#023B95;--shiki-dark:#91CBFF}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 .szw1H, html code.shiki .szw1H{--shiki-light:#702C00;--shiki-default:#702C00;--shiki-dark:#FFB757}html pre.shiki code .sklAV, html code.shiki .sklAV{--shiki-light:#A0111F;--shiki-default:#A0111F;--shiki-dark:#FF9492}html pre.shiki code .sq92B, html code.shiki .sq92B{--shiki-light:#66707B;--shiki-default:#66707B;--shiki-dark:#BDC4CC}",{"title":108,"searchDepth":130,"depth":130,"links":817},[818,819,820,821,822,823],{"id":38,"depth":130,"text":39},{"id":93,"depth":130,"text":94},{"id":684,"depth":130,"text":685},{"id":691,"depth":130,"text":692},{"id":721,"depth":130,"text":722},{"id":779,"depth":130,"text":780},"Run Nebla with Docker Compose next to Proxmox VE, create the first admin account, connect a cluster and install the CLI.","md",{},"\u002Finstall",{"title":5,"description":824},"install","do1e_u4XGBCdh44t00hQMbv4B9JO1UKvZ64GVLqkh20",1795241517899]