Skip to content

Commit 6b2e341

Browse files
committed
Add documentation for configuring the learning transport within busly
1 parent a368091 commit 6b2e341

8 files changed

Lines changed: 80 additions & 56 deletions

File tree

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Configuration",
3+
"position": 3
4+
}
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Configuration
2+
3+
busly-cli uses an application-specific configuration file to store settings such as transport configuration and operational parameters. By default, the CLI looks for the configuration file at `~/.busly-cli/config.yaml`

website/docs/getting-started/quick-start.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ busly transport current
6767
:::note
6868
This guide uses RabbitMQ for simplicity, but Busly supports multiple NServiceBus transports.
6969

70-
Check out the [Transports section](#) for other options.
70+
Check out the [Transports section](../transports/) for other options.
7171
:::
7272

7373
## Run RabbitMQ

website/docs/introduction.md

Lines changed: 0 additions & 27 deletions
This file was deleted.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
3+
"position": 3
4+
}
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Learning Transport
2+
3+
The **Learning Transport** is a simple file-based transport used mainly for local development and tutorials.
4+
5+
## Configuration
6+
7+
To use the Learning Transport, define it under `transports` and reference it as `current-transport`.
8+
9+
### Example
10+
11+
```yaml
12+
current-transport: local-learning
13+
14+
transports:
15+
- name: local-learning
16+
learning-transport-config:
17+
storage-directory: C:\Source\tutorials-quickstart\.learningtransport
18+
restrict-payload-size: true
19+
```
20+
21+
---
22+
23+
## `learning-transport-config` Fields
24+
25+
| Field | Required | Type | Default | Description |
26+
| ----------------------- | -------- | ------- | ------- | ----------------------------------------------------------------------------------------------------- |
27+
| `storage-directory` | **Yes** | string | — | Absolute path where Learning Transport stores message files. Busly will not start without this value. |
28+
| `restrict-payload-size` | No | boolean | `true` | Enforces the NServiceBus payload size limit. Set to `false` if you need to send larger payloads. |
29+
30+
---
31+
32+
## Field Details
33+
34+
### `storage-directory` (required)
35+
36+
This must be an **absolute file path**.
37+
The Learning Transport stores outgoing and incoming messages in a folder structure at this location.
38+
If this value is missing, Busly reports an error and exits.
39+
40+
Example:
41+
42+
```yaml
43+
storage-directory: C:\MyProject\.learningtransport
44+
```
45+
46+
---
47+
48+
### `restrict-payload-size` (optional, default: `true`)
49+
50+
When enabled (the default), Busly enforces the same message size limits as NServiceBus.
51+
52+
Set to `false` if using large JSON payloads or test messages.
53+
54+
Example:
55+
56+
```yaml
57+
restrict-payload-size: false
58+
```
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
import DocCardList from "@theme/DocCardList";
2+
3+
# Transports
4+
5+
Just like an NServiceBus endpoint, Busly requires a transport configuration before it can send messages. The transport determines how Busly connects to and communicates with your NServiceBus endpoints.
6+
7+
Busly supports the same transports available in NServiceBus. Each transport has its own configuration requirements and capabilities. The sections below provide detailed guides and examples for configuring each transport.
8+
9+
<DocCardList />

website/package-lock.json

Lines changed: 1 addition & 28 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)