> For the complete documentation index, see [llms.txt](https://docs.cybus.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cybus.io/1-8-0/documentation/workbench.md).

# Workbench

Connectware ships with a running Node-RED ([https://nodered.org](https://nodered.org/)) application.

To start working with the prototyping Node-RED Workbench, on the navigation panel click `Services` and on the sidebar, click `Node Red Workbench`. This will open the running Node-RED editor for the Workbench in another browser tab.

<figure><img src="https://3008235441-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FshLLdPEhD7SHVDYSquU1%2Fuploads%2Fgit-blob-378fa0a48c2d7fc89043deac2db2a521f7e61bb0%2Fmenu_item_workbench.png?alt=media" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
However, this Node-RED workbench is not intended to be used in production-ready services but rather for quick and easy prototyping tests. In deployments where Node-RED should be used in production, the recommended setup is to create a service commissioning file which installs a Node-RED container as [Cybus::Container resource](/1-8-0/documentation/services/service-commissioning-files/structure-of-service-commissioning-files/resources/cybus-container.md) on its own. This way, the authors of the service have the full control over the versioning and life cycle of the Node-RED instance.
{% endhint %}

Further instructions on how to work with Node-RED can be found here: <https://nodered.org/docs>

For connecting the Node-RED flow to the Connectware API, Connectware can be reached by using the server name `connectware` both for MQTT (1883) and HTTPS (443) connections.

<figure><img src="https://3008235441-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FshLLdPEhD7SHVDYSquU1%2Fuploads%2Fgit-blob-575f8a89d817346775e1318e165f7225be3a106d%2Fnodered-mqtt-server.png?alt=media" alt=""><figcaption></figcaption></figure>

Additionally, when subscribing or publishing to the Connectware server, a suitable `username` and `password` has to be set manually in the Node-RED workbench. You need to ensure that the given user has sufficient permissions (or suitable roles) in order to access the topics in question. See also [User Management](/1-8-0/documentation/user-management.md).

<figure><img src="https://3008235441-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FshLLdPEhD7SHVDYSquU1%2Fuploads%2Fgit-blob-2686dae0cd451e368ef10b24b10eafb4e75afaae%2Fnodered-username.png?alt=media" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.cybus.io/1-8-0/documentation/workbench.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
