[{"data":1,"prerenderedAt":1546},["ShallowReactive",2],{"docs-\u002Fdocs\u002Fcontribute\u002Flocal\u002F":3,"docs-nav":1098},{"id":4,"title":5,"body":6,"description":16,"extension":1088,"layout":1089,"meta":1090,"navGroup":1089,"navGroupOrder":1089,"navOrder":1089,"navTitle":5,"navigation":869,"originalPath":1091,"path":1092,"redirect":1089,"seo":1093,"stem":1094,"updated":1095,"version":1096,"__hash__":1097},"docs\u002Fdocs\u002Fcontribute\u002Flocal\u002Findex.md","Local Install",{"type":7,"value":8,"toc":1063},"minimark",[9,13,17,23,28,33,36,73,77,87,92,95,98,102,105,113,116,156,160,398,402,405,412,416,422,436,439,454,467,471,474,500,503,523,527,530,538,542,551,558,565,572,576,585,594,603,606,695,699,702,812,816,819,836,842,894,898,901,908,985,994,998,1007,1059],[10,11,5],"h1",{"id":12},"local-install",[14,15,16],"p",{},"This guide is for setting up FlowFuse on a single machine, ideal for smaller deployments, evaluations, or for contributors who want to gain a basic understanding of the FlowFuse platform and its features.",[14,18,19],{},[20,21,22],"strong",{},"Note: Local installation does not support HTTPS",[24,25,27],"h2",{"id":26},"prerequisites","Prerequisites",[29,30,32],"h3",{"id":31},"operating-system","Operating System",[14,34,35],{},"The install script has been tested against the following operating systems:",[37,38,39,55,58,61,64,67,70],"ul",{},[40,41,42,43],"li",{},"Raspbian\u002FRaspberry Pi OS versions Buster\u002FBullseye ",[44,45,46],"sup",{},[47,48,54],"a",{"href":49,"ariaDescribedBy":50,"dataFootnoteRef":52,"id":53},"#user-content-fn-1",[51],"footnote-label","","user-content-fnref-1","1",[40,56,57],{},"Debian Buster\u002FBullseye",[40,59,60],{},"Fedora 35",[40,62,63],{},"Ubuntu 20.04",[40,65,66],{},"CentOS 8\u002FRHEL 8\u002FAmazon Linux 2",[40,68,69],{},"MacOS Big Sur & Monterey on Intel & Apple M processors",[40,71,72],{},"Windows 10 & 11",[29,74,76],{"id":75},"nodejs","Node.js",[14,78,79,80,86],{},"FlowFuse requires ",[81,82,83],"em",{},[20,84,85],{},"Node.js v20",".",[88,89,91],"h4",{"id":90},"linux","Linux",[14,93,94],{},"The install script will check to see if it can find a suitable version of Node.js.\nIf not, it will offer to install it for you.",[14,96,97],{},"It will also ensure you have the appropriate build tools installed that are often\nneeded by Node.js modules to build native components.",[88,99,101],{"id":100},"windowsmacos","Windows\u002FMacOS",[14,103,104],{},"If the install script cannot find a suitable version of Node.js, it will exit.",[14,106,107,108],{},"You will need to manually install it before proceeding. Information about\nhow to do this can be found on the Node.js website here: ",[47,109,110],{"href":110,"rel":111},"https:\u002F\u002Fnodejs.org\u002Fen\u002Fdownload",[112],"nofollow",[14,114,115],{},"You will also need to install the appropriate build tools.",[37,117,118,124],{},[40,119,120,123],{},[20,121,122],{},"Windows",": the standard Node.js installer will offer to do that for you.",[40,125,126,129,130,134,135],{},[20,127,128],{},"MacOS",": you will need the ",[131,132,133],"code",{},"XCode Command Line Tools"," to be installed.\nThis can be done by running the following command:\n",[136,137,141],"pre",{"className":138,"code":139,"language":140,"meta":52,"style":52},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","xcode-select --install\n","bash",[131,142,143],{"__ignoreMap":52},[144,145,148,152],"span",{"class":146,"line":147},"line",1,[144,149,151],{"class":150},"sBMFI","xcode-select",[144,153,155],{"class":154},"sfazB"," --install\n",[24,157,159],{"id":158},"installing-flowfuse","Installing FlowFuse",[161,162,163,230,239,355],"ol",{},[40,164,165,166,169,170,173,176,177,208,210,211],{},"Create a directory to be the base of your FlowFuse install. For example: ",[131,167,168],{},"\u002Fopt\u002Fflowforge"," or ",[131,171,172],{},"c:\\flowforge",[174,175],"br",{},"For Linux\u002FMacOS:",[136,178,180],{"className":138,"code":179,"language":140,"meta":52,"style":52},"sudo mkdir \u002Fopt\u002Fflowforge\nsudo chown $USER \u002Fopt\u002Fflowforge\n",[131,181,182,193],{"__ignoreMap":52},[144,183,184,187,190],{"class":146,"line":147},[144,185,186],{"class":150},"sudo",[144,188,189],{"class":154}," mkdir",[144,191,192],{"class":154}," \u002Fopt\u002Fflowforge\n",[144,194,196,198,201,205],{"class":146,"line":195},2,[144,197,186],{"class":150},[144,199,200],{"class":154}," chown",[144,202,204],{"class":203},"sTEyZ"," $USER ",[144,206,207],{"class":154},"\u002Fopt\u002Fflowforge\n",[174,209],{},"For Windows:",[136,212,214],{"className":138,"code":213,"language":140,"meta":52,"style":52},"mkdir c:\\flowforge\n",[131,215,216],{"__ignoreMap":52},[144,217,218,221,224,227],{"class":146,"line":147},[144,219,220],{"class":150},"mkdir",[144,222,223],{"class":154}," c:",[144,225,226],{"class":203},"\\f",[144,228,229],{"class":154},"lowforge\n",[40,231,232,233,238],{},"Download the latest ",[47,234,237],{"href":235,"rel":236},"https:\u002F\u002Fgithub.com\u002FFlowFuse\u002Finstaller\u002Freleases\u002Flatest\u002Fdownload\u002Fflowforge-installer.zip",[112],"Installer zip file"," into a temporary location.",[40,240,241,242,245,247,257,296,299,301,308],{},"Unzip the downloaded zip file and copy its contents to\nthe FlowForge directory",[29,243,176],{"id":244},"for-linuxmacos",[174,246],{},[81,248,249,250,253,254],{},"Assumes ",[131,251,252],{},"\u002Ftmp\u002F"," is the directory where you downloaded ",[131,255,256],{},"flowforge-installer.zip",[136,258,260],{"className":138,"code":259,"language":140,"meta":52,"style":52},"cd \u002Ftmp\u002F\nunzip flowforge-installer.zip\ncp -R flowforge-installer\u002F* \u002Fopt\u002Fflowforge\n",[131,261,262,271,279],{"__ignoreMap":52},[144,263,264,268],{"class":146,"line":147},[144,265,267],{"class":266},"s2Zo4","cd",[144,269,270],{"class":154}," \u002Ftmp\u002F\n",[144,272,273,276],{"class":146,"line":195},[144,274,275],{"class":150},"unzip",[144,277,278],{"class":154}," flowforge-installer.zip\n",[144,280,282,285,288,291,294],{"class":146,"line":281},3,[144,283,284],{"class":150},"cp",[144,286,287],{"class":154}," -R",[144,289,290],{"class":154}," flowforge-installer\u002F",[144,292,293],{"class":203},"*",[144,295,192],{"class":154},[29,297,210],{"id":298},"for-windows",[174,300],{},[81,302,249,303,253,306],{},[131,304,305],{},"c:\\temp",[131,307,256],{},[136,309,311],{"className":138,"code":310,"language":140,"meta":52,"style":52},"cd c:\\temp\ntar -xf flowforge-installer.zip\nxcopy \u002FE \u002FI flowforge-installer c:\\flowforge\n",[131,312,313,325,335],{"__ignoreMap":52},[144,314,315,317,319,322],{"class":146,"line":147},[144,316,267],{"class":266},[144,318,223],{"class":154},[144,320,321],{"class":203},"\\t",[144,323,324],{"class":154},"emp\n",[144,326,327,330,333],{"class":146,"line":195},[144,328,329],{"class":150},"tar",[144,331,332],{"class":154}," -xf",[144,334,278],{"class":154},[144,336,337,340,343,346,349,351,353],{"class":146,"line":281},[144,338,339],{"class":150},"xcopy",[144,341,342],{"class":154}," \u002FE",[144,344,345],{"class":154}," \u002FI",[144,347,348],{"class":154}," flowforge-installer",[144,350,223],{"class":154},[144,352,226],{"class":203},[144,354,229],{"class":154},[40,356,357,358,176,360,376,210,378],{},"Run the installer and follow the prompts",[174,359],{},[136,361,363],{"className":138,"code":362,"language":140,"meta":52,"style":52},"cd \u002Fopt\u002Fflowforge\n.\u002Finstall.sh\n",[131,364,365,371],{"__ignoreMap":52},[144,366,367,369],{"class":146,"line":147},[144,368,267],{"class":266},[144,370,192],{"class":154},[144,372,373],{"class":146,"line":195},[144,374,375],{"class":150},".\u002Finstall.sh\n",[174,377],{},[136,379,381],{"className":138,"code":380,"language":140,"meta":52,"style":52},"cd c:\\flowforge\ninstall.bat\n",[131,382,383,393],{"__ignoreMap":52},[144,384,385,387,389,391],{"class":146,"line":147},[144,386,267],{"class":266},[144,388,223],{"class":154},[144,390,226],{"class":203},[144,392,229],{"class":154},[144,394,395],{"class":146,"line":195},[144,396,397],{"class":150},"install.bat\n",[29,399,401],{"id":400},"installing-as-a-service-optional","Installing as a service (optional)",[14,403,404],{},"On Linux, the installer will ask if you want to run FlowFuse as a service.\nThis will mean it starts automatically whenever you restart your device.",[14,406,407,408,411],{},"If you select this option, it will ask if you want to run the service as the\ncurrent user, or create a new ",[131,409,410],{},"flowforge"," user. If you choose to create the\nuser, it will also change the ownership of the FlowFuse directory to that user.",[24,413,415],{"id":414},"configuring-flowfuse","Configuring FlowFuse",[14,417,418,419],{},"The default FlowFuse configuration is provided in the file ",[131,420,421],{},"flowforge.yml",[37,423,424,430],{},[40,425,426,427],{},"Linux\u002FMacOS: ",[131,428,429],{},"\u002Fopt\u002Fflowforge\u002Fetc\u002Fflowforge.yml",[40,431,432,433],{},"Windows: ",[131,434,435],{},"c:\\flowforge\\etc\\flowforge.yml",[14,437,438],{},"The default configuration file already contains everything you need to get started with FlowFuse.",[14,440,441,442,445,446,449,450,453],{},"It will allow you to access FlowFuse and the Node-RED instances you create, from the same server running the platform.\nIf you want to allow access from other devices on the network, you must edit the configuration file and\nchange the ",[131,443,444],{},"host"," setting to ",[131,447,448],{},"0.0.0.0"," and change ",[131,451,452],{},"base_url"," to contain the IP address of the server.",[14,455,456,457,459,460,462,463,86],{},"NOTE: We do not support changing the ",[131,458,444],{}," and ",[131,461,452],{}," values once you have created an instance.\nFor more information on all of the options available, see the ",[47,464,466],{"href":465},"\u002Fdocs\u002Finstall\u002Fconfiguration","configuration guide",[24,468,470],{"id":469},"running-flowfuse","Running FlowFuse",[14,472,473],{},"To run it manually, you can use:",[37,475,476,488],{},[40,477,478,479],{},"Linux\u002FMacOS:",[136,480,482],{"className":138,"code":481,"language":140,"meta":52,"style":52},"\u002Fopt\u002Fflowforge\u002Fbin\u002Fflowforge.sh\n",[131,483,484],{"__ignoreMap":52},[144,485,486],{"class":146,"line":147},[144,487,481],{"class":150},[40,489,490,491],{},"Windows:",[136,492,494],{"className":138,"code":493,"language":140,"meta":52,"style":52},"c:\\flowforge\\bin\\flowforge.bat\n",[131,495,496],{"__ignoreMap":52},[144,497,498],{"class":146,"line":147},[144,499,493],{"class":150},[14,501,502],{},"Or to run as a service:",[37,504,505],{},[40,506,91,507],{},[136,508,510],{"className":138,"code":509,"language":140,"meta":52,"style":52},"service flowforge start\n",[131,511,512],{"__ignoreMap":52},[144,513,514,517,520],{"class":146,"line":147},[144,515,516],{"class":150},"service",[144,518,519],{"class":154}," flowforge",[144,521,522],{"class":154}," start\n",[24,524,526],{"id":525},"first-run-setup","First Run Setup",[14,528,529],{},"Once FlowFuse is started, you will be ready to perform the first run setup.",[14,531,532,533,537],{},"Follow ",[47,534,536],{"href":535},"\u002Fdocs\u002Finstall\u002Ffirst-run","this guide"," to continue.",[24,539,541],{"id":540},"setting-up-mosquitto-optional","Setting up Mosquitto (optional)",[14,543,544,545,550],{},"The platform depends on the ",[47,546,549],{"href":547,"rel":548},"https:\u002F\u002Fmosquitto.org\u002F",[112],"Mosquitto MQTT Broker"," to\nprovide real-time messaging between devices and the platform.",[14,552,553,554,557],{},"This is currently an ",[81,555,556],{},"optional"," component - the platform will work without the\nbroker, but some features will not be available (e.g Access to Remote Instance Editor\nand Remote Instance logs requires the MQTT Broker).",[14,559,560,561,564],{},"We do ",[20,562,563],{},"not"," support sharing a broker with other non-FlowFuse applications. If you\nalready have mosquitto installed and running, you will need to run a second instance\ndedicated to FlowFuse.",[14,566,567,568,86],{},"You can either follow the manual install steps, which involve building the authentication\nplugin from scratch, or make use of the ",[47,569,571],{"href":570},"#docker-install","Docker install",[29,573,575],{"id":574},"manual-install","Manual install",[14,577,578,581,582,584],{},[20,579,580],{},"Note",": if you are running on Windows, you will need to follow the ",[47,583,571],{"href":570},"\ninstructions below due to a limitation of the authentication plugin we use.",[14,586,587,588,593],{},"Follow the appropriate ",[47,589,592],{"href":590,"rel":591},"https:\u002F\u002Fmosquitto.org\u002Fdownload\u002F",[112],"install instructions"," for\nyour operating system.",[14,595,596,597,602],{},"Once installed, you can download pre-built binaries for Linux platforms from\n",[47,598,601],{"href":599,"rel":600},"https:\u002F\u002Fgithub.com\u002Fiegomez\u002Fmosquitto-go-auth\u002Freleases\u002Flatest",[112],"here"," and then jump\nto step 4 below.",[14,604,605],{},"On MacOS you will need to build and install the authentication plugin.",[161,607,608,627,635,642],{},[40,609,610,611],{},"Clone the plugin repository",[136,612,614],{"className":138,"code":613,"language":140,"meta":52,"style":52},"git clone https:\u002F\u002Fgithub.com\u002Fiegomez\u002Fmosquitto-go-auth.git\n",[131,615,616],{"__ignoreMap":52},[144,617,618,621,624],{"class":146,"line":147},[144,619,620],{"class":150},"git",[144,622,623],{"class":154}," clone",[144,625,626],{"class":154}," https:\u002F\u002Fgithub.com\u002Fiegomez\u002Fmosquitto-go-auth.git\n",[40,628,629,630],{},"Follow the instructions on ",[47,631,634],{"href":632,"rel":633},"https:\u002F\u002Fgithub.com\u002Fiegomez\u002Fmosquitto-go-auth#building-the-plugin",[112],"building the plugin",[40,636,637,638,641],{},"This should result in a file called ",[131,639,640],{},"go-auth.so"," being generated",[40,643,644,645,648,649,651,652,679],{},"Run mosquitto with the configuration file found in the ",[131,646,647],{},"broker"," directory",[174,650],{},"You will need to customise the values to match your local configuration:",[37,653,654,663,669],{},[40,655,656,659,660,662],{},[131,657,658],{},"auth_plugin"," - set to the path of the ",[131,661,640],{}," file built in the previous step",[40,664,665,668],{},[131,666,667],{},"listener 1883\u002F1884"," - if you already have mosquitto running locally, you'll need to\nchange these ports to something else.",[40,670,671,674,675,678],{},[131,672,673],{},"auth_opt_http_host"," \u002F ",[131,676,677],{},"auth_opt_http_port"," - if you plan to run the platform\non a different port, change these settings to match.",[136,680,682],{"className":138,"code":681,"language":140,"meta":52,"style":52},"mosquitto -c broker\u002Fmosquitto.conf\n",[131,683,684],{"__ignoreMap":52},[144,685,686,689,692],{"class":146,"line":147},[144,687,688],{"class":150},"mosquitto",[144,690,691],{"class":154}," -c",[144,693,694],{"class":154}," broker\u002Fmosquitto.conf\n",[29,696,698],{"id":697},"docker-install","Docker Install",[14,700,701],{},"Instead of installing and building mosquitto and the authentication plugin from source,\nyou can use a pre-built docker image that provides everything needed.",[161,703,704,723,751],{},[40,705,706,707],{},"First pull the latest version of the pre-built container",[136,708,710],{"className":138,"code":709,"language":140,"meta":52,"style":52},"docker pull iegomez\u002Fmosquitto-go-auth\n",[131,711,712],{"__ignoreMap":52},[144,713,714,717,720],{"class":146,"line":147},[144,715,716],{"class":150},"docker",[144,718,719],{"class":154}," pull",[144,721,722],{"class":154}," iegomez\u002Fmosquitto-go-auth\n",[40,724,725,726,728,729,651,731],{},"A default mosquitto.conf file can be found in the ",[131,727,647],{}," directory.",[174,730],{},[37,732,733,738,743],{},[40,734,735,737],{},[131,736,673],{}," value to match the IP address of either the docker0 interface or the external IP address of the machine running the FlowFuse platform",[40,739,740,742],{},[131,741,677],{}," if you have changed the port the FlowFuse platform is running on",[40,744,745,747,748],{},[131,746,658],{}," should be changed to ",[131,749,750],{},"auth_plugin \u002Fmosquitto\u002Fgo-auth.so",[40,752,753,754,794,796,797,800,801,804,805,808,809,86],{},"Start the container with the following command",[136,755,757],{"className":138,"code":756,"language":140,"meta":52,"style":52},"docker run -d -v \u002Fopt\u002Fflowforge\u002Fbroker\u002Fmosquitto.conf:\u002Fetc\u002Fmosquitto\u002Fmosquitto.conf -p 1883:1883 -p 1884:1884 --name flowforge-broker iegomez\u002Fmosquitto-go-auth\n",[131,758,759],{"__ignoreMap":52},[144,760,761,763,766,769,772,775,778,781,783,786,789,792],{"class":146,"line":147},[144,762,716],{"class":150},[144,764,765],{"class":154}," run",[144,767,768],{"class":154}," -d",[144,770,771],{"class":154}," -v",[144,773,774],{"class":154}," \u002Fopt\u002Fflowforge\u002Fbroker\u002Fmosquitto.conf:\u002Fetc\u002Fmosquitto\u002Fmosquitto.conf",[144,776,777],{"class":154}," -p",[144,779,780],{"class":154}," 1883:1883",[144,782,777],{"class":154},[144,784,785],{"class":154}," 1884:1884",[144,787,788],{"class":154}," --name",[144,790,791],{"class":154}," flowforge-broker",[144,793,722],{"class":154},[174,795],{},"This will map the ",[131,798,799],{},"1883","\u002F",[131,802,803],{},"1884"," ports to the host machine so they can be accessed outside of the container. If you already have an MQTT broker running on port 1883, then you'll need to modify the ",[131,806,807],{},"-p"," options to use a different set of ports. For example: ",[131,810,811],{},"-p 9883:1883 -p 9884:1884",[24,813,815],{"id":814},"file-server","File Server",[14,817,818],{},"By default the FlowFuse File Server component is disabled as it is a licensed feature. If you provide a license you can start the File Server with the following command:",[136,820,822],{"className":138,"code":821,"language":140,"meta":52,"style":52},"sudo service flowforge-file start\n",[131,823,824],{"__ignoreMap":52},[144,825,826,828,831,834],{"class":146,"line":147},[144,827,186],{"class":150},[144,829,830],{"class":154}," service",[144,832,833],{"class":154}," flowforge-file",[144,835,522],{"class":154},[14,837,838,839,841],{},"You can then uncomment the following section in the ",[131,840,429],{}," file",[136,843,847],{"className":844,"code":845,"language":846,"meta":52,"style":52},"language-yaml shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","#################################################\n# File Server config                            #\n#################################################\n\nfileStore:\n  url: http:\u002F\u002Flocalhost:3001\n\n","yaml",[131,848,849,855,860,864,871,882],{"__ignoreMap":52},[144,850,851],{"class":146,"line":147},[144,852,854],{"class":853},"sHwdD","#################################################\n",[144,856,857],{"class":146,"line":195},[144,858,859],{"class":853},"# File Server config                            #\n",[144,861,862],{"class":146,"line":281},[144,863,854],{"class":853},[144,865,867],{"class":146,"line":866},4,[144,868,870],{"emptyLinePlaceholder":869},true,"\n",[144,872,874,878],{"class":146,"line":873},5,[144,875,877],{"class":876},"swJcz","fileStore",[144,879,881],{"class":880},"sMK4o",":\n",[144,883,885,888,891],{"class":146,"line":884},6,[144,886,887],{"class":876},"  url",[144,889,890],{"class":880},":",[144,892,893],{"class":154}," http:\u002F\u002Flocalhost:3001\n",[24,895,897],{"id":896},"upgrade","Upgrade",[14,899,900],{},"If upgrading from 1.x.y to 2.x.y then you may need to upgrade from NodeJS v16 to NodeJS v18.\nPlease ensure you do this before the following steps.",[14,902,903,904,907],{},"To upgrade to the latest release you can follow these steps. Replace ",[131,905,906],{},"x.y.z"," with the\nversion you are upgrading to.",[161,909,910,925,946,970,973],{},[40,911,912,913,916,917],{},"Stop FlowFuse ",[131,914,915],{},"sudo service flowfuse stop"," ",[44,918,919],{},[47,920,924],{"href":921,"ariaDescribedBy":922,"dataFootnoteRef":52,"id":923},"#user-content-fn-2",[51],"user-content-fnref-2","2",[40,926,927,928,931,932],{},"Change into the ",[131,929,930],{},"app"," directory\n",[37,933,934,940],{},[40,935,936,939],{},[131,937,938],{},"cd \u002Fopt\u002Fflowforge\u002Fapp"," (Linux\u002FMacOS)",[40,941,942,945],{},[131,943,944],{},"cd c:\\flowforge\\app"," (Windows)",[40,947,948,949],{},"NPM install the desired version\n",[37,950,951,965],{},[40,952,953,956,957],{},[131,954,955],{},"sudo -u flowforge npm install @flowfuse\u002Fflowfuse@x.y.z"," (Linux\u002FMacOS) ",[44,958,959],{},[47,960,964],{"href":961,"ariaDescribedBy":962,"dataFootnoteRef":52,"id":963},"#user-content-fn-3",[51],"user-content-fnref-3","3",[40,966,967,945],{},[131,968,969],{},"npm install @flowfuse\u002Fflowfuse@x.y.z",[40,971,972],{},"Check the release notes for any additional steps needed to upgrade the particular version",[40,974,975,976,916,979],{},"Restart FlowFuse ",[131,977,978],{},"sudo service flowfuse start",[44,980,981],{},[47,982,924],{"href":921,"ariaDescribedBy":983,"dataFootnoteRef":52,"id":984},[51],"user-content-fnref-2-2",[14,986,987,988,991,992],{},"If you are running as your normal user you can drop the ",[131,989,990],{},"sudo -u flowfuse"," and just run ",[131,993,969],{},[24,995,997],{"id":996},"uninstall","Uninstall",[14,999,1000,1001,169,1004,728],{},"To uninstall, stop all the running processes and then delete the ",[131,1002,1003],{},"\u002Fopt\u002Fflowfuse",[131,1005,1006],{},"c:\\flowfuse\\",[1008,1009,1012,1017],"section",{"className":1010,"dataFootnotes":52},[1011],"footnotes",[24,1013,1016],{"className":1014,"id":51},[1015],"sr-only","Footnotes",[161,1018,1019,1030,1046],{},[40,1020,1022,1023],{"id":1021},"user-content-fn-1","Arm6 devices, such as the original Raspberry Pi Zero and Zero W are not supported. ",[47,1024,1029],{"href":1025,"ariaLabel":1026,"className":1027,"dataFootnoteBackref":52},"#user-content-fnref-1","Back to reference 1",[1028],"data-footnote-backref","↩",[40,1031,1033,1034,916,1039],{"id":1032},"user-content-fn-2","Assumes you are running FlowFuse as a Linux service. ",[47,1035,1029],{"href":1036,"ariaLabel":1037,"className":1038,"dataFootnoteBackref":52},"#user-content-fnref-2","Back to reference 2",[1028],[47,1040,1029,1044],{"href":1041,"ariaLabel":1042,"className":1043,"dataFootnoteBackref":52},"#user-content-fnref-2-2","Back to reference 2-2",[1028],[44,1045,924],{},[40,1047,1049,1050,1053,1054],{"id":1048},"user-content-fn-3","Assumes you are running FlowFuse as the ",[131,1051,1052],{},"flowfuse"," user as created by the installer ",[47,1055,1029],{"href":1056,"ariaLabel":1057,"className":1058,"dataFootnoteBackref":52},"#user-content-fnref-3","Back to reference 3",[1028],[1060,1061,1062],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}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 .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}",{"title":52,"searchDepth":866,"depth":866,"links":1064},[1065,1072,1077,1078,1079,1080,1084,1085,1086,1087],{"id":26,"depth":195,"text":27,"children":1066},[1067,1068],{"id":31,"depth":281,"text":32},{"id":75,"depth":281,"text":76,"children":1069},[1070,1071],{"id":90,"depth":866,"text":91},{"id":100,"depth":866,"text":101},{"id":158,"depth":195,"text":159,"children":1073},[1074,1075,1076],{"id":244,"depth":281,"text":176},{"id":298,"depth":281,"text":210},{"id":400,"depth":281,"text":401},{"id":414,"depth":195,"text":415},{"id":469,"depth":195,"text":470},{"id":525,"depth":195,"text":526},{"id":540,"depth":195,"text":541,"children":1081},[1082,1083],{"id":574,"depth":281,"text":575},{"id":697,"depth":281,"text":698},{"id":814,"depth":195,"text":815},{"id":896,"depth":195,"text":897},{"id":996,"depth":195,"text":997},{"id":51,"depth":195,"text":1016},"md",null,{},"contribute\u002Flocal\u002FREADME.md","\u002Fdocs\u002Fcontribute\u002Flocal",{"title":5,"description":16},"docs\u002Fcontribute\u002Flocal\u002Findex","2026-03-10 13:56:24 +0000","2.33.2","d1q4TKwHcD77e1VPutNdj25-9UNhZ4-6Jp8bDipZjH4",[1099,1106,1125,1136],{"name":1100,"order":147,"children":1101},"FlowFuse User Manuals",[1102],{"title":1103,"path":1104,"group":1100,"groupOrder":147,"order":195,"children":1105},"FlowFuse API","\u002Fdocs\u002Fapi",[],{"name":1107,"order":866,"children":1108},"FlowFuse Self-Hosted",[1109,1113],{"title":1110,"path":1111,"group":1107,"groupOrder":866,"order":147,"children":1112},"Quick Start","\u002Fdocs\u002Fquick-start",[],{"title":1114,"path":1115,"group":1107,"groupOrder":866,"order":281,"children":1116},"Upgrading FlowFuse","\u002Fdocs\u002Fupgrade",[1117,1121],{"title":1118,"path":1119,"order":1089,"children":1120},"Installing a license","\u002Fdocs\u002Fupgrade\u002Fopen-source-to-premium",[],{"title":1122,"path":1123,"order":1089,"children":1124},"Upgrading the Node-RED version","\u002Fdocs\u002Fupgrade\u002Fnodered-version",[],{"name":1126,"order":873,"children":1127},"Support",[1128,1132],{"title":1129,"path":1130,"group":1126,"groupOrder":873,"order":281,"children":1131},"Premium Support","\u002Fdocs\u002Fpremium-support",[],{"title":1133,"path":1134,"group":1126,"groupOrder":873,"order":1089,"children":1135},"Debugging Node-RED issues","\u002Fdocs\u002Fdebugging",[],{"name":1137,"order":1089,"children":1138},"Other",[1139,1187,1199,1276,1323,1342,1411,1422],{"title":1140,"path":1141,"order":1089,"children":1142},"admin","\u002Fdocs\u002Fadmin",[1143,1147,1159,1167,1171,1175,1179,1183],{"title":1144,"path":1145,"order":147,"children":1146},"Administering FlowFuse","\u002Fdocs\u002Fadmin\u002Fintroduction",[],{"title":1148,"path":1149,"order":1089,"children":1150},"Configuring Single Sign-On (SSO)","\u002Fdocs\u002Fadmin\u002Fsso",[1151,1155],{"title":1152,"path":1153,"order":1089,"children":1154},"LDAP SSO","\u002Fdocs\u002Fadmin\u002Fsso\u002Fldap",[],{"title":1156,"path":1157,"order":1089,"children":1158},"SAML SSO","\u002Fdocs\u002Fadmin\u002Fsso\u002Fsaml",[],{"title":1160,"path":1161,"order":1089,"children":1162},"hardening","\u002Fdocs\u002Fadmin\u002Fhardening",[1163],{"title":1164,"path":1165,"order":1089,"children":1166},"Kubernetes Hardening","\u002Fdocs\u002Fadmin\u002Fhardening\u002Fkubernetes",[],{"title":1168,"path":1169,"order":1089,"children":1170},"Monitoring","\u002Fdocs\u002Fadmin\u002Fmonitoring",[],{"title":1172,"path":1173,"order":1089,"children":1174},"Observability","\u002Fdocs\u002Fadmin\u002Fobservability",[],{"title":1176,"path":1177,"order":1089,"children":1178},"Soft Launch Enablement","\u002Fdocs\u002Fadmin\u002Ffeature-flags",[],{"title":1180,"path":1181,"order":1089,"children":1182},"Telemetry","\u002Fdocs\u002Fadmin\u002Ftelemetry",[],{"title":1184,"path":1185,"order":1089,"children":1186},"User Management","\u002Fdocs\u002Fadmin\u002Fuser-management",[],{"title":1188,"path":1189,"order":1089,"children":1190},"cloud","\u002Fdocs\u002Fcloud",[1191,1195],{"title":1192,"path":1193,"order":147,"children":1194},"Introduction","\u002Fdocs\u002Fcloud\u002Fintroduction",[],{"title":1196,"path":1197,"order":1089,"children":1198},"FlowFuse Cloud Billing","\u002Fdocs\u002Fcloud\u002Fbilling",[],{"title":1200,"path":1201,"order":1089,"children":1202},"contribute","\u002Fdocs\u002Fcontribute",[1203,1206,1210,1214,1218,1222,1226,1232,1268,1272],{"title":1192,"path":1204,"order":147,"children":1205},"\u002Fdocs\u002Fcontribute\u002Fintroduction",[],{"title":1207,"path":1208,"order":1089,"children":1209},"Adding Template Settings","\u002Fdocs\u002Fcontribute\u002Fadding-template-settings",[],{"title":1211,"path":1212,"order":1089,"children":1213},"API Design","\u002Fdocs\u002Fcontribute\u002Fapi-design",[],{"title":1215,"path":1216,"order":1089,"children":1217},"Creating debug stack containers","\u002Fdocs\u002Fcontribute\u002Fcreating-debug-stack-containers",[],{"title":1219,"path":1220,"order":1089,"children":1221},"Database migrations","\u002Fdocs\u002Fcontribute\u002Fdb-migrations",[],{"title":1223,"path":1224,"order":1089,"children":1225},"FlowFuse Architecture","\u002Fdocs\u002Fcontribute\u002Farchitecture",[],{"title":5,"path":1092,"order":1089,"children":1227},[1228],{"title":1229,"path":1230,"order":1089,"children":1231},"Local Stacks","\u002Fdocs\u002Fcontribute\u002Flocal\u002Fstacks",[],{"title":1233,"path":1234,"order":1089,"children":1235},"State Flows","\u002Fdocs\u002Fcontribute\u002Fworkflows",[1236,1240,1244,1248,1252,1256,1260,1264],{"title":1237,"path":1238,"order":1089,"children":1239},"Device Editor","\u002Fdocs\u002Fcontribute\u002Fworkflows\u002Fdevice-editor",[],{"title":1241,"path":1242,"order":1089,"children":1243},"Instance states","\u002Fdocs\u002Fcontribute\u002Fworkflows\u002Fproject-states",[],{"title":1245,"path":1246,"order":1089,"children":1247},"Invite External Users","\u002Fdocs\u002Fcontribute\u002Fworkflows\u002Finvite-external-user",[],{"title":1249,"path":1250,"order":1089,"children":1251},"Project Creation","\u002Fdocs\u002Fcontribute\u002Fworkflows\u002Fproject-create",[],{"title":1253,"path":1254,"order":1089,"children":1255},"Reset Password Flow","\u002Fdocs\u002Fcontribute\u002Fworkflows\u002Fpassword-reset",[],{"title":1257,"path":1258,"order":1089,"children":1259},"Team creation Flow","\u002Fdocs\u002Fcontribute\u002Fworkflows\u002Fteam-create",[],{"title":1261,"path":1262,"order":1089,"children":1263},"User Login Flows","\u002Fdocs\u002Fcontribute\u002Fworkflows\u002Flogin",[],{"title":1265,"path":1266,"order":1089,"children":1267},"User Sign up Flow","\u002Fdocs\u002Fcontribute\u002Fworkflows\u002Fsignup",[],{"title":1269,"path":1270,"order":1089,"children":1271},"Team Broker","\u002Fdocs\u002Fcontribute\u002Fteam-broker",[],{"title":1273,"path":1274,"order":1089,"children":1275},"Working with Feature Flags","\u002Fdocs\u002Fcontribute\u002Ffeature-flags",[],{"title":1277,"path":1278,"order":1089,"children":1279},"device-agent","\u002Fdocs\u002Fdevice-agent",[1280,1284,1287,1291,1295,1299],{"title":1281,"path":1282,"order":147,"children":1283},"FlowFuse Device Agent Introduction","\u002Fdocs\u002Fdevice-agent\u002Fintroduction",[],{"title":1110,"path":1285,"order":195,"children":1286},"\u002Fdocs\u002Fdevice-agent\u002Fquickstart",[],{"title":1288,"path":1289,"order":866,"children":1290},"Register your Remote Instance","\u002Fdocs\u002Fdevice-agent\u002Fregister",[],{"title":1292,"path":1293,"order":873,"children":1294},"Running the Agent","\u002Fdocs\u002Fdevice-agent\u002Frunning",[],{"title":1296,"path":1297,"order":884,"children":1298},"Deploying your Flows","\u002Fdocs\u002Fdevice-agent\u002Fdeploy",[],{"title":1300,"path":1301,"order":1089,"children":1302},"install","\u002Fdocs\u002Fdevice-agent\u002Finstall",[1303,1308,1312,1315,1319],{"title":1304,"path":1305,"group":1306,"order":147,"children":1307},"Overview","\u002Fdocs\u002Fdevice-agent\u002Finstall\u002Foverview","DeviceAgentInstallation",[],{"title":1309,"path":1310,"group":1306,"order":195,"children":1311},"Device Agent Installer","\u002Fdocs\u002Fdevice-agent\u002Finstall\u002Fdevice-agent-installer",[],{"title":698,"path":1313,"group":1306,"order":281,"children":1314},"\u002Fdocs\u002Fdevice-agent\u002Finstall\u002Fdocker",[],{"title":1316,"path":1317,"group":1306,"order":866,"children":1318},"Kubernetes Install","\u002Fdocs\u002Fdevice-agent\u002Finstall\u002Fkubernetes",[],{"title":1320,"path":1321,"group":1306,"order":873,"children":1322},"Manual Install with NPM","\u002Fdocs\u002Fdevice-agent\u002Finstall\u002Fmanual",[],{"title":1324,"path":1325,"order":1089,"children":1326},"hardware","\u002Fdocs\u002Fhardware",[1327,1330,1334,1338],{"title":1304,"path":1328,"order":147,"children":1329},"\u002Fdocs\u002Fhardware\u002Fintroduction",[],{"title":1331,"path":1332,"order":195,"children":1333},"ctrlX - Node-RED","\u002Fdocs\u002Fhardware\u002Fctrlx-node-red",[],{"title":1335,"path":1336,"order":281,"children":1337},"ctrlX - Device Agent","\u002Fdocs\u002Fhardware\u002Fctrlx-device-agent",[],{"title":1339,"path":1340,"order":281,"children":1341},"Raspberry Pi with Raspbian","\u002Fdocs\u002Fhardware\u002Fraspbian",[],{"title":1300,"path":1343,"order":1089,"children":1344},"\u002Fdocs\u002Finstall",[1345,1348,1350,1354,1373,1377,1379,1383],{"title":1304,"path":1346,"order":147,"children":1347},"\u002Fdocs\u002Finstall\u002Fintroduction",[],{"title":415,"path":465,"order":1089,"children":1349},[],{"title":1351,"path":1352,"order":1089,"children":1353},"DNS Setup","\u002Fdocs\u002Finstall\u002Fdns-setup",[],{"title":571,"path":1355,"order":1089,"children":1356},"\u002Fdocs\u002Finstall\u002Fdocker",[1357,1361,1365,1369],{"title":1358,"path":1359,"order":1089,"children":1360},"Add Project Stacks on Docker","\u002Fdocs\u002Finstall\u002Fdocker\u002Fstacks",[],{"title":1362,"path":1363,"order":1089,"children":1364},"Docker Engine on Windows","\u002Fdocs\u002Finstall\u002Fdocker\u002Fwindows-docker-ce",[],{"title":1366,"path":1367,"order":1089,"children":1368},"Docker from AWS Market Place","\u002Fdocs\u002Finstall\u002Fdocker\u002Faws-marketplace",[],{"title":1370,"path":1371,"order":1089,"children":1372},"Docker on Digital Ocean","\u002Fdocs\u002Finstall\u002Fdocker\u002Fdigital-ocean",[],{"title":1374,"path":1375,"order":1089,"children":1376},"Email configuration","\u002Fdocs\u002Finstall\u002Femail-providers",[],{"title":526,"path":535,"order":1089,"children":1378},[],{"title":1380,"path":1381,"order":1089,"children":1382},"FlowFuse File Storage","\u002Fdocs\u002Finstall\u002Ffile-storage",[],{"title":1384,"path":1385,"order":1089,"children":1386},"Install FlowFuse on Kubernetes","\u002Fdocs\u002Finstall\u002Fkubernetes",[1387,1391,1395,1399,1403,1407],{"title":1388,"path":1389,"order":1089,"children":1390},"AWS EKS Installation","\u002Fdocs\u002Finstall\u002Fkubernetes\u002Faws",[],{"title":1392,"path":1393,"order":1089,"children":1394},"AWS EKS Installation with Terraform and Helm","\u002Fdocs\u002Finstall\u002Fkubernetes\u002Faws-terraform",[],{"title":1396,"path":1397,"order":1089,"children":1398},"Digital Ocean Kubernetes Installation","\u002Fdocs\u002Finstall\u002Fkubernetes\u002Fdigital-ocean",[],{"title":1400,"path":1401,"order":1089,"children":1402},"Ingress Controller Migration","\u002Fdocs\u002Finstall\u002Fkubernetes\u002Fingress-controller-migration",[],{"title":1404,"path":1405,"order":1089,"children":1406},"Kubernetes Project Stacks","\u002Fdocs\u002Finstall\u002Fkubernetes\u002Fstacks",[],{"title":1408,"path":1409,"order":1089,"children":1410},"OpenShift Installation","\u002Fdocs\u002Finstall\u002Fkubernetes\u002Fopenshift",[],{"title":1412,"path":1413,"order":1089,"children":1414},"migration","\u002Fdocs\u002Fmigration",[1415,1418],{"title":1192,"path":1416,"order":147,"children":1417},"\u002Fdocs\u002Fmigration\u002Fintroduction",[],{"title":1419,"path":1420,"order":1089,"children":1421},"Node-RED Tools plugin","\u002Fdocs\u002Fmigration\u002Fnode-red-tools",[],{"title":1423,"path":1424,"order":1089,"children":1425},"user","\u002Fdocs\u002Fuser",[1426,1430,1434,1438,1442,1447,1451,1455,1459,1463,1467,1471,1483,1487,1491,1495,1499,1503,1507,1511,1515,1519,1523,1527,1531,1535,1538,1542],{"title":1427,"path":1428,"order":147,"children":1429},"Getting Started","\u002Fdocs\u002Fuser\u002Fintroduction",[],{"title":1431,"path":1432,"order":147,"children":1433},"Static asset service","\u002Fdocs\u002Fuser\u002Fstatic-asset-service",[],{"title":1435,"path":1436,"order":195,"children":1437},"Bill of Materials","\u002Fdocs\u002Fuser\u002Fbill-of-materials",[],{"title":1439,"path":1440,"order":195,"children":1441},"FlowFuse Concepts","\u002Fdocs\u002Fuser\u002Fconcepts",[],{"title":1443,"path":1444,"order":1445,"children":1446},"Instance States","\u002Fdocs\u002Fuser\u002Finstance-states",10,[],{"title":1448,"path":1449,"order":1089,"children":1450},"Changing the Stack","\u002Fdocs\u002Fuser\u002Fchangestack",[],{"title":1452,"path":1453,"order":1089,"children":1454},"Custom Hostnames","\u002Fdocs\u002Fuser\u002Fcustom-hostnames",[],{"title":1456,"path":1457,"order":1089,"children":1458},"Custom Node Packages","\u002Fdocs\u002Fuser\u002Fcustom-npm-packages",[],{"title":1460,"path":1461,"order":1089,"children":1462},"Dashboards","\u002Fdocs\u002Fuser\u002Fdashboards",[],{"title":1464,"path":1465,"order":1089,"children":1466},"DevOps Pipelines","\u002Fdocs\u002Fuser\u002Fdevops-pipelines",[],{"title":1468,"path":1469,"order":1089,"children":1470},"Environment Variables","\u002Fdocs\u002Fuser\u002Fenvvar",[],{"title":1472,"path":1473,"order":1089,"children":1474},"FlowFuse Expert","\u002Fdocs\u002Fuser\u002Fexpert",[1475,1479],{"title":1476,"path":1477,"order":1089,"children":1478},"AI in Node-RED","\u002Fdocs\u002Fuser\u002Fexpert\u002Fnode-red-embedded-ai",[],{"title":1480,"path":1481,"order":1089,"children":1482},"Chat Interface","\u002Fdocs\u002Fuser\u002Fexpert\u002Fchat",[],{"title":1484,"path":1485,"order":1089,"children":1486},"FlowFuse File Nodes","\u002Fdocs\u002Fuser\u002Ffilenodes",[],{"title":1488,"path":1489,"order":1089,"children":1490},"FlowFuse MQTT Nodes","\u002Fdocs\u002Fuser\u002Fmqtt-nodes",[],{"title":1492,"path":1493,"order":1089,"children":1494},"FlowFuse Persistent Context","\u002Fdocs\u002Fuser\u002Fpersistent-context",[],{"title":1496,"path":1497,"order":1089,"children":1498},"FlowFuse Project Nodes","\u002Fdocs\u002Fuser\u002Fprojectnodes",[],{"title":1500,"path":1501,"order":1089,"children":1502},"FlowFuse Tables","\u002Fdocs\u002Fuser\u002Fff-tables",[],{"title":1504,"path":1505,"order":1089,"children":1506},"Groups","\u002Fdocs\u002Fuser\u002Fdevice-groups",[],{"title":1508,"path":1509,"order":1089,"children":1510},"High Availability mode","\u002Fdocs\u002Fuser\u002Fhigh-availability",[],{"title":1512,"path":1513,"order":1089,"children":1514},"HTTP Access Tokens","\u002Fdocs\u002Fuser\u002Fhttp-access-tokens",[],{"title":1516,"path":1517,"order":1089,"children":1518},"Instance Settings","\u002Fdocs\u002Fuser\u002Finstance-settings",[],{"title":1520,"path":1521,"order":1089,"children":1522},"Logging","\u002Fdocs\u002Fuser\u002Flogs",[],{"title":1524,"path":1525,"order":1089,"children":1526},"Role-Based Access Control","\u002Fdocs\u002Fuser\u002Frole-based-access-control",[],{"title":1528,"path":1529,"order":1089,"children":1530},"Shared Team Library","\u002Fdocs\u002Fuser\u002Fshared-library",[],{"title":1532,"path":1533,"order":1089,"children":1534},"Snapshots","\u002Fdocs\u002Fuser\u002Fsnapshots",[],{"title":1269,"path":1536,"order":1089,"children":1537},"\u002Fdocs\u002Fuser\u002Fteambroker",[],{"title":1539,"path":1540,"order":1089,"children":1541},"Teams","\u002Fdocs\u002Fuser\u002Fteam",[],{"title":1543,"path":1544,"order":1089,"children":1545},"User Settings","\u002Fdocs\u002Fuser\u002Fuser-settings",[],1786546037895]