brail/flowscope.env.example at main · nelsonmfinda/brail · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# FlowScope Configuration Example
# Copy this to your .env.local or .env files to enable FlowScope integration
#
# FlowScope is a local HTTP request/response viewer for debugging API traffic.
# See docs/FLOWSCOPE.md for full integration guide.

# ============================================================================
# Frontend Configuration (apps/web/.env.local)
# ============================================================================

# Enable FlowScope proxy for frontend API calls
# When true, all API calls from the Nuxt app will route through FlowScope
FLOWSCOPE_ENABLED=true

# Your backend API URL (standard Brail config)
API_URL=http://localhost:3000


# ============================================================================
# Backend Configuration (apps/api/.env) - OPTIONAL
# ============================================================================

# Enable FlowScope proxy for backend external API calls
# When true, external API calls (ACME, adapters, etc.) can be routed through FlowScope
# Requires manual integration in each service (see docs/FLOWSCOPE.md)
FLOWSCOPE_ENABLED=true

# FlowScope proxy URL (defaults to http://localhost:4317 if not set)
FLOWSCOPE_PROXY_URL=http://localhost:4317


# ============================================================================
# Quick Start
# ============================================================================
#
# 1. Install FlowScope (one-time):
#    git clone https://github.com/kagehq/flowscope.git
#    cd flowscope && docker-compose up -d
#
# 2. Copy this file:
#    cp flowscope.env.example apps/web/.env.local
#
# 3. Start Brail:
#    pnpm dev
#
# 4. Open FlowScope dashboard:
#    http://localhost:4320
#
# 5. Use Brail normally - all API requests will appear in FlowScope!
#

# ============================================================================
# When to Enable
# ============================================================================
#
# ✅ Enable when:
#    - Debugging API issues
#    - Profiling performance
#    - Testing integrations
#    - Learning the API
#
# ❌ Disable when:
#    - Running tests (adds 5-20ms latency)
#    - Not actively debugging
#    - In production (never enable in production)
#
# To disable: Set FLOWSCOPE_ENABLED=false or remove the line
#