|
1 | | -### OBP-API Configuration ### |
2 | | -VITE_OBP_API_PORTAL_HOST=http://127.0.0.1:8080 # OBP API Portal URL (for "Portal Home" navigation link) |
3 | | -VITE_OBP_API_HOST=http://127.0.0.1:8080 # OBP API server base URL (for all backend API requests) |
4 | | -# VITE_OBP_API_VERSION is NO LONGER USED - hardcoded to v5.1.0 in shared-constants.ts for stability |
5 | | -VITE_OBP_API_MANAGER_HOST=https://apimanagersandbox.openbankproject.com # OBP API Manager URL (optional - for navigation link) |
6 | | -VITE_OBP_API_EXPLORER_HOST=http://localhost:5173 # API Explorer application URL (used for OAuth2 redirects and internal routing) |
7 | | -VITE_OPB_SERVER_SESSION_PASSWORD=your-secret-session-password-here # Secret key for session encryption (keep this secure!) |
8 | | -VITE_SHOW_API_MANAGER_BUTTON=false # Show/hide API Manager button in navigation (true/false) |
9 | | - |
10 | | -### Redis Configuration ### |
11 | | -VITE_OBP_REDIS_URL=redis://127.0.0.1:6379 # Redis connection string for session storage (format: redis://host:port) |
12 | | - |
13 | | -### Opey Configuration ### |
14 | | -VITE_CHATBOT_ENABLED=false # Enable/disable Opey chatbot widget (true/false) |
15 | | -VITE_CHATBOT_URL=http://localhost:5000 # Opey chatbot service URL (only needed if chatbot is enabled) |
16 | | - |
17 | | -### OAuth2/OIDC Configuration ### |
18 | | -VITE_OBP_OAUTH2_CLIENT_ID=48ac28e9-9ee3-47fd-8448-69a62764b779 # OAuth2 client ID (UUID - must match OIDC server registration) |
19 | | -VITE_OBP_OAUTH2_CLIENT_SECRET=fOTQF7jfg8C74u7ZhSjVQpoBYvD0KpWfM5UsEZBSFFM # OAuth2 client secret (keep this secure!) |
20 | | -VITE_OBP_OAUTH2_REDIRECT_URL=http://localhost:5173/api/oauth2/callback # OAuth2 callback URL (must exactly match OIDC client registration) |
21 | | -VITE_OBP_OAUTH2_WELL_KNOWN_URL=http://localhost:9000/obp-oidc/.well-known/openid-configuration # OIDC discovery endpoint URL |
22 | | -VITE_OBP_OAUTH2_TOKEN_REFRESH_THRESHOLD=300 # Seconds before token expiry to trigger refresh (default: 300) |
23 | | - |
24 | | -### Resource Documentation Version (Optional) ### |
25 | | -# VITE_OBP_API_DEFAULT_RESOURCE_DOC_VERSION=OBPv5.1.0 # Default resource docs version for frontend URLs (format: OBPv5.1.0 - with OBP prefix, auto-constructed if not set) |
26 | | - |
27 | | -### Session Configuration (Optional) ### |
28 | | -# VITE_SESSION_MAX_AGE=3600 # Session timeout in seconds (default: 3600 = 1 hour) |
29 | | - |
30 | | -### Styling Configuration (Optional) ### |
31 | | -# VITE_OBP_LOGO_URL=https://example.com/logo.png # Custom logo image URL (uses default OBP logo if not set) |
32 | | -# VITE_OBP_LINKS_COLOR=#3c8dbc # Primary link color (CSS color value) |
33 | | -# VITE_OBP_HEADER_LINKS_COLOR=#39455f # Header navigation link color |
34 | | -# VITE_OBP_HEADER_LINKS_HOVER_COLOR=#39455f # Header navigation link hover color |
35 | | -# VITE_OBP_HEADER_LINKS_BACKGROUND_COLOR=#eef0f4 # Header navigation active link background color |
| 1 | +### OBP API Configuration ### |
| 2 | +VITE_OBP_API_HOST=http://127.0.0.1:8080 |
| 3 | +VITE_OBP_API_VERSION=v5.1.0 |
| 4 | + |
| 5 | +### API Explorer Host ### |
| 6 | +VITE_OBP_API_EXPLORER_HOST=http://localhost:5173 |
| 7 | + |
| 8 | +### Session Configuration ### |
| 9 | +VITE_OPB_SERVER_SESSION_PASSWORD=change-me-to-a-secure-random-string |
| 10 | + |
| 11 | +### OAuth2 Redirect URL (shared by all providers) ### |
| 12 | +VITE_OAUTH2_REDIRECT_URL=http://localhost:5173/api/oauth2/callback |
| 13 | + |
| 14 | +### Redis Configuration (Optional - uses localhost:6379 if not set) ### |
| 15 | +# VITE_OBP_REDIS_URL=redis://127.0.0.1:6379 |
| 16 | +# VITE_OBP_REDIS_PASSWORD= |
| 17 | +# VITE_OBP_REDIS_USERNAME= |
| 18 | + |
| 19 | +### Multi-Provider OAuth2/OIDC Configuration ### |
| 20 | +### The system fetches available providers from: http://localhost:8080/obp/v5.1.0/well-known |
| 21 | +### Configure credentials below for each provider you want to support |
| 22 | + |
| 23 | +### OBP-OIDC Provider ### |
| 24 | +VITE_OBP_OIDC_CLIENT_ID=your-obp-oidc-client-id |
| 25 | +VITE_OBP_OIDC_CLIENT_SECRET=your-obp-oidc-client-secret |
| 26 | + |
| 27 | +### OBP Consumer Key (for API calls) ### |
| 28 | +VITE_OBP_CONSUMER_KEY=your-obp-oidc-client-id |
| 29 | + |
| 30 | +### Keycloak Provider (Optional) ### |
| 31 | +# VITE_KEYCLOAK_CLIENT_ID=your-keycloak-client-id |
| 32 | +# VITE_KEYCLOAK_CLIENT_SECRET=your-keycloak-client-secret |
| 33 | + |
| 34 | +### Google Provider (Optional) ### |
| 35 | +# VITE_GOOGLE_CLIENT_ID=your-google-client-id.apps.googleusercontent.com |
| 36 | +# VITE_GOOGLE_CLIENT_SECRET=your-google-client-secret |
| 37 | + |
| 38 | +### GitHub Provider (Optional) ### |
| 39 | +# VITE_GITHUB_CLIENT_ID=your-github-client-id |
| 40 | +# VITE_GITHUB_CLIENT_SECRET=your-github-client-secret |
| 41 | + |
| 42 | +### Custom OIDC Provider (Optional) ### |
| 43 | +# VITE_CUSTOM_OIDC_PROVIDER_NAME=my-custom-provider |
| 44 | +# VITE_CUSTOM_OIDC_CLIENT_ID=your-custom-client-id |
| 45 | +# VITE_CUSTOM_OIDC_CLIENT_SECRET=your-custom-client-secret |
| 46 | + |
| 47 | +### Chatbot Configuration (Optional) ### |
| 48 | +VITE_CHATBOT_ENABLED=false |
| 49 | +# VITE_CHATBOT_URL=http://localhost:5000 |
| 50 | + |
| 51 | +### Resource Docs Version ### |
| 52 | +VITE_OBP_API_DEFAULT_RESOURCE_DOC_VERSION=OBPv6.0.0 |
0 commit comments