# Bitpool Edge Uploader

## **Getting Started**

This is a standard Node.js module developed specifically to function within the Node-RED ecosystem.

## **How to Use**

Use the following procedure to install this module to your Node-RED instance, or download the pre-themed [Bitpool-Edge Docker](/bitpool-cloud-platform/bitpool-edge/bitpool-edge-installation.md) image that contains all our favourite nodes pre-installed.

### **Bitpool-Edge Install**

1. Log into your Bitpool-Edge instance and click the `Hamburger` icon, in the top-right corner.
2. Select `Manage Palette` from the drop down menu then click the `Pallete->Install` tabs to install.
3. Using the search bar type `@bitpoolos/edge-uploader` and install the module once displayed.
4. Finally, use the left most navigation menu to scroll down to the heading `Bitpool Uploader` to reveal available nodes

### **Docker Install** :whale: <a href="#docker-install" id="docker-install"></a>

This Edge-Uploader module and many other Bitpool developed nodes have been pre-installed for your convenience in a Bitpool themed Node-RED application.

Go here for [how to install Bitpool-Edge](/bitpool-cloud-platform/bitpool-edge/bitpool-edge-installation.md).

### **Uploader Nodes**

The Uploader library of nodes is broken down into 2x functional blocks.

![](https://wiki.bitpool.com/~gitbook/image?url=https%3A%2F%2F3902784585-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F28eeWKJBGNSvwO7hWa0f%252Fuploads%252F1x4olYszDqho4Z6R1IUj%252Fimage.png%3Falt%3Dmedia%26token%3D60b199c4-d7ee-4a7b-a8b8-810a02825658\&width=300\&dpr=4\&quality=100\&sign=8cd19d23\&sv=2)

1. `uploader` - interacts with the Bitpool Cloud, creating pools, streams, and uploading data.
2. `metatag` - appends tags to the node red msg object, and forwards the tags to the uploader node. This enriches the data getting uploaded to the Bitpool Cloud

### **Further Information**

Now that your Bitpool-Edge is up and running, we have included simple examples flows to demonstrate how to create a basic solution.

1. Log into your Bitpool-Edge instance and click the `Hamburger` icon, in the top-right corner.
2. Select `Manage Palette` from the drop down menu then click the `Import->Examples` tabs to see this node.
3. Navigate the ‘Examples flows’ tree and select `@bitpoolos/edge-uploader` to reveal the preconfigured examples.
4. Click the example you would like to test the click the `Import` button.
5. Place the example nodes on a flow and review the configuration of each node. You will need to make suitable changes for your system.
6. Finally, click the `Save` to test.

> Additionally, there is basic helper documentation on each node. Just select a target node and click the `Help` tab found at the top right corner of Bitpool-Edge.
>
> **Hint** *- the icon looks like a book!*


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://wiki-cloud.bitpool.com/bitpool-cloud-platform/bitpool-edge/connectors/bitpool-edge-uploader.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.