# UMH Docs

## umh-core

- [Introduction](https://docs.umh.app/readme.md)
- [Getting Started](https://docs.umh.app/getting-started.md)
- [Step 2: Connect Data](https://docs.umh.app/getting-started/1-connect-data.md)
- [Step 3: Organize Data](https://docs.umh.app/getting-started/2-organize-data.md)
- [Step 4: Validate Data](https://docs.umh.app/getting-started/3-validate-data.md)
- [Usage](https://docs.umh.app/usage.md)
- [Instances](https://docs.umh.app/usage/instances.md)
- [Config File](https://docs.umh.app/usage/instances/config-file.md)
- [Unified Namespace](https://docs.umh.app/usage/unified-namespace.md)
- [Topic Convention](https://docs.umh.app/usage/unified-namespace/topic-convention.md)
- [Payload Formats](https://docs.umh.app/usage/unified-namespace/payload-formats.md)
- [Metadata and Tracing](https://docs.umh.app/usage/unified-namespace/metadata-and-tracing.md)
- [Topic Browser](https://docs.umh.app/usage/unified-namespace/topic-browser.md)
- [Data Flows](https://docs.umh.app/usage/data-flows.md)
- [Bridges](https://docs.umh.app/usage/data-flows/bridges.md)
- [Bridges Do Not Start](https://docs.umh.app/usage/data-flows/bridges/bridges-do-not-start.md)
- [Stand-alone Flow](https://docs.umh.app/usage/data-flows/stand-alone-flow.md)
- [Stream Processors](https://docs.umh.app/usage/data-flows/stream-processor.md)
- [Data Modeling](https://docs.umh.app/usage/data-modeling.md)
- [Data Models](https://docs.umh.app/usage/data-modeling/data-models.md)
- [Data Contracts](https://docs.umh.app/usage/data-modeling/data-contracts.md)
- [Payload Shapes](https://docs.umh.app/usage/data-modeling/payload-shapes.md)
- [Stream Processors](https://docs.umh.app/usage/data-modeling/stream-processors.md)
- [Historian](https://docs.umh.app/usage/historian.md)
- [Save data to the Historian](https://docs.umh.app/usage/historian/save-to-historian.md)
- [Query the Historian](https://docs.umh.app/usage/historian/querying.md)
- [Management Console](https://docs.umh.app/management-console.md)
- [Authentication](https://docs.umh.app/management-console/authentication.md)
- [Email Code](https://docs.umh.app/management-console/authentication/email-code.md)
- [Username and Password](https://docs.umh.app/management-console/authentication/username-and-password.md)
- [Enterprise Single Sign-On](https://docs.umh.app/management-console/authentication/enterprise-sso.md)
- [Passwords and Passphrases](https://docs.umh.app/management-console/authentication/passwords-and-passphrases.md)
- [Sessions](https://docs.umh.app/management-console/authentication/sessions.md)
- [Users and Permissions](https://docs.umh.app/management-console/users-and-permissions.md)
- [Location-Based Permissions](https://docs.umh.app/management-console/users-and-permissions/location-based-permissions.md)
- [Managing Access](https://docs.umh.app/management-console/users-and-permissions/managing-access.md)
- [Roles Reference](https://docs.umh.app/management-console/users-and-permissions/roles-reference.md)
- [Emergency Access](https://docs.umh.app/management-console/users-and-permissions/fallback-access.md)
- [Security](https://docs.umh.app/management-console/security.md)
- [Threat Model](https://docs.umh.app/management-console/security/threat-model.md)
- [Shared Responsibility](https://docs.umh.app/management-console/security/shared-responsibility.md)
- [Compliance](https://docs.umh.app/management-console/security/compliance.md)
- [Billing and Plans](https://docs.umh.app/management-console/billing-and-plans.md)
- [Plan Comparison](https://docs.umh.app/management-console/billing-and-plans/plan-comparison.md)
- [Production](https://docs.umh.app/production.md)
- [Architecture Patterns](https://docs.umh.app/production/architecture-patterns.md)
- [Redundant Data Collection](https://docs.umh.app/production/architecture-patterns/redundant-data-collection.md)
- [Deployment](https://docs.umh.app/production/deployment.md)
- [Docker](https://docs.umh.app/production/deployment/docker.md)
- [Setup](https://docs.umh.app/production/deployment/docker/setup.md)
- [Updating](https://docs.umh.app/production/deployment/docker/updating.md)
- [Docker Compose](https://docs.umh.app/production/deployment/docker-compose.md)
- [Setup](https://docs.umh.app/production/deployment/docker-compose/setup.md)
- [Additional Services](https://docs.umh.app/production/deployment/docker-compose/additional-services.md)
- [Recommended UMH Stack](https://docs.umh.app/production/deployment/docker-compose/additional-services/recommended-umh-stack.md)
- [TimescaleDB](https://docs.umh.app/production/deployment/docker-compose/additional-services/timescaledb.md)
- [Grafana](https://docs.umh.app/production/deployment/docker-compose/additional-services/grafana.md)
- [nginx](https://docs.umh.app/production/deployment/docker-compose/additional-services/nginx.md)
- [Updating](https://docs.umh.app/production/deployment/docker-compose/updating.md)
- [Sizing Guide](https://docs.umh.app/production/sizing-guide.md)
- [CPU Health](https://docs.umh.app/production/cpu-health.md)
- [High Availability](https://docs.umh.app/production/high-availability.md)
- [Metrics](https://docs.umh.app/production/metrics.md)
- [Migration from Classic](https://docs.umh.app/production/migration-from-classic.md)
- [Security](https://docs.umh.app/production/security.md)
- [umh-core Security](https://docs.umh.app/production/security/deployment-security.md)
- [Network Configuration](https://docs.umh.app/production/security/deployment-security/network-configuration.md)
- [Reference](https://docs.umh.app/reference.md)
- [Configuration Reference](https://docs.umh.app/reference/configuration-reference.md)
- [Data Model Type Definitions](https://docs.umh.app/reference/data-model-type-definitions.md)
- [Container Layout](https://docs.umh.app/reference/container-layout.md)
- [State Machines](https://docs.umh.app/reference/state-machines.md)
- [Environment Variables](https://docs.umh.app/reference/environment-variables.md)
- [TLS and Certificates](https://docs.umh.app/reference/tls-and-certificates.md)
- [Variables](https://docs.umh.app/reference/variables.md)
- [HTTP API Reference](https://docs.umh.app/reference/http-api.md)
- [Topic Browser GraphQL API](https://docs.umh.app/reference/http-api/topic-browser-graphql.md)
- [UMH Core vs UMH Classic](https://docs.umh.app/umh-core-vs-classic-faq.md)

## benthos-umh

- [Introduction](https://docs.umh.app/benthos-umh/readme.md)
- [Input](https://docs.umh.app/benthos-umh/input.md)
- [Sparkplug B (Input)](https://docs.umh.app/benthos-umh/input/sparkplug-b-input.md)
- [OPC UA (Input)](https://docs.umh.app/benthos-umh/input/opc-ua-input.md)
- [Modbus](https://docs.umh.app/benthos-umh/input/modbus.md)
- [ifm IO-Link Master / "sensorconnect"](https://docs.umh.app/benthos-umh/input/ifm-io-link-master-sensorconnect.md)
- [Beckhoff ADS (experimental)](https://docs.umh.app/benthos-umh/input/beckhoff-ads.md)
- [Quick start](https://docs.umh.app/benthos-umh/input/beckhoff-ads/quick-start.md)
- [How it works](https://docs.umh.app/benthos-umh/input/beckhoff-ads/how-it-works.md)
- [Configuration](https://docs.umh.app/benthos-umh/input/beckhoff-ads/configuration.md)
- [Symbols and metadata](https://docs.umh.app/benthos-umh/input/beckhoff-ads/symbols-and-metadata.md)
- [Networking](https://docs.umh.app/benthos-umh/input/beckhoff-ads/networking.md)
- [Troubleshooting](https://docs.umh.app/benthos-umh/input/beckhoff-ads/troubleshooting.md)
- [Siemens S7](https://docs.umh.app/benthos-umh/input/siemens-s7.md)
- [Ethernet/IP](https://docs.umh.app/benthos-umh/input/ethernet-ip.md)
- [UNS Input](https://docs.umh.app/benthos-umh/input/uns-input.md)
- [Libraries](https://docs.umh.app/benthos-umh/libraries.md)
- [UMH Topic Parser](https://docs.umh.app/benthos-umh/libraries/umh-topic-parser.md)
- [Processing](https://docs.umh.app/benthos-umh/processing.md)
- [Tag Processor](https://docs.umh.app/benthos-umh/processing/tag-processor.md)
- [Classic to Core Processor](https://docs.umh.app/benthos-umh/processing/classic-to-core-processor.md)
- [Downsampler](https://docs.umh.app/benthos-umh/processing/downsampler.md)
- [Topic Browser](https://docs.umh.app/benthos-umh/processing/topic-browser.md)
- [Stream Processor](https://docs.umh.app/benthos-umh/processing/stream-processor.md)
- [Node-RED JavaScript Processor](https://docs.umh.app/benthos-umh/processing/node-red-javascript-processor.md)
- [JavaScript API Reference](https://docs.umh.app/benthos-umh/processing/javascript-api.md)
- [Output](https://docs.umh.app/benthos-umh/output.md)
- [Sparkplug B (Output)](https://docs.umh.app/benthos-umh/output/sparkplug-b-output.md)
- [UNS (Output)](https://docs.umh.app/benthos-umh/output/uns-output.md)
- [OPC UA (Output)](https://docs.umh.app/benthos-umh/output/opc-ua-output.md)
- [TimescaleDB Historian (Output)](https://docs.umh.app/benthos-umh/output/historian.md)


---

# 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
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

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

```
GET https://docs.umh.app/index.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.
