> 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/readme.md).

# Cybus Connectware Documentation

Connectware connects PLCs, sensors, and machines to MES, analytics, AI, and cloud systems through a Unified Namespace (UNS), so you can deploy use cases faster and run reliable operations across all your sites. All connectivity is defined in YAML service commissioning files, versioned in Git, and deployed on Kubernetes or Docker.

## Explore the Documentation

<table data-view="cards"><thead><tr><th align="center"></th><th align="center"></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><strong>Discover Connectware</strong></td><td align="center">What Connectware is, how it works, and a hands-on start with a simulated machine.</td><td><a href="/files/tWUT5rPfZac4iYUkoLLF">/files/tWUT5rPfZac4iYUkoLLF</a></td><td><a href="/pages/xkxM3Q8d8MkPu4Sc9vXO">/pages/xkxM3Q8d8MkPu4Sc9vXO</a></td></tr><tr><td align="center"><strong>Deploying Connectware</strong></td><td align="center">Choose your platform, then install, upgrade, and license Connectware on Kubernetes or Docker.</td><td><a href="/files/fY9iTNnbI6l5n5nEMuDZ">/files/fY9iTNnbI6l5n5nEMuDZ</a></td><td><a href="/pages/vvlfoXKSYai2IgyZbHDA">/pages/vvlfoXKSYai2IgyZbHDA</a></td></tr><tr><td align="center"><strong>Access &#x26; Security</strong></td><td align="center">Users, roles, and permissions, SSO and MFA, the Client Registry, and TLS certificates.</td><td><a href="/files/z6A5qOqhaqSJQgq3O802">/files/z6A5qOqhaqSJQgq3O802</a></td><td><a href="/pages/9vRiBFNwOVFJpwdLScHr">/pages/9vRiBFNwOVFJpwdLScHr</a></td></tr><tr><td align="center"><strong>Building Data Flows</strong></td><td align="center">Services and service commissioning files, the Rule Engine, FlowSync, agents, and the Node-RED Workbench.</td><td><a href="/files/4WHVMvOLKK7sIP1DxU6B">/files/4WHVMvOLKK7sIP1DxU6B</a></td><td><a href="/pages/3Bfh1OvUl5KdkxnIOHO0">/pages/3Bfh1OvUl5KdkxnIOHO0</a></td></tr><tr><td align="center"><strong>Monitoring</strong></td><td align="center">Verify data flows with the Data Explorer and Live Data, and check system status.</td><td><a href="/files/CNaiWIFUcwS6CBsCGvl0">/files/CNaiWIFUcwS6CBsCGvl0</a></td><td><a href="/pages/Ag0TjuKKGnPrXa1wc0T3">/pages/Ag0TjuKKGnPrXa1wc0T3</a></td></tr><tr><td align="center"><strong>Connectors</strong></td><td align="center">Configuration reference for all shop floor and enterprise connectors, from OPC UA to Kafka.</td><td><a href="/files/vf6gXMdCyA6NMSLsYy8F">/files/vf6gXMdCyA6NMSLsYy8F</a></td><td><a href="/pages/9Sq0m37tJ7C6svEiiN6y">/pages/9Sq0m37tJ7C6svEiiN6y</a></td></tr><tr><td align="center"><strong>Guides</strong></td><td align="center">Step-by-step guides for machine connectivity, system integrations, and running Connectware at scale.</td><td><a href="/files/6HV05hGBO8ozeFwQciWn">/files/6HV05hGBO8ozeFwQciWn</a></td><td><a href="/pages/AarIcHMGLBvp79llhP3d">/pages/AarIcHMGLBvp79llhP3d</a></td></tr><tr><td align="center"><strong>API Reference</strong></td><td align="center">Automate everything Connectware does through its REST APIs.</td><td><a href="/files/dga7Eecmt7vfuOrOY83m">/files/dga7Eecmt7vfuOrOY83m</a></td><td><a href="/pages/3Mg0YpH6vStohgkALpzV">/pages/3Mg0YpH6vStohgkALpzV</a></td></tr><tr><td align="center"><strong>Changelog</strong></td><td align="center">New features, improvements, and fixes for every Connectware release.</td><td><a href="/files/9Qk5jO1a6O1GjYjKaHbV">/files/9Qk5jO1a6O1GjYjKaHbV</a></td><td><a href="/pages/reqXH7r2F6e4pGZPYlhN">/pages/reqXH7r2F6e4pGZPYlhN</a></td></tr></tbody></table>

## Need Help?

* [Cybus Support Portal](https://support.cybus.io)
* [Contact Cybus](https://www.cybus.io/contact)


---

# 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 dynamically by asking a question.

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

```
GET https://docs.cybus.io/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.