OBP-Portal/.env.example at main · OpenBankProject/OBP-Portal · 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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
ORIGIN=http://localhost:5174

# OBP API Configuration
PUBLIC_OBP_BASE_URL="http://localhost:8080"
OBP_API_HOST=localhost:8080
OBP_API_URL=http://localhost:8080
VITE_API_URL=http://localhost:8080

# Legacy OBP API Portal for analytics
PUBLIC_CANONICAL_URL="http://localhost:8080"

# OIDC Configuration (from database: obp-portal-client)
OBP_OAUTH_CLIENT_ID=2a47cc56-0db1-409d-8f0b-131e4f94a212
OBP_OAUTH_CLIENT_SECRET=OR04Ga8uQjdzFmNXDI5QrEXHN30Fk4u6lbtbrrMsj8g
# not used OBP_OAUTH_WELL_KNOWN_URL=http://127.0.0.1:9000/obp-oidc/.well-known/openid-configuration
APP_CALLBACK_URL=http://localhost:5174/login/obp/callback

# Opey Configuration
OPEY_BASE_URL="http://localhost:5000"
PUBLIC_OPEY_BASE_URL=http://localhost:5000

##################################################################
# We need *Opey's* consumer_id (ID NOT KEY!) so the Portal can generate a consent for Opey to use.
# This the ID of the consumer that matches a consumer in the OBP database
# Opey sends its CONSUMER_KEY in the header or sends a certificate
OPEY_CONSUMER_ID="74545fb7-9a1f-4ee0-beb4-6e5b7ee50076"

############################################################

# External URLs
API_EXPLORER_URL="https://test-explorer-ii.openbankproject.com/?tags=&locale=en_GB"
API_MANAGER_URL="https://test-manager.openbankproject.com/"
PUBLIC_SUBSCRIPTIONS_URL="https://test-subscriptions.openbankproject.com"
PUBLIC_LEGACY_PORTAL_URL="https://test-legacy-portal.openbankproject.com/"

# Redis Configuration
REDIS_HOST="localhost"
REDIS_PORT="6379"

# UI Configuration
PUBLIC_LOGO_URL="/logo2x-1.png"
PUBLIC_DARK_LOGO_URL="/obp_logo.svg"

# Optional: Set the logo width (maintains aspect ratio)
# Can use any CSS width value: pixels, percentages, rem, etc.
# Examples: "200px", "50%", "12rem"
# Defaults to "100%" (full width) if not set
PUBLIC_LOGO_WIDTH="200px"

# Optional: Logo shown in the collapsed sidebar tray
# Defaults to PUBLIC_DARK_LOGO_URL if not set
# PUBLIC_MINIMAL_LOGO_URL="/obp_logo_symbol_only.svg"

PUBLIC_WELCOME_TITLE=Your Custom Welcome Title!
PUBLIC_HELP_QUESTION=What would you like to know?
PUBLIC_WELCOME_DESCRIPTION=Your custom description text that will appear in the welcome splash screen.

# Suggested Questions for the Opey Chat
PUBLIC_SUGGESTED_QUESTIONS='[{"questionString":"How can I get started?","pillTitle":"Getting Started","icon":"Rocket"},{"questionString":"How do I authenticate?","pillTitle":"Authentication","icon":"UserLock"},{"questionString":"How do I use consents?","pillTitle":"Consents","icon":"CheckCheck"},{"questionString":"What SDKs are available?","pillTitle":"SDKs","icon":"Layers"}]'

# Google Analytics Configuration
# Set to true to enable Google Analytics, do not enable in development
ENABLE_ANALYTICS=false
GTAG_ID="your-gtag-id" # i.e G-Y2731923F


# Sponsor Configuration (all optional)
# Display a sponsor note in the footer below the copyright notice
PUBLIC_SPONSOR_NOTE="Sponsored by Your Company"

# Display a sponsor image/logo in the footer (height: 24px, maintains aspect ratio)
PUBLIC_SPONSOR_IMAGE="http://www.example.com/your.jpeg"

# Display a sponsor image/logo for dark mode (optional, falls back to PUBLIC_SPONSOR_IMAGE if not set)
# PUBLIC_SPONSOR_DARK_IMAGE="http://www.example.com/your-dark.jpeg"

# Make the sponsor image clickable (opens in new tab)
PUBLIC_SPONSOR_INFO_URL="http://www.example.com/info.html"
# About Page Configuration (optional)
# Custom markdown content for the About page (/about)
# If not set, default content about OBP Portal will be displayed
# PUBLIC_ABOUT_TEXT="# About Our Portal\n\nYour custom markdown content here..."

# OBP Chat Platform URL (optional)
# URL for the Open Bank Project Chat link on the About page
# Defaults to https://chat.openbankproject.com if not set
PUBLIC_OBP_CHAT_URL="https://chat.openbankproject.com"


# Undocumented Features (use with caution)
# Accepts string values: "true", "TRUE", "True", "1" to enable
# PUBLIC_UNDOCUMENTED_FEATURE_1_ENABLED=false
# Note: Must use PUBLIC_ prefix for client-side environment variables in SvelteKit

#SANDBOX_POPULATOR_URL="http://localhost:5178"