Skip to content

File Upload Added In: v1.12.0

The File Upload widget allows users to upload files to Node-RED. The widget can be configured to accept specific file types and allow for multiple files.

Properties

PropDynamicDescription
GroupDefines which group of the UI Dashboard this widget will render in.
SizeControls the width of the dropdown with respect to the parent group. Maximum value is the width of the group.
LabelThe text shown to the user, explaining what the user should upload.
IconDefaults to "paperclip". The icon shown to the left of the input field. See the full list of icons here.
AcceptString representation of the "allow" file type selectors. See full list of options here.
MultipleAllow end-users to upload multiple files at once. Each file will be sent as a unique message.

Output

js
{
    payload: <Buffer>,
    file: {
        name: <String>,
        type: <String>,
        size: <Number>
    },
    topic: <String>,
}

Current Limitations

Currently, the File Upload widget is limited by a maximum file size defined by the Websocket connection. The default maximum here is 5MB. This can be increased by modifying the maxHttpBufferSize property in the settings.js file in the Node-RED installation directory:

dashboard: {
    maxHttpBufferSize: 1e8 // size in bytes, example: 100 MB
}

Read more about Dashboard configuration in the settings.js here.

Note that we do have plans to improve this behavior by chunking files into smaller parts, and reassembling them on the server side. This will allow for larger files to be uploaded, and will be implemented in a future release.

Example

Example of a File UploadScreenshot to show an example file input, when ready to have a file selected

Example of a File UploadScreenshot to show an example file input, when a file has been selected, and is ready for "Upload"