Repository navigation
Expand file tree
/
Copy path.env.example
More file actions
82 lines (68 loc) · 4.08 KB
/
Copy path.env.example
File metadata and controls
82 lines (68 loc) · 4.08 KB
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# FlowLedger — Environment Variable Template
#
# Copy this file to .env and edit the values:
# cp .env.example .env
#
# NEVER commit your .env — it is gitignored.
#
# Used by:
# docker compose --profile infra up -d (needs POSTGRES_PASSWORD only)
# docker compose --profile full up --build (needs all non-optional vars)
#
# .NET configuration uses __ (double underscore) as the section separator,
# so Mx__ApiKey in an environment variable maps to the config key Mx:ApiKey.
# ── PostgreSQL ────────────────────────────────────────────────────────────────
# Password for the 'flowledger' PostgreSQL user.
# REQUIRED for all compose profiles.
# The compose YAML constructs ConnectionStrings__flowledger from this value —
# you do NOT need to set ConnectionStrings__flowledger separately.
# Production: use a strong random value — openssl rand -hex 32
POSTGRES_PASSWORD=dev_only_change_in_prod
# ── Connection strings (set automatically by compose — no action needed) ──────
# docker-compose.yml derives these from POSTGRES_PASSWORD above.
# Uncomment ONLY if you need to override them (e.g. pointing at an external DB).
# ConnectionStrings__flowledger=Host=postgres;Port=5432;Database=flowledger;Username=flowledger;Password=dev_only_change_in_prod
# ConnectionStrings__redis=redis:6379
# ── API authentication ────────────────────────────────────────────────────────
# Shared secret that clients must send as a bearer token (config key: Api:Key).
# The Web frontend and Worker both use this to authenticate against the API.
# REQUIRED for the full-stack profile.
# Production: use a strong random value — openssl rand -hex 32
API__KEY=dev-local-key-not-for-production
# ── MX financial-data integration ────────────────────────────────────────────
#
# By default Mx__Enabled=false and the Simulated (fake-data) provider is used —
# no API credentials are needed and no MX charges are incurred.
#
# To use real bank data, set Mx__Enabled=true and fill in all fields below.
# See docs/architecture/mx-integration.md for the full walkthrough, and
# docs/self-hosting/production.md for secret-rotation guidance.
# Feature flag — false → Simulated provider, true → real MX API.
# Leave false for local dev and CI unless you specifically need live bank data.
Mx__Enabled=false
# Your MX API key (from https://dashboard.mx.com → API Keys).
# Required when Mx__Enabled=true.
Mx__ApiKey=your-mx-api-key-here
# Your MX client ID (from https://dashboard.mx.com → API Keys).
# Required when Mx__Enabled=true.
Mx__ClientId=your-mx-client-id-here
# MX base URL.
# Sandbox: https://int-api.mx.com ← use this for testing
# Production: https://api.mx.com ← use this for real users
# Required when Mx__Enabled=true.
Mx__BaseUrl=https://int-api.mx.com
# HMAC secret used to verify the signature on inbound MX webhook payloads.
# Set the matching value in your MX dashboard → Webhooks → Signing Secret.
# Required when Mx__Enabled=true.
Mx__WebhookSecret=your-mx-webhook-secret-here
# Institution code used during the MX Connect widget hand-off flow.
# "mxbank" is MX's standard sandbox test institution and is the default.
# In production the user picks their institution inside the MX Connect widget;
# override here only if your deployment uses a fixed institution code.
# Config key: Mx:Provider:DefaultInstitutionCode
Mx__Provider__DefaultInstitutionCode=mxbank
# ── OpenTelemetry (optional) ──────────────────────────────────────────────────
# OTLP endpoint for traces, metrics, and logs.
# Leave commented out to disable telemetry export (stdout logging still works).
# Example for a local collector: http://otel-collector:4317
# OTEL_EXPORTER_OTLP_ENDPOINT=