feat: adjust docs

Author: Randoooom

docs/.vitepress/config.ts

@@ -19,6 +19,7 @@ export default defineConfig({
           {
             text: "Configuration", items: [
               { text: "Server", link: "/docs/configuration/server" },
+              { text: "Indexer", link: "/docs/configuration/indexer" },
               { text: "Dashboard", link: "/docs/configuration/dashboard" }
             ]
           },
@@ -35,6 +36,7 @@ export default defineConfig({
             ]
           },
           { text: "Caching", link: "/docs/caching" },
+          { text: "Broker", link: "/docs/broker" },
           {
             text: "Frontend Library", link: "/docs/frontend-library", items: [
               { text: "Prompt", link: "/docs/frontend-library/prompt" },

docs/docs/broker.md

@@ -0,0 +1,96 @@
+## Broker Configuration
+
+### Background
+
+Feedback-Fusion employs an event-driven architecture where the main server component emits events that need to be processed asynchronously.
+The indexer service handles the actual processing of these events. Communication between these components flows through a broker system that ensures reliable message delivery and decouples event production from consumption.
+
+The broker implementation offers two distinct approaches:
+
+- **gRPC**: Designed for smaller deployments where simplicity matters more than scale. The server sends asynchronous gRPC requests to the indexer,
+which processes events and returns responses after completion. This approach works well for single-instance setups but doesn't scale horizontally since each server instance needs to communicate with specific indexer instances.
+
+- **Fluvio**: Built for high-performance scenarios requiring horizontal scalability. Events are published to a distributed streaming platform
+where multiple indexer instances can consume and process them concurrently. This enables dynamic scaling based on workload and provides better fault tolerance.
+Fluvio is essentially a faster, more modern alternative to Apache Kafka. See [fluvio.io](https://fluvio.io) for more details.
+
+Choose gRPC for development environments or small production setups where operational simplicity is preferred. Select Fluvio when you need to handle high event volumes across multiple server and indexer instances.
+
+### Configuration
+
+#### Fluvio Driver
+
+Configure Fluvio as your broker driver for scalable, distributed event processing:
+
+```hcl
+broker = {
+  fluvio = {
+    topic = "feedback-fusion"
+    
+    fluvio = {
+      endpoint = "127.0.0.1:9003"
+      use_spu_local_address = false
+      
+      tls = {
+        tls_policy = "disabled"
+      }
+    }
+  }
+  
+  batch_interval = 0
+}
+```
+
+#### gRPC Driver
+
+Configure gRPC as your broker driver for simple, direct communication:
+
+```hcl
+broker = {
+  grpc = {
+    endpoint = "https://grpc.example.com"
+    tls = {
+      key                      = "/path/to/key.pem"
+      certificate              = "/path/to/certificate.pem"
+      certificate_authority    = "/path/to/ca.pem"
+    }
+  }
+  max_batch_size = 10
+  batch_interval = 1000
+}
+```
+
+### Configuration Reference
+
+#### Top-Level Parameters
+
+| Parameter | Description | Default | Data Type |
+|-----------|-------------|---------|-----------|
+| fluvio | Fluvio broker driver configuration | N/A | Object |
+| grpc | gRPC broker driver configuration | N/A | Object |
+| max_batch_size | Maximum number of messages to process in a single batch | 10 | Integer |
+| batch_interval | Time interval in milliseconds to wait before processing a batch | 1000 | Integer |
+
+#### Fluvio Configuration
+
+| Parameter | Description | Default | Data Type |
+|-----------|-------------|---------|-----------|
+| fluvio | Fluvio cluster configuration object. See [FluvioClusterConfig](https://docs.rs/fluvio/latest/fluvio/config/struct.FluvioClusterConfig.html) for available options | N/A | Object |
+| topic | Topic name for event streams | "feedback-fusion" | String |
+
+#### gRPC Configuration
+
+| Parameter | Description | Default | Data Type |
+|-----------|-------------|---------|-----------|
+| endpoint | gRPC server endpoint URL | N/A | String |
+| tls | TLS configuration for secure communication | N/A | Object |
+
+#### TLS Configuration
+
+| Parameter | Description | Default | Data Type |
+|-----------|-------------|---------|-----------|
+| key | Path to TLS private key file | N/A | String |
+| certificate | Path to TLS certificate file | N/A | String |
+| certificate_authority | Path to CA certificate file | N/A | String |
+
+**Important**: You must configure exactly one broker driver. Choose either `fluvio` or `grpc` - configuring both will result in an error.

docs/docs/configuration/indexer.md

@@ -0,0 +1,71 @@
+## Indexer Configuration
+
+The indexer component processes events emitted by the main Feedback-Fusion server. Since it only consumes and processes events, its configuration is limited to the essential components needed for this task.
+
+### Configuration Structure
+
+The indexer configuration reuses the same configuration options as the main server, but only requires two sections:
+
+- **Database Configuration**: Where to store processed data
+- **Broker Configuration**: How to receive events from the server
+
+### Example Configuration
+
+```hcl
+# Database configuration (same as server)
+database = {
+  postgres = {
+    endpoint = "localhost:5432"
+    username = "postgres_user"
+    password = "postgres_password"
+    database = "postgres_db"
+  }
+}
+
+# Broker configuration (event consumption only)
+broker = {
+  fluvio = {
+    topic = "feedback-fusion"
+    
+    fluvio = {
+      endpoint = "127.0.0.1:9003"
+      use_spu_local_address = false
+      
+      tls = {
+        tls_policy = "disabled"
+      }
+    }
+  }
+}
+
+# OR for gRPC-based setups:
+
+broker = {
+  grpc = {
+    key                      = "/path/to/key.pem"
+    certificate              = "/path/to/certificate.pem"
+    certificate_authority    = "/path/to/ca.pem"
+  }
+}
+```
+
+### Configuration Reference
+
+#### Database Configuration
+
+Identical to the server database configuration. See [Server Configuration](/docs/configuration/server) for available database options.
+
+#### Broker Configuration (Indexer-Specific)
+
+| Parameter | Description | Default | Data Type |
+|-----------|-------------|---------|-----------|
+| fluvio | Fluvio consumer configuration | N/A | Object |
+| grpc | gRPC TLS configuration (flattened) | N/A | Object |
+
+**Note**: Unlike the server configuration, the indexer broker configuration:
+- Does not include `endpoint` for gRPC (the indexer acts as a server, not a client)
+- Does not include `max_batch_size` or `batch_interval` (these are producer-specific settings)
+- Must use the same broker driver type (`fluvio` or `grpc`) as configured in the server
+- For gRPC, the TLS parameters are flattened directly under the `grpc` object
+
+For detailed broker configuration options, see [Broker Configuration](/docs/broker).

docs/docs/configuration/server.md

@@ -223,3 +223,34 @@ preset = {
   ]
 }
 ```
+
+## Broker Configuration
+
+**Important**: The broker configuration requires exactly one driver to be configured.
+You must choose either the `fluvio` driver or the `grpc` driver - configuring both simultaneously is not supported. The configuration below shows the gRPC driver setup.
+
+```hcl
+broker = {
+  grpc = {
+    endpoint = "https://grpc.example.com"
+    tls = {
+      key                      = "/path/to/key.pem"
+      certificate              = "/path/to/certificate.pem"
+      certificate_authority    = "/path/to/ca.pem"
+    }
+  }
+  max_batch_size = 10
+  batch_interval = 1000
+}
+```
+
+### Broker Configuration Reference
+
+| Parameter | Description | Default | Data Type |
+|-----------|-------------|---------|-----------|
+| fluvio | Fluvio broker driver configuration | N/A | Object |
+| grpc | gRPC broker driver configuration | N/A | Object |
+| max_batch_size | Maximum batch size for message processing | 10 | Integer |
+| batch_interval | Batch interval in milliseconds | 1000 | Integer |
+
+For more detailed information about broker configuration options, see [Broker configuration](/docs/broker).

docs/docs/deployment/docker.md

@@ -3,7 +3,8 @@
 ## Prerequisites
 - Docker installed on your target machine. [Install Docker](https://docs.docker.com/get-docker/)
 - Docker Compose installed on your target machine. [Install Docker Compose](https://docs.docker.com/compose/install/)
-- A running database of your choice. [Supported Databases](/docs/configuration/server#database-configuration)
+- A running database of your choice. See [Database Configuration](/docs/configuration/server#database-configuration) for supported databases.
+- For Fluvio deployments: A running Fluvio cluster. See [Broker Configuration](/docs/broker) for setup instructions.
 
 ## Docker Compose Configuration
 Create a `docker-compose.yml` file with the following content:
@@ -23,9 +24,19 @@ services:
     restart: unless-stopped
     volumes:
       - /path/to/config:/path/to/container/config
+  
+  feedback-fusion-indexer:
+    image: ghcr.io/onelitefeathernet/feedback-fusion-indexer:latest
+    container_name: feedback-fusion-indexer
+    environment:
+      RUST_LOG: INFO 
+      FEEDBACK_FUSION_CONFIG: /path/to/container/config
+    restart: unless-stopped
+    volumes:
+      - /path/to/indexer-config:/path/to/container/config
 ```
 
-Refer to the [configuration documentation](/docs/configuration/server) for the config file details. 
+Refer to the [Server Configuration](/docs/configuration/server) for the main server config file details and [Indexer Configuration](/docs/configuration/indexer) for the indexer config file details.
 
 Afterwards start the application: