Skip to content

Commit

Permalink
fix failing linter
Browse files Browse the repository at this point in the history
Signed-off-by: nyagamunene <[email protected]>
  • Loading branch information
nyagamunene committed Dec 19, 2024
1 parent 6f4176d commit db2d02b
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ The Proxy Service acts as a bridge between MQTT and HTTP protocols in the Propel
## Overview

The proxy service performs two main functions:

1. Subscribes to MQTT topics and forwards messages to HTTP endpoints
2. Streams data between MQTT and HTTP protocols

Expand Down Expand Up @@ -61,6 +62,7 @@ The proxy service implements a concurrent streaming architecture with two main c
#### Logging System

The service includes comprehensive logging with:

- Initialization status and connection events
- Chunk transfer progress and completion
- Error reporting with detailed context
Expand Down Expand Up @@ -122,12 +124,15 @@ go run cmd/proxy/main.go
### Method 2: Installing and Running the Binary

1. Build and install the binary:

```bash
make all && make install
```

This will install the binary in your GOBIN directory (ensure your GOBIN is configured correctly).

2. Run the proxy service:

```bash
propeller-proxy
```
Expand Down

0 comments on commit db2d02b

Please sign in to comment.