7 Commits

Author SHA1 Message Date
Joel Wetzell 79892d1372 remove trace flag from CLI help 2026-05-19 22:13:17 -05:00
Joel Wetzell d49fa50eb7 add pubsub.publish docs and cleanout nats/mqtt specific 2026-05-19 22:13:05 -05:00
Joel Wetzell e76a6f1d06 rename router.output processor 2026-05-19 22:12:35 -05:00
Joel Wetzell 42542fc217 0.1.2 2026-05-17 21:17:20 -05:00
Joel Wetzell 024cb28161 add site option for sitemap integration 2026-05-17 21:17:07 -05:00
Joel Wetzell d32b67fd4b update incorrect flag in docker 2026-05-17 21:16:58 -05:00
Joel Wetzell 5838d00c8d fix syntax 2026-05-17 21:16:45 -05:00
16 changed files with 61 additions and 106 deletions
+5 -25
View File
@@ -3,6 +3,7 @@ import { defineConfig } from "astro/config";
// https://astro.build/config
export default defineConfig({
site: "https://docs.showbridge.io",
integrations: [
starlight({
title: "showbridge",
@@ -236,30 +237,9 @@ export default defineConfig({
],
},
{
label: "MQTT",
label: "Module",
collapsed: true,
items: [
{
label: "Message",
collapsed: true,
items: [
{ autogenerate: { directory: "processors/mqtt/message" } },
],
},
],
},
{
label: "NATS",
collapsed: true,
items: [
{
label: "Message",
collapsed: true,
items: [
{ autogenerate: { directory: "processors/nats/message" } },
],
},
],
items: [{ autogenerate: { directory: "processors/module" } }],
},
{
label: "OSC",
@@ -275,9 +255,9 @@ export default defineConfig({
],
},
{
label: "Router",
label: "Pub/Sub",
collapsed: true,
items: [{ autogenerate: { directory: "processors/router" } }],
items: [{ autogenerate: { directory: "processors/pubsub" } }],
},
{
label: "Script",
+2 -2
View File
@@ -1,12 +1,12 @@
{
"name": "@showbridge/docs",
"version": "0.1.1",
"version": "0.1.2",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@showbridge/docs",
"version": "0.1.1",
"version": "0.1.2",
"devDependencies": {
"@astrojs/check": "0.9.9",
"@astrojs/starlight": "^0.39.2",
+1 -1
View File
@@ -1,7 +1,7 @@
{
"name": "@showbridge/docs",
"type": "module",
"version": "0.1.1",
"version": "0.1.2",
"files": [
"dist"
],
+1 -1
View File
@@ -29,7 +29,7 @@ routes:
params:
address: "/cue/{{.Payload.To}}/go"
- type: osc.message.encode
- type: router.output
- type: module.output
params:
module: udp
`;
+1 -1
View File
@@ -29,7 +29,7 @@ routes:
params:
address: "{{.Payload.URL.Path}}" # template the address from the incoming message
- type: osc.message.encode # turn OSC message into bytes
- type: router.output # output to the udp module
- type: module.output # output to the udp module
params:
module: udp
`;
@@ -5,7 +5,7 @@ sidebar:
order: 2
---
This processor will create a new HTTP response with the specified status code and body template. The created response will be passed through to the next processor in the chain. If the response is subsequently sent to an HTTP server module using the [router.output](../router/output.md) processor, the status code and body template set by this processor will be used for the response sent to the client. This processor will return an error if there is an issue executing the body template.
This processor will create a new HTTP response with the specified status code and body template. The created response will be passed through to the next processor in the chain. If the response is subsequently sent to an HTTP server module using the [module.output](../module/output.md) processor, the status code and body template set by this processor will be used for the response sent to the client. This processor will return an error if there is an issue executing the body template.
- **type**: `http.response.create`
- **params**:
@@ -0,0 +1,22 @@
---
title: Output to module
sidebar:
label: Output
order: 1
---
The `module.output` processor takes any payload and outputs to the specified module.
- **type**: `module.output`
- **params**:
- **module**: the id of the [module](/concepts/modules) to output to.
### Example
Output whatever payload comes through this processor to the `osc-out` module.
```yaml
- type: module.output
params:
module: osc-out
```
@@ -1,25 +0,0 @@
---
title: Create MQTT Message
sidebar:
order: 1
---
This processor will create an MQTT message from the provided parameters. This processor will return an error if any of the required parameters are missing or if the parameters are of the wrong type.
- **type**: `mqtt.message.create`
- **params**:
- **topic**: the topic to publish the message to.
- **qos**: the QoS level of the message.
- **retained**: whether the message should be retained by the broker.
- **payload**: the payload of the message. This can be a string or a byte array.
### Example
```yaml
- type: mqtt.message.create
params:
topic: "test/topic"
qos: 1
retained: false
payload: "Hello, World!"
```
@@ -1,22 +0,0 @@
---
title: Create NATS Message
sidebar:
label: Create
order: 1
---
This processor will create a NATS message from the provided parameters. This processor will return an error if any of the required parameters are missing or if the parameters are of the wrong type.
- **type**: `nats.message.create`
- **params**:
- **subject**: the subject to publish the message to.
- **payload**: the payload of the message.
### Example
```yaml
- type: nats.message.create
params:
subject: "events"
payload: "Hello, World!"
```
@@ -0,0 +1,22 @@
---
title: Publish to Pub/Sub
sidebar:
label: Publish
order: 1
---
This processor will publish the incoming payload to a Pub/Sub capable module. This processor will return an error if any of the required parameters are missing or if the parameters are of the wrong type.
- **type**: `pubsub.publish`
- **params**:
- **module**: the module to publish with.
- **topic**: the subject to publish to.
### Example
```yaml
- type: pubsub.publish
params:
module: mqtt-out
topic: "test"
```
@@ -1,22 +0,0 @@
---
title: Output from Router
sidebar:
label: Output
order: 1
---
The `router.output` processor takes any payload and outputs to the specified module.
- **type**: `router.output`
- **params**:
- **module**: the id of the [module](/concepts/modules) to output to.
### Example
Output to the `osc-out` module.
```yaml
- type: router.output
params:
module: osc-out
```
@@ -5,7 +5,7 @@ sidebar:
order: 1
---
This processor will create a SIP response message with an audio file as the payload. If this message is output to a SIP module using the [router.output](/processors/router/output) processor, then the SIP module will send the response to the caller and play the audio file included in the response.
This processor will create a SIP response message with an audio file as the payload. If this message is output to a SIP module using the [module.output](/processors/module/output) processor, then the SIP module will send the response to the caller and play the audio file included in the response.
- **type**: `sip.response.audio.create`
- **params**:
@@ -5,7 +5,7 @@ sidebar:
order: 1
---
This processor will create a SIP DTMF response from the provided parameters. If this message is output to a SIP module using the [router.output](/processors/router/output) processor, then the SIP module will send the response to the caller and play the DTMF tones specified.
This processor will create a SIP DTMF response from the provided parameters. If this message is output to a SIP module using the [module.output](/processors/module/output) processor, then the SIP module will send the response to the caller and play the DTMF tones specified.
- **type**: `sip.response.dtmf.create`
- **params**:
-1
View File
@@ -40,7 +40,6 @@ GLOBAL OPTIONS:
--config string path to config file (default: "./config.yaml") [$SHOWBRIDGE_CONFIG]
--log-level string set log level (default: "info") [$SHOWBRIDGE_LOG_LEVEL]
--log-format string log format to use (default: "text") [$SHOWBRIDGE_LOG_FORMAT]
--trace enable OpenTelemetry tracing [$SHOWBRIDGE_TRACE]
--help, -h show help
--version, -v print the version
```
+2 -2
View File
@@ -4,14 +4,14 @@ sidebar:
order: 2
---
import { Steps, Code } from "@astrojs/starlight/components";
import { Code, Steps } from "@astrojs/starlight/components";
<Steps>
1. create a config file (see [config](/concepts/config/))
2. run
- <Code code="docker run -it -v/path/to/config.yaml:/app/config.yaml jwetzell/showbridge:latest --debug" />
- <Code code="docker run -it -v/path/to/config.yaml:/app/config.yaml jwetzell/showbridge:latest" />
- see [CLI Usage](/guides/cli-usage) for more detail on flags
- see [Docker docs](https://docs.docker.com/) for how to use docker
+2 -1
View File
@@ -15,4 +15,5 @@ import { Steps } from "@astrojs/starlight/components";
- `go run ./cmd/showbridge --config config.yaml`
- see [CLI Usage](/guides/cli-usage) for more flags
</Steps>
</Steps>