Streamline Configuration

AI-Generated Content

This documentation page was initially generated by AI to bootstrap the documentation structure. Content may be incomplete or contain inaccuracies. We welcome contributions to improve it.

This guide covers all configuration options for Streamline.

Configuration File

Streamline uses YAML for configuration:

# config.yaml

server:
  port: 8080
  host: "0.0.0.0"

services:
  chase:
    url: "http://chase:3000"
    enabled: true
    healthCheck:
      interval: 30s
      timeout: 5s

  delegator:
    url: "http://delegator:5173"
    enabled: true
    healthCheck:
      interval: 30s
      timeout: 5s

sync:
  enabled: true
  interval: 5m
  retryAttempts: 3

logging:
  level: info
  format: json

Server Configuration

Port and Host

server:
  port: 8080        # Server port
  host: "0.0.0.0"   # Bind address

TLS (Optional)

server:
  tls:
    enabled: true
    cert: /path/to/cert.pem
    key: /path/to/key.pem

Service Connections

Adding Services

For each MUNify service:

services:
  service_name:
    url: "http://hostname:port"
    enabled: true
    apiKey: "optional-api-key"

Health Checks

Configure health monitoring:

healthCheck:
  interval: 30s      # How often to check
  timeout: 5s        # Request timeout
  retries: 3         # Retries before marking unhealthy

Synchronization

Sync Settings

sync:
  enabled: true      # Enable automatic sync
  interval: 5m       # Sync interval
  retryAttempts: 3   # Retries on failure
  retryDelay: 10s    # Delay between retries

Sync Scope

Control what data syncs:

sync:
  scope:
    users: true
    committees: true
    delegations: true
    assignments: true

Environment Variables

Override configuration via environment:

Variable	Description
STREAMLINE_PORT	Server port
CHASE_URL	CHASE service URL
DELEGATOR_URL	DELEGATOR service URL
SYNC_INTERVAL	Sync interval
LOG_LEVEL	Logging level

Logging

Log Levels

Available levels:

• debug - Detailed debugging
• info - General information
• warn - Warnings
• error - Errors only

Log Format

logging:
  level: info
  format: json       # or "text"
  output: stdout     # or file path

Docker Compose

Example Docker Compose setup:

version: '3.8'

services:
  streamline:
    image: munify/streamline:latest
    ports:
      - "8080:8080"
    volumes:
      - ./config.yaml:/app/config.yaml
    environment:
      - LOG_LEVEL=info
    depends_on:
      - chase
      - delegator

Troubleshooting

Service Not Connecting

1. Verify service URL is correct
2. Check network connectivity
3. Ensure service is running
4. Check firewall rules

Sync Failures

1. Check service health
2. Review error logs
3. Verify API permissions
4. Check data compatibility