[{"data":1,"prerenderedAt":1118},["ShallowReactive",2],{"docs-\u002Fdocs\u002Fcontribute\u002Fdb-migrations\u002F":3,"featureCatalog":274,"docs-nav":669},{"id":4,"title":5,"body":6,"description":16,"extension":262,"layout":263,"meta":264,"navGroup":263,"navGroupOrder":263,"navOrder":263,"navTitle":265,"navigation":266,"originalPath":267,"path":268,"redirect":263,"seo":269,"stem":270,"updated":271,"version":272,"__hash__":273},"docs\u002Fdocs\u002Fcontribute\u002Fdb-migrations.md","Database Migrations",{"type":7,"value":8,"toc":252},"minimark",[9,13,17,20,25,30,38,48,70,77,83,87,90,192,199,205,218,222,225,229,232,235,239,242,245,248],[10,11,5],"h1",{"id":12},"database-migrations",[14,15,16],"p",{},"Any changes made to the database models must include migrations\nthat can modify the database state from one state to another.",[14,18,19],{},"Whilst we use Sequelize as our ORM layer, we do not use the migration tooling\nit provides - we have our own.",[21,22,24],"h2",{"id":23},"creating-migrations","Creating migrations",[26,27,29],"h3",{"id":28},"filename","Filename",[14,31,32,33,37],{},"A migration is provided as JavaScript in the directory ",[34,35,36],"code",{},"forge\u002Fdb\u002Fmigrations",".\nIts file name must follow the pattern:",[39,40,45],"pre",{"className":41,"code":43,"language":44},[42],"language-text","YYYYMMDD-nn-description.js\n","text",[34,46,43],{"__ignoreMap":47},"",[49,50,51,58,64],"ul",{},[52,53,54,57],"li",{},[34,55,56],{},"YYYYMMDD"," - the date the migration is added",[52,59,60,63],{},[34,61,62],{},"nn"," - a two digit number",[52,65,66,69],{},[34,67,68],{},"description"," - a name for the migration",[14,71,72,73,76],{},"For example ",[34,74,75],{},"20220204-01-add-billing.js",".",[14,78,79,80,82],{},"This ensures the migrations have a natural order to be applied. The ",[34,81,62],{}," part of\nthe name allows multiple migrations to be added on the same day but is kept in the\nright order.",[26,84,86],{"id":85},"structure","Structure",[14,88,89],{},"The migration code should use the following layout:",[39,91,95],{"className":92,"code":93,"language":94,"meta":47,"style":47},"language-js shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","module.exports = {\n    up: async (context) => {\n        \u002F\u002F Apply the migration\n    },\n    down: async (context) => {\n        \u002F\u002F Remove the migration\n    }\n}\n","js",[34,96,97,112,141,148,154,174,180,186],{"__ignoreMap":47},[98,99,102,106,109],"span",{"class":100,"line":101},"line",1,[98,103,105],{"class":104},"sMK4o","module.exports",[98,107,108],{"class":104}," =",[98,110,111],{"class":104}," {\n",[98,113,115,119,122,126,129,133,136,139],{"class":100,"line":114},2,[98,116,118],{"class":117},"s2Zo4","    up",[98,120,121],{"class":104},":",[98,123,125],{"class":124},"spNyl"," async",[98,127,128],{"class":104}," (",[98,130,132],{"class":131},"sHdIc","context",[98,134,135],{"class":104},")",[98,137,138],{"class":124}," =>",[98,140,111],{"class":104},[98,142,144],{"class":100,"line":143},3,[98,145,147],{"class":146},"sHwdD","        \u002F\u002F Apply the migration\n",[98,149,151],{"class":100,"line":150},4,[98,152,153],{"class":104},"    },\n",[98,155,157,160,162,164,166,168,170,172],{"class":100,"line":156},5,[98,158,159],{"class":117},"    down",[98,161,121],{"class":104},[98,163,125],{"class":124},[98,165,128],{"class":104},[98,167,132],{"class":131},[98,169,135],{"class":104},[98,171,138],{"class":124},[98,173,111],{"class":104},[98,175,177],{"class":100,"line":176},6,[98,178,179],{"class":146},"        \u002F\u002F Remove the migration\n",[98,181,183],{"class":100,"line":182},7,[98,184,185],{"class":104},"    }\n",[98,187,189],{"class":100,"line":188},8,[98,190,191],{"class":104},"}\n",[14,193,194,195,198],{},"The ",[34,196,197],{},"up"," function applies to the migration. This can be to create new tables, add columns\nto existing ones - whatever is needed.",[14,200,194,201,204],{},[34,202,203],{},"down"," function reverses the migration. It should restore the database back to\nhow it was prior to the migration.",[14,206,194,207,209,210,217],{},[34,208,132],{}," argument is an instance of ",[211,212,216],"a",{"href":213,"rel":214},"https:\u002F\u002Fsequelize.org\u002Fdocs\u002Fv6\u002Fother-topics\u002Fquery-interface\u002F",[215],"nofollow","Sequelize.QueryInterface"," that can be used to perform\noperations on the database.",[21,219,221],{"id":220},"applying-migrations","Applying migrations",[14,223,224],{},"Migrations are applied automatically at the start of the FlowFuse application. Down\nmigrations are not yet supported.",[21,226,228],{"id":227},"considerations-when-writing-migrations","Considerations when writing migrations",[14,230,231],{},"Whilst migrations give us the ability to make changes to the database, they must\nbe used with great care. A failing migration will prevent the platform from starting\nand may require manual intervention. Everything should be done to avoid that from\nhappening.",[14,233,234],{},"Certain types of migration need particular guidance and care over.",[26,236,238],{"id":237},"adding-constraints","Adding constraints",[14,240,241],{},"If a migration is adding a new constraint to an existing table, you need to consider\nvery carefully what impact that could have on an existing system with real data.",[14,243,244],{},"For example, adding a new 'unique' constraint where you cannot guarantee that\nconstraint hasn't already been broken. What strategy will you use to guard against\nthat or to help recover from it? What additional testing is needed for the migration\nto verify its behavior in those situations?",[14,246,247],{},"The preferred method to add a new unique constraint is by adding a new index to the\ndatabase. This is because SQLite doesn't provide a way to alter columns that doesn't\ninvolve dropping the whole table and triggering any cascade triggers.",[249,250,251],"style",{},"html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sHdIc, html code.shiki .sHdIc{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#EEFFFF;--shiki-default-font-style:italic;--shiki-dark:#BABED8;--shiki-dark-font-style:italic}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 .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);}",{"title":47,"searchDepth":150,"depth":150,"links":253},[254,258,259],{"id":23,"depth":114,"text":24,"children":255},[256,257],{"id":28,"depth":143,"text":29},{"id":85,"depth":143,"text":86},{"id":220,"depth":114,"text":221},{"id":227,"depth":114,"text":228,"children":260},[261],{"id":237,"depth":143,"text":238},"md",null,{},"Database migrations",true,"contribute\u002Fdb-migrations.md","\u002Fdocs\u002Fcontribute\u002Fdb-migrations",{"title":5,"description":16},"docs\u002Fcontribute\u002Fdb-migrations","2024-07-19 20:33:52 +0530","2.33.2","B5j9MXVRF2WwJwufr-0sI2-PSQqhuHh9QJDNwn49erk",{"id":275,"extension":276,"meta":277,"sections":278,"stem":667,"__hash__":668},"featureCatalog\u002Ffeature-catalog.yml","yml",{},[279,330,431,493,570,649],{"id":280,"title":281,"features":282},"ai-automation","AI & Automation",[283,293,303,313,319,325],{"id":284,"title":285,"description":286,"docsLink":287,"changelog":288,"tiers":292},"flowfuse-expert-ai","FlowFuse Expert AI","Build industrial apps with agents, and query the state of the factory with an agent. Adapt your current hardware and machines so agentic work can be done against them, without ripping and replacing what's already on the plant floor.","\u002Fdocs\u002Fuser\u002Fexpert\u002F",[289],{"url":290,"release":291},"\u002Fchangelog\u002F2026\u002F02\u002Fff-expert-update-banner\u002F","2.28",{"edge":266,"hub":266,"fleet":266},{"id":294,"title":295,"description":296,"docsLink":297,"changelog":298,"subfeature":266,"showOnPricing":301,"tiers":302},"flowfuse-expert-support-mode","Support Mode","Chat-based assistance for FlowFuse and Node-RED, including Node-RED instance management through natural language.","\u002Fdocs\u002Fuser\u002Fexpert\u002Fchat\u002F#support-mode",[299],{"url":300,"release":291},"\u002Fchangelog\u002F2026\u002F02\u002Fff-expert-debug-log-context\u002F",false,{"edge":266,"hub":266,"fleet":266},{"id":304,"title":305,"description":306,"docsLink":307,"changelog":308,"subfeature":266,"showOnPricing":301,"tiers":312},"flowfuse-expert-application-building","Application Building","Describe what you want to build and FlowFuse Expert assembles it on your workspace, adding tabs, wiring nodes, and configuring properties.","\u002Fdocs\u002Fuser\u002Fexpert\u002Fchat\u002F",[309],{"url":310,"release":311},"\u002Fchangelog\u002F2026\u002F05\u002Fexpert-application-building\u002F","2.30",{"edge":266,"hub":266,"fleet":266},{"id":314,"title":315,"description":316,"docsLink":317,"subfeature":266,"beta":266,"showOnPricing":301,"tiers":318},"flowfuse-expert-insights-mode","Insights Mode","Connects FlowFuse Expert to MCP servers in your Node-RED instances, enabling real-time data queries and actions through a single chat interface.","\u002Fdocs\u002Fuser\u002Fexpert\u002Fchat\u002F#insights-mode",{"edge":266,"hub":266,"fleet":266},{"id":320,"title":321,"description":322,"docsLink":323,"tiers":324},"mcp-servers","Agentic Operations","Expose your Node-RED flows as tools an AI agent can call directly, so agents can query the state of the factory or trigger actions without custom integration work.","\u002Fnode-red\u002Fflowfuse\u002Fmcp\u002F",{"edge":266,"hub":266,"fleet":266},{"id":326,"title":327,"description":328,"tiers":329},"onnx-integration","ONNX Integration","Run trained machine learning models directly in your flows, including on edge hardware, without sending data out to an external inference service.",{"edge":266,"hub":266,"fleet":266},{"id":331,"title":332,"features":333},"build","Build",[334,340,346,356,362,368,372,378,384,392,398,402,406,415,423],{"id":335,"title":336,"description":337,"docsLink":338,"tiers":339},"edge-development","Edge Development","Develop and test Node-RED flows directly on edge devices with a remote editor proxy.","\u002Fdocs\u002Fdevice-agent\u002Fquickstart\u002F",{"edge":266,"hub":301,"fleet":266},{"id":341,"title":342,"description":343,"docsLink":344,"tiers":345},"private-npm-registry","Custom Node-RED Nodes","Create and manage your own private npm registry for Node-RED nodes, so you can share custom nodes across your team and devices without publishing them publicly.","\u002Fdocs\u002Fuser\u002Fcustom-npm-packages\u002F",{"edge":266,"hub":266,"fleet":266},{"id":347,"title":348,"description":349,"docsLink":350,"changelog":351,"tiers":355},"flowfuse-tables","FlowFuse Tables","A managed PostgreSQL database for every application, so you can store and query structured data without standing up and maintaining your own database.","\u002Fdocs\u002Fuser\u002Fff-tables\u002F",[352],{"url":353,"release":354},"\u002Fchangelog\u002F2026\u002F07\u002Fexpert-tables-automation\u002F","2.33",{"edge":266,"hub":266,"fleet":266},{"id":357,"title":358,"description":359,"docsLink":360,"tiers":361},"persistent-files","File Storage","Store and retrieve files from your Node-RED flows, with automatic replication and backup across your devices and hosted instances.","\u002Fdocs\u002Finstall\u002Ffile-storage\u002F",{"edge":266,"hub":266,"fleet":266},{"id":363,"title":364,"description":365,"docsLink":366,"showOnPricing":301,"tiers":367},"persistent-context","Persistent Context","In-memory values defined in a Node-RED flow persist across project restarts and upgrades.","\u002Fdocs\u002Fuser\u002Fpersistent-context\u002F",{"edge":266,"hub":266,"fleet":266},{"id":369,"title":370,"showOnPricing":301,"tiers":371},"static-assets","Static Assets",{"edge":266,"hub":266,"fleet":266},{"id":373,"title":374,"description":375,"docsLink":376,"tiers":377},"team-library","Team Library","Set up standard nodes and flows that can be shared with all team members across your organisation.","\u002Fdocs\u002Fuser\u002Fshared-library\u002F",{"edge":266,"hub":266,"fleet":266},{"id":379,"title":380,"description":381,"docsLink":382,"tiers":383},"personalised-multi-user-dashboards","Personalised Multi-User Dashboards","Build applications that provide unique data to each logged-in user using personalised multi-user dashboards.","https:\u002F\u002Fdashboard.flowfuse.com\u002Fuser\u002Fmulti-tenancy.html",{"edge":266,"hub":266,"fleet":266},{"id":385,"title":386,"description":387,"changelog":388,"subfeature":266,"showOnPricing":301,"tiers":391},"dashboards-view","Dashboards View","Browse and open every dashboard across your team from a dedicated Dashboards view, at both team and application level, without leaving FlowFuse.",[389],{"url":390,"release":354},"\u002Fchangelog\u002F2026\u002F07\u002Fteam-and-application-dashboards\u002F",{"edge":266,"hub":266,"fleet":266},{"id":393,"title":394,"description":395,"docsLink":396,"tiers":397},"blueprints-converge","Blueprints","Ready-made starting points for your apps, from cross-team Converge templates to OT and IT specific blueprints.","\u002Fdocs\u002Fuser\u002Fconcepts\u002F#blueprint",{"edge":266,"hub":266,"fleet":266},{"id":399,"title":400,"subfeature":266,"showOnPricing":301,"tiers":401},"blueprints-ot-apps","Blueprints - OT APPS",{"edge":266,"hub":301,"fleet":266},{"id":403,"title":404,"subfeature":266,"showOnPricing":301,"tiers":405},"blueprints-it-apps","Blueprints - IT APPS",{"edge":301,"hub":266,"fleet":301},{"id":407,"title":408,"description":409,"changelog":410,"showOnPricing":301,"tiers":414},"immersive-editor-snapshots","Snapshot Details in Immersive Editor","View and manage snapshot details directly inside the immersive editor without leaving your editing session.",[411],{"url":412,"release":413},"\u002Fchangelog\u002F2026\u002F03\u002Fsnapshot-detail-modal-immersive-editor\u002F","2.29",{"edge":266,"hub":266,"fleet":266},{"id":416,"title":417,"description":418,"changelog":419,"showOnPricing":301,"tiers":422},"immersive-editor-drawer","Customisable Immersive Editor Drawer","Pin, move, resize, or full-screen the immersive editor drawer. Your preferences are remembered between sessions.",[420],{"url":421,"release":311},"\u002Fchangelog\u002F2026\u002F04\u002Fimmersive-editor-drawer\u002F",{"edge":266,"hub":266,"fleet":266},{"id":424,"title":425,"description":426,"changelog":427,"showOnPricing":301,"tiers":430},"embedded-editor-tab-title","Embedded Editor Browser Tab Title","The browser tab title updates to reflect the active Node-RED canvas tab when working in the embedded editor.",[428],{"url":429,"release":413},"\u002Fchangelog\u002F2026\u002F03\u002Fembedded-editor-tab-title\u002F",{"edge":266,"hub":266,"fleet":266},{"id":432,"title":433,"features":434},"deploy","Deploy",[435,441,450,456,462,468,474,480,485],{"id":436,"title":437,"description":438,"docsLink":439,"tiers":440},"hosted-instances","Cloud Instances","Run Node-RED instances managed and hosted by FlowFuse.","\u002Fdocs\u002Fuser\u002Fintroduction\u002F#creating-a-node-red-instance",{"edge":266,"hub":266,"fleet":266},{"id":442,"title":443,"description":444,"docsLink":445,"changelog":446,"tiers":449},"edge-devices","Edge Instances","Deploy and mange your Node-RED instances on edge PLCs and gateways, with full visibility and control from the cloud.","\u002Fdocs\u002Fdevice-agent\u002Fintroduction\u002F",[447],{"url":448,"release":291},"\u002Fchangelog\u002F2026\u002F02\u002Fdevice-agent-nodejs-options\u002F",{"edge":266,"hub":301,"fleet":266},{"id":451,"title":452,"description":453,"docsLink":454,"tiers":455},"custom-hostnames","Custom Hostnames","Access your Node-RED application via your own domain name.","\u002Fdocs\u002Fuser\u002Fcustom-hostnames\u002F",{"edge":301,"hub":266,"fleet":301},{"id":457,"title":458,"description":459,"docsLink":460,"tiers":461},"mqtt-broker","MQTT Broker","Manage and create MQTT clients to transport data for efficient messaging and communication within your applications.","\u002Fdocs\u002Fuser\u002Fteambroker\u002F",{"edge":266,"hub":301,"fleet":266},{"id":463,"title":464,"description":465,"docsLink":466,"showOnPricing":301,"tiers":467},"project-nodes","Project Nodes aka seamless project comms","FlowFuse Project Nodes enable the passing of data and messages between your Node-RED projects.","\u002Fdocs\u002Fuser\u002Fprojectnodes\u002F",{"edge":266,"hub":266,"fleet":266},{"id":469,"title":470,"description":471,"docsLink":472,"tiers":473},"devops-pipelines","DevOps Pipelines","Set up different environments for development, testing, and production Node-RED instances to support a full software delivery lifecycle.","\u002Fdocs\u002Fuser\u002Fdevops-pipelines\u002F",{"edge":266,"hub":266,"fleet":266},{"id":475,"title":476,"description":477,"docsLink":478,"tiers":479},"git-integration","Git Integration","Back up your flows to a remote Git repository through a DevOps Pipeline. Supports GitHub and Azure DevOps repositories.","\u002Fdocs\u002Fuser\u002Fdevops-pipelines\u002F#git-repository-stage",{"edge":301,"hub":266,"fleet":301},{"id":481,"title":482,"description":483,"docsLink":478,"subfeature":266,"showOnPricing":301,"tiers":484},"git-integration-github","GitHub","Push and pull snapshots to GitHub repositories through DevOps Pipeline Git Stages.",{"edge":301,"hub":266,"fleet":301},{"id":486,"title":487,"description":488,"docsLink":478,"changelog":489,"subfeature":266,"showOnPricing":301,"tiers":492},"git-integration-azure","Azure DevOps","Push and pull snapshots to Azure DevOps repositories through DevOps Pipeline Git Stages.",[490],{"url":491,"release":413},"\u002Fchangelog\u002F2026\u002F03\u002Fazure-dev-ops-gitops\u002F",{"edge":301,"hub":266,"fleet":301},{"id":494,"title":495,"features":496},"operate-maintain","Operate & Maintain",[497,503,509,514,522,526,530,535,541,547,552,558,562,566],{"id":498,"title":499,"description":500,"docsLink":501,"tiers":502},"snapshots","Snapshots & Version History","Automatic snapshots on remote devices and hosted instances, plus a full version history timeline so you can roll back to any prior state.","\u002Fdocs\u002Fuser\u002Fsnapshots\u002F",{"edge":266,"hub":266,"fleet":266},{"id":504,"title":505,"description":506,"docsLink":507,"subfeature":266,"showOnPricing":301,"tiers":508},"auto-snapshot-remote","Auto Snapshot (Remote)","Automatically capture a snapshot every time a remote instance is deployed, so you always have a recoverable history of what was running on each device.","\u002Fdocs\u002Fuser\u002Fsnapshots\u002F#auto-snapshots",{"edge":266,"hub":266,"fleet":266},{"id":510,"title":511,"description":512,"docsLink":507,"subfeature":266,"showOnPricing":301,"tiers":513},"auto-snapshot-hosted","Auto Snapshot (Hosted)","Automatically capture a snapshot every time a hosted instance is deployed, so you always have a recoverable history of what was running.",{"edge":266,"hub":266,"fleet":266},{"id":515,"title":516,"description":517,"changelog":518,"subfeature":266,"showOnPricing":301,"tiers":521},"snapshot-comparison","Snapshot Comparison","Compare two snapshots side-by-side with a navigable diff view. Step through every changed, added, or deleted node and see property and code diffs.",[519],{"url":520,"release":413},"\u002Fchangelog\u002F2026\u002F04\u002Fsnapshot-diff-viewer\u002F",{"edge":266,"hub":266,"fleet":266},{"id":523,"title":524,"subfeature":266,"showOnPricing":301,"tiers":525},"version-history-timeline","Version History Timeline",{"edge":266,"hub":266,"fleet":266},{"id":527,"title":528,"tiers":529},"unlimited-workflow-executions","Unlimited Workflow Executions",{"edge":266,"hub":266,"fleet":266},{"id":531,"title":532,"description":533,"tiers":534},"device-fleet-updates","Device Fleet Updates","Connect to edge devices to quickly assess and update logic. Debug one device and roll out improvements to your fleet in minutes, securely without requiring full device access for your whole organisation.",{"edge":266,"hub":301,"fleet":266},{"id":536,"title":537,"description":538,"docsLink":539,"tiers":540},"device-group-management","Device Group Management","Logically group devices assigned to an application and integrate device groups into your DevOps Pipeline for coordinated fleet updates.","\u002Fdocs\u002Fuser\u002Fdevice-groups\u002F",{"edge":266,"hub":301,"fleet":266},{"id":542,"title":543,"description":544,"docsLink":545,"tiers":546},"high-availability","High Availability","Leverage horizontal scaling for reliable and scalable processing of your data through Node-RED.","\u002Fdocs\u002Fuser\u002Fhigh-availability\u002F",{"edge":301,"hub":266,"fleet":301},{"id":548,"title":549,"description":550,"tiers":551},"performance-monitoring","Performance Monitoring & Alerts","Track CPU, memory, and event loop performance across your instances and devices, with email alerts when something needs your attention.",{"edge":266,"hub":266,"fleet":266},{"id":553,"title":554,"description":555,"docsLink":556,"subfeature":266,"showOnPricing":301,"tiers":557},"instance-monitoring","Instance Monitoring","Enable alerts to be sent via email when your Node-RED instances encounter issues.","\u002Fdocs\u002Fuser\u002Finstance-settings\u002F#alerts",{"edge":266,"hub":266,"fleet":266},{"id":559,"title":560,"subfeature":266,"showOnPricing":301,"tiers":561},"email-alerts","Email Alerts",{"edge":266,"hub":266,"fleet":266},{"id":563,"title":564,"showOnPricing":301,"tiers":565},"api-debug-length-limit","API\u002FDebug Length Limit",{"edge":266,"hub":266,"fleet":266},{"id":567,"title":568,"tiers":569},"protected-instances","Protected Instances",{"edge":301,"hub":266,"fleet":301},{"id":571,"title":572,"features":573},"govern-secure","Govern and Secure",[574,583,589,595,600,606,612,618,626,632,638,644],{"id":575,"title":576,"description":577,"docsLink":578,"changelog":579,"tiers":582},"single-sign-on","Single Sign-On (SSO)","Configure FlowFuse to work with your own SSO provider, allowing users to access FlowFuse with a single set of login credentials.","\u002Fdocs\u002Fadmin\u002Fsso\u002F",[580],{"url":581,"release":354},"\u002Fchangelog\u002F2026\u002F07\u002Fapplication-sso-groups\u002F",{"edge":266,"hub":266,"fleet":266},{"id":584,"title":585,"description":586,"docsLink":587,"tiers":588},"two-factor-authentication","Two-Factor Authentication","Two-factor authentication adds an extra layer of security to your FlowFuse account.","\u002Fdocs\u002Fuser\u002Fuser-settings\u002F#two-factor-authentication",{"edge":266,"hub":266,"fleet":266},{"id":590,"title":591,"description":592,"docsLink":593,"tiers":594},"certified-nodes-it","Certified Nodes - IT","IT certified node bundle includes: Redis, MQTT, HTTP Request, AI nodes (Gemini, Claude, ChatGPT, Ollama), MCP Server","\u002Fblog\u002F2025\u002F07\u002Fcertified-nodes-v2\u002F",{"edge":301,"hub":266,"fleet":266},{"id":596,"title":597,"description":598,"tiers":599},"certified-nodes-ot","Certified OT Connections - OPC-UA, Modbus, etc.","OT certified node bundle includes: OPC-UA, Modbus TCP & RTU, RTSP, EtherNet\u002FIP, AI nodes (Gemini, Claude, ChatGPT, Ollama), MCP Server",{"edge":266,"hub":301,"fleet":301},{"id":601,"title":602,"description":603,"docsLink":604,"tiers":605},"audit-log","Audit Log","Keep track of everything going on in your Node-RED instances and FlowFuse. Audit Logs provide details on what actions have taken place, when they happened, and who did them.","\u002Fdocs\u002Fuser\u002Flogs\u002F#audit-log",{"edge":266,"hub":266,"fleet":266},{"id":607,"title":608,"description":609,"docsLink":610,"tiers":611},"role-based-access-control","Role-Based Access Control","Control who can do what at both the team and application level, from viewers to admins.","\u002Fdocs\u002Fuser\u002Frole-based-access-control\u002F",{"edge":266,"hub":266,"fleet":266},{"id":613,"title":614,"description":615,"docsLink":616,"subfeature":266,"showOnPricing":301,"tiers":617},"application-level-rbac","Application-Level RBAC","Fine-grained access control per application, allowing team members to have different permission levels across different applications without requiring separate teams.","\u002Fdocs\u002Fuser\u002Frole-based-access-control\u002F#application-level-rbac",{"edge":266,"hub":266,"fleet":266},{"id":619,"title":620,"description":621,"changelog":622,"subfeature":266,"showOnPricing":301,"tiers":625},"scoped-personal-access-tokens","Scoped Personal Access Tokens","Restrict a Personal Access Token to specific teams, limit it to read-only operations, or control whether it carries admin privileges.",[623],{"url":624,"release":354},"\u002Fchangelog\u002F2026\u002F07\u002Fscoped-pats\u002F",{"edge":266,"hub":266,"fleet":266},{"id":627,"title":628,"description":629,"docsLink":630,"showOnPricing":301,"tiers":631},"team-members","Team Members","Invite multiple team members to collaborate on the same Node-RED flows.","\u002Fdocs\u002Fuser\u002Fteam\u002F#teams",{"edge":266,"hub":266,"fleet":266},{"id":633,"title":634,"description":635,"docsLink":636,"showOnPricing":301,"tiers":637},"endpoint-security","Endpoint Security","Secure HTTP endpoints for hosted Node-RED instances using FlowFuse credentials.","\u002Fdocs\u002Fuser\u002Finstance-settings\u002F#security",{"edge":266,"hub":266,"fleet":266},{"id":639,"title":640,"description":641,"docsLink":642,"tiers":643},"baa-for-hipaa","BAA for HIPAA","FlowFuse can sign a Business Associate Agreement to ensure proper safeguarding of protected health information handled on your behalf.","\u002Fhandbook\u002Fsales\u002Fsubscription-agreement-1.5\u002F",{"edge":301,"hub":266,"fleet":301},{"id":645,"title":646,"description":647,"tiers":648},"sbom","Software Bill of Materials","A complete list of all software components used in your Node-RED instances and hosted applications, including version numbers and license information.",{"edge":301,"hub":266,"fleet":301},{"id":650,"title":651,"features":652},"support","Support",[653,658,662],{"id":654,"title":655,"docsLink":656,"tiers":657},"installation-support","Installation Support","\u002Fdocs\u002Finstall\u002Fintroduction\u002F#do-you-need-help-installation-service",{"edge":266,"hub":266,"fleet":266},{"id":659,"title":660,"showOnPricing":301,"tiers":661},"live-chat-support","Live Chat Support",{"edge":266,"hub":266,"fleet":266},{"id":663,"title":664,"docsLink":665,"tiers":666},"enterprise-support","Enterprise Support","\u002Fdocs\u002Fpremium-support\u002F",{"edge":266,"hub":266,"fleet":266},"feature-catalog","0AnkhTIPCECCwP9NmbTWP5HvRYx4FTSao4lG93-HaWM",[670,677,696,706],{"name":671,"order":101,"children":672},"FlowFuse User Manuals",[673],{"title":674,"path":675,"group":671,"groupOrder":101,"order":114,"children":676},"FlowFuse API","\u002Fdocs\u002Fapi",[],{"name":678,"order":150,"children":679},"FlowFuse Self-Hosted",[680,684],{"title":681,"path":682,"group":678,"groupOrder":150,"order":101,"children":683},"Quick Start","\u002Fdocs\u002Fquick-start",[],{"title":685,"path":686,"group":678,"groupOrder":150,"order":143,"children":687},"Upgrading FlowFuse","\u002Fdocs\u002Fupgrade",[688,692],{"title":689,"path":690,"order":263,"children":691},"Installing a license","\u002Fdocs\u002Fupgrade\u002Fopen-source-to-premium",[],{"title":693,"path":694,"order":263,"children":695},"Upgrading the Node-RED version","\u002Fdocs\u002Fupgrade\u002Fnodered-version",[],{"name":651,"order":156,"children":697},[698,702],{"title":699,"path":700,"group":651,"groupOrder":156,"order":143,"children":701},"Premium Support","\u002Fdocs\u002Fpremium-support",[],{"title":703,"path":704,"group":651,"groupOrder":156,"order":263,"children":705},"Debugging Node-RED issues","\u002Fdocs\u002Fdebugging",[],{"name":707,"order":263,"children":708},"Other",[709,757,769,846,894,913,987,998],{"title":710,"path":711,"order":263,"children":712},"admin","\u002Fdocs\u002Fadmin",[713,717,729,737,741,745,749,753],{"title":714,"path":715,"order":101,"children":716},"Administering FlowFuse","\u002Fdocs\u002Fadmin\u002Fintroduction",[],{"title":718,"path":719,"order":263,"children":720},"Configuring Single Sign-On (SSO)","\u002Fdocs\u002Fadmin\u002Fsso",[721,725],{"title":722,"path":723,"order":263,"children":724},"LDAP SSO","\u002Fdocs\u002Fadmin\u002Fsso\u002Fldap",[],{"title":726,"path":727,"order":263,"children":728},"SAML SSO","\u002Fdocs\u002Fadmin\u002Fsso\u002Fsaml",[],{"title":730,"path":731,"order":263,"children":732},"hardening","\u002Fdocs\u002Fadmin\u002Fhardening",[733],{"title":734,"path":735,"order":263,"children":736},"Kubernetes Hardening","\u002Fdocs\u002Fadmin\u002Fhardening\u002Fkubernetes",[],{"title":738,"path":739,"order":263,"children":740},"Monitoring","\u002Fdocs\u002Fadmin\u002Fmonitoring",[],{"title":742,"path":743,"order":263,"children":744},"Observability","\u002Fdocs\u002Fadmin\u002Fobservability",[],{"title":746,"path":747,"order":263,"children":748},"Soft Launch Enablement","\u002Fdocs\u002Fadmin\u002Ffeature-flags",[],{"title":750,"path":751,"order":263,"children":752},"Telemetry","\u002Fdocs\u002Fadmin\u002Ftelemetry",[],{"title":754,"path":755,"order":263,"children":756},"User Management","\u002Fdocs\u002Fadmin\u002Fuser-management",[],{"title":758,"path":759,"order":263,"children":760},"cloud","\u002Fdocs\u002Fcloud",[761,765],{"title":762,"path":763,"order":101,"children":764},"Introduction","\u002Fdocs\u002Fcloud\u002Fintroduction",[],{"title":766,"path":767,"order":263,"children":768},"FlowFuse Cloud Billing","\u002Fdocs\u002Fcloud\u002Fbilling",[],{"title":770,"path":771,"order":263,"children":772},"contribute","\u002Fdocs\u002Fcontribute",[773,776,780,784,788,790,794,802,838,842],{"title":762,"path":774,"order":101,"children":775},"\u002Fdocs\u002Fcontribute\u002Fintroduction",[],{"title":777,"path":778,"order":263,"children":779},"Adding Template Settings","\u002Fdocs\u002Fcontribute\u002Fadding-template-settings",[],{"title":781,"path":782,"order":263,"children":783},"API Design","\u002Fdocs\u002Fcontribute\u002Fapi-design",[],{"title":785,"path":786,"order":263,"children":787},"Creating debug stack containers","\u002Fdocs\u002Fcontribute\u002Fcreating-debug-stack-containers",[],{"title":265,"path":268,"order":263,"children":789},[],{"title":791,"path":792,"order":263,"children":793},"FlowFuse Architecture","\u002Fdocs\u002Fcontribute\u002Farchitecture",[],{"title":795,"path":796,"order":263,"children":797},"Local Install","\u002Fdocs\u002Fcontribute\u002Flocal",[798],{"title":799,"path":800,"order":263,"children":801},"Local Stacks","\u002Fdocs\u002Fcontribute\u002Flocal\u002Fstacks",[],{"title":803,"path":804,"order":263,"children":805},"State Flows","\u002Fdocs\u002Fcontribute\u002Fworkflows",[806,810,814,818,822,826,830,834],{"title":807,"path":808,"order":263,"children":809},"Device Editor","\u002Fdocs\u002Fcontribute\u002Fworkflows\u002Fdevice-editor",[],{"title":811,"path":812,"order":263,"children":813},"Instance states","\u002Fdocs\u002Fcontribute\u002Fworkflows\u002Fproject-states",[],{"title":815,"path":816,"order":263,"children":817},"Invite External Users","\u002Fdocs\u002Fcontribute\u002Fworkflows\u002Finvite-external-user",[],{"title":819,"path":820,"order":263,"children":821},"Project Creation","\u002Fdocs\u002Fcontribute\u002Fworkflows\u002Fproject-create",[],{"title":823,"path":824,"order":263,"children":825},"Reset Password Flow","\u002Fdocs\u002Fcontribute\u002Fworkflows\u002Fpassword-reset",[],{"title":827,"path":828,"order":263,"children":829},"Team creation Flow","\u002Fdocs\u002Fcontribute\u002Fworkflows\u002Fteam-create",[],{"title":831,"path":832,"order":263,"children":833},"User Login Flows","\u002Fdocs\u002Fcontribute\u002Fworkflows\u002Flogin",[],{"title":835,"path":836,"order":263,"children":837},"User Sign up Flow","\u002Fdocs\u002Fcontribute\u002Fworkflows\u002Fsignup",[],{"title":839,"path":840,"order":263,"children":841},"Team Broker","\u002Fdocs\u002Fcontribute\u002Fteam-broker",[],{"title":843,"path":844,"order":263,"children":845},"Working with Feature Flags","\u002Fdocs\u002Fcontribute\u002Ffeature-flags",[],{"title":847,"path":848,"order":263,"children":849},"device-agent","\u002Fdocs\u002Fdevice-agent",[850,854,857,861,865,869],{"title":851,"path":852,"order":101,"children":853},"FlowFuse Device Agent Introduction","\u002Fdocs\u002Fdevice-agent\u002Fintroduction",[],{"title":681,"path":855,"order":114,"children":856},"\u002Fdocs\u002Fdevice-agent\u002Fquickstart",[],{"title":858,"path":859,"order":150,"children":860},"Register your Remote Instance","\u002Fdocs\u002Fdevice-agent\u002Fregister",[],{"title":862,"path":863,"order":156,"children":864},"Running the Agent","\u002Fdocs\u002Fdevice-agent\u002Frunning",[],{"title":866,"path":867,"order":176,"children":868},"Deploying your Flows","\u002Fdocs\u002Fdevice-agent\u002Fdeploy",[],{"title":870,"path":871,"order":263,"children":872},"install","\u002Fdocs\u002Fdevice-agent\u002Finstall",[873,878,882,886,890],{"title":874,"path":875,"group":876,"order":101,"children":877},"Overview","\u002Fdocs\u002Fdevice-agent\u002Finstall\u002Foverview","DeviceAgentInstallation",[],{"title":879,"path":880,"group":876,"order":114,"children":881},"Device Agent Installer","\u002Fdocs\u002Fdevice-agent\u002Finstall\u002Fdevice-agent-installer",[],{"title":883,"path":884,"group":876,"order":143,"children":885},"Docker Install","\u002Fdocs\u002Fdevice-agent\u002Finstall\u002Fdocker",[],{"title":887,"path":888,"group":876,"order":150,"children":889},"Kubernetes Install","\u002Fdocs\u002Fdevice-agent\u002Finstall\u002Fkubernetes",[],{"title":891,"path":892,"group":876,"order":156,"children":893},"Manual Install with NPM","\u002Fdocs\u002Fdevice-agent\u002Finstall\u002Fmanual",[],{"title":895,"path":896,"order":263,"children":897},"hardware","\u002Fdocs\u002Fhardware",[898,901,905,909],{"title":874,"path":899,"order":101,"children":900},"\u002Fdocs\u002Fhardware\u002Fintroduction",[],{"title":902,"path":903,"order":114,"children":904},"ctrlX - Node-RED","\u002Fdocs\u002Fhardware\u002Fctrlx-node-red",[],{"title":906,"path":907,"order":143,"children":908},"ctrlX - Device Agent","\u002Fdocs\u002Fhardware\u002Fctrlx-device-agent",[],{"title":910,"path":911,"order":143,"children":912},"Raspberry Pi with Raspbian","\u002Fdocs\u002Fhardware\u002Fraspbian",[],{"title":870,"path":914,"order":263,"children":915},"\u002Fdocs\u002Finstall",[916,919,923,927,947,951,955,959],{"title":874,"path":917,"order":101,"children":918},"\u002Fdocs\u002Finstall\u002Fintroduction",[],{"title":920,"path":921,"order":263,"children":922},"Configuring FlowFuse","\u002Fdocs\u002Finstall\u002Fconfiguration",[],{"title":924,"path":925,"order":263,"children":926},"DNS Setup","\u002Fdocs\u002Finstall\u002Fdns-setup",[],{"title":928,"path":929,"order":263,"children":930},"Docker install","\u002Fdocs\u002Finstall\u002Fdocker",[931,935,939,943],{"title":932,"path":933,"order":263,"children":934},"Add Project Stacks on Docker","\u002Fdocs\u002Finstall\u002Fdocker\u002Fstacks",[],{"title":936,"path":937,"order":263,"children":938},"Docker Engine on Windows","\u002Fdocs\u002Finstall\u002Fdocker\u002Fwindows-docker-ce",[],{"title":940,"path":941,"order":263,"children":942},"Docker from AWS Market Place","\u002Fdocs\u002Finstall\u002Fdocker\u002Faws-marketplace",[],{"title":944,"path":945,"order":263,"children":946},"Docker on Digital Ocean","\u002Fdocs\u002Finstall\u002Fdocker\u002Fdigital-ocean",[],{"title":948,"path":949,"order":263,"children":950},"Email configuration","\u002Fdocs\u002Finstall\u002Femail-providers",[],{"title":952,"path":953,"order":263,"children":954},"First Run Setup","\u002Fdocs\u002Finstall\u002Ffirst-run",[],{"title":956,"path":957,"order":263,"children":958},"FlowFuse File Storage","\u002Fdocs\u002Finstall\u002Ffile-storage",[],{"title":960,"path":961,"order":263,"children":962},"Install FlowFuse on Kubernetes","\u002Fdocs\u002Finstall\u002Fkubernetes",[963,967,971,975,979,983],{"title":964,"path":965,"order":263,"children":966},"AWS EKS Installation","\u002Fdocs\u002Finstall\u002Fkubernetes\u002Faws",[],{"title":968,"path":969,"order":263,"children":970},"AWS EKS Installation with Terraform and Helm","\u002Fdocs\u002Finstall\u002Fkubernetes\u002Faws-terraform",[],{"title":972,"path":973,"order":263,"children":974},"Digital Ocean Kubernetes Installation","\u002Fdocs\u002Finstall\u002Fkubernetes\u002Fdigital-ocean",[],{"title":976,"path":977,"order":263,"children":978},"Ingress Controller Migration","\u002Fdocs\u002Finstall\u002Fkubernetes\u002Fingress-controller-migration",[],{"title":980,"path":981,"order":263,"children":982},"Kubernetes Project Stacks","\u002Fdocs\u002Finstall\u002Fkubernetes\u002Fstacks",[],{"title":984,"path":985,"order":263,"children":986},"OpenShift Installation","\u002Fdocs\u002Finstall\u002Fkubernetes\u002Fopenshift",[],{"title":988,"path":989,"order":263,"children":990},"migration","\u002Fdocs\u002Fmigration",[991,994],{"title":762,"path":992,"order":101,"children":993},"\u002Fdocs\u002Fmigration\u002Fintroduction",[],{"title":995,"path":996,"order":263,"children":997},"Node-RED Tools plugin","\u002Fdocs\u002Fmigration\u002Fnode-red-tools",[],{"title":999,"path":1000,"order":263,"children":1001},"user","\u002Fdocs\u002Fuser",[1002,1006,1010,1014,1018,1023,1027,1030,1034,1038,1041,1045,1057,1061,1065,1069,1073,1076,1080,1084,1088,1092,1096,1099,1103,1107,1110,1114],{"title":1003,"path":1004,"order":101,"children":1005},"Getting Started","\u002Fdocs\u002Fuser\u002Fintroduction",[],{"title":1007,"path":1008,"order":101,"children":1009},"Static asset service","\u002Fdocs\u002Fuser\u002Fstatic-asset-service",[],{"title":1011,"path":1012,"order":114,"children":1013},"Bill of Materials","\u002Fdocs\u002Fuser\u002Fbill-of-materials",[],{"title":1015,"path":1016,"order":114,"children":1017},"FlowFuse Concepts","\u002Fdocs\u002Fuser\u002Fconcepts",[],{"title":1019,"path":1020,"order":1021,"children":1022},"Instance States","\u002Fdocs\u002Fuser\u002Finstance-states",10,[],{"title":1024,"path":1025,"order":263,"children":1026},"Changing the Stack","\u002Fdocs\u002Fuser\u002Fchangestack",[],{"title":452,"path":1028,"order":263,"children":1029},"\u002Fdocs\u002Fuser\u002Fcustom-hostnames",[],{"title":1031,"path":1032,"order":263,"children":1033},"Custom Node Packages","\u002Fdocs\u002Fuser\u002Fcustom-npm-packages",[],{"title":1035,"path":1036,"order":263,"children":1037},"Dashboards","\u002Fdocs\u002Fuser\u002Fdashboards",[],{"title":470,"path":1039,"order":263,"children":1040},"\u002Fdocs\u002Fuser\u002Fdevops-pipelines",[],{"title":1042,"path":1043,"order":263,"children":1044},"Environment Variables","\u002Fdocs\u002Fuser\u002Fenvvar",[],{"title":1046,"path":1047,"order":263,"children":1048},"FlowFuse Expert","\u002Fdocs\u002Fuser\u002Fexpert",[1049,1053],{"title":1050,"path":1051,"order":263,"children":1052},"AI in Node-RED","\u002Fdocs\u002Fuser\u002Fexpert\u002Fnode-red-embedded-ai",[],{"title":1054,"path":1055,"order":263,"children":1056},"Chat Interface","\u002Fdocs\u002Fuser\u002Fexpert\u002Fchat",[],{"title":1058,"path":1059,"order":263,"children":1060},"FlowFuse File Nodes","\u002Fdocs\u002Fuser\u002Ffilenodes",[],{"title":1062,"path":1063,"order":263,"children":1064},"FlowFuse MQTT Nodes","\u002Fdocs\u002Fuser\u002Fmqtt-nodes",[],{"title":1066,"path":1067,"order":263,"children":1068},"FlowFuse Persistent Context","\u002Fdocs\u002Fuser\u002Fpersistent-context",[],{"title":1070,"path":1071,"order":263,"children":1072},"FlowFuse Project Nodes","\u002Fdocs\u002Fuser\u002Fprojectnodes",[],{"title":348,"path":1074,"order":263,"children":1075},"\u002Fdocs\u002Fuser\u002Fff-tables",[],{"title":1077,"path":1078,"order":263,"children":1079},"Groups","\u002Fdocs\u002Fuser\u002Fdevice-groups",[],{"title":1081,"path":1082,"order":263,"children":1083},"High Availability mode","\u002Fdocs\u002Fuser\u002Fhigh-availability",[],{"title":1085,"path":1086,"order":263,"children":1087},"HTTP Access Tokens","\u002Fdocs\u002Fuser\u002Fhttp-access-tokens",[],{"title":1089,"path":1090,"order":263,"children":1091},"Instance Settings","\u002Fdocs\u002Fuser\u002Finstance-settings",[],{"title":1093,"path":1094,"order":263,"children":1095},"Logging","\u002Fdocs\u002Fuser\u002Flogs",[],{"title":608,"path":1097,"order":263,"children":1098},"\u002Fdocs\u002Fuser\u002Frole-based-access-control",[],{"title":1100,"path":1101,"order":263,"children":1102},"Shared Team Library","\u002Fdocs\u002Fuser\u002Fshared-library",[],{"title":1104,"path":1105,"order":263,"children":1106},"Snapshots","\u002Fdocs\u002Fuser\u002Fsnapshots",[],{"title":839,"path":1108,"order":263,"children":1109},"\u002Fdocs\u002Fuser\u002Fteambroker",[],{"title":1111,"path":1112,"order":263,"children":1113},"Teams","\u002Fdocs\u002Fuser\u002Fteam",[],{"title":1115,"path":1116,"order":263,"children":1117},"User Settings","\u002Fdocs\u002Fuser\u002Fuser-settings",[],1786717926125]