|
1 | | -######################## |
2 | | -# APP CONF |
3 | | -######################## |
4 | | -VITE_NODE_ENV= |
5 | | -VITE_API_URL= |
| 1 | +# ============================================================================= |
| 2 | +# Agent Identity Service Frontend - Environment Configuration |
| 3 | +# ============================================================================= |
| 4 | +# This file contains all environment variables needed to configure the |
| 5 | +# Agent Identity Service frontend application. Copy this file to .env |
| 6 | +# and update the values according to your deployment environment. |
| 7 | +# |
| 8 | +# Usage: cp .env.sample .env |
| 9 | +# |
| 10 | +# Note: All variables prefixed with VITE_ are exposed to the client-side code. |
| 11 | +# Never include sensitive information in VITE_ variables. |
| 12 | +# ============================================================================= |
| 13 | + |
| 14 | +# ============================================================================= |
| 15 | +# APPLICATION CONFIGURATION |
| 16 | +# ============================================================================= |
| 17 | + |
| 18 | +# Environment mode for the application |
| 19 | +# Values: development, staging, production |
| 20 | +# Default: development |
| 21 | +VITE_NODE_ENV=development |
| 22 | + |
| 23 | +# Backend API base URL |
| 24 | +# The complete URL where your identity service backend is hosted |
| 25 | +# Example: https://api.identity-service.example.com |
| 26 | +# Required for API communication |
| 27 | +VITE_API_URL=http://localhost:8080 |
| 28 | + |
| 29 | +# Frontend application port |
| 30 | +# Port number where the Vite dev server will run |
| 31 | +# Default: 5500 |
6 | 32 | VITE_APP_CLIENT_PORT=5500 |
7 | | -VITE_APP_LOG_LEVEL= |
| 33 | + |
| 34 | +# Application logging level |
| 35 | +# Controls the verbosity of client-side logging |
| 36 | +# Values: error, warn, info, debug, trace |
| 37 | +# Default: info |
| 38 | +VITE_APP_LOG_LEVEL=info |
| 39 | + |
| 40 | +# Documentation URL |
| 41 | +# URL pointing to the application documentation |
| 42 | +# Example: https://docs.identity-service.example.com |
8 | 43 | VITE_DOCS_URL= |
9 | | -VITE_APP_BASE_NAME= |
10 | | -VITE_IAM_MULTI_TENANT= |
11 | 44 |
|
12 | | -######################## |
13 | | -# IAM AUTH |
14 | | -######################## |
| 45 | +# Application base path |
| 46 | +# Base path for React Router (useful for subdirectory deployments) |
| 47 | +# Default: / (root path) |
| 48 | +# Example: /identity-service (for subdirectory deployment) |
| 49 | +VITE_APP_BASE_NAME=/ |
| 50 | + |
| 51 | +# ============================================================================= |
| 52 | +# IDENTITY AND ACCESS MANAGEMENT (IAM) CONFIGURATION |
| 53 | +# ============================================================================= |
| 54 | + |
| 55 | +# IAM Product Identifier |
| 56 | +# Unique identifier for this application in the IAM system |
| 57 | +# Required for proper IAM integration |
15 | 58 | VITE_IAM_PRODUCT_ID= |
| 59 | + |
| 60 | +# IAM User Interface URL |
| 61 | +# URL for the IAM UI service |
| 62 | +# Example: https://iam-ui.example.com |
16 | 63 | VITE_IAM_UI= |
| 64 | + |
| 65 | +# IAM API URL |
| 66 | +# URL for the IAM API service |
| 67 | +# Example: https://iam-api.example.com |
17 | 68 | VITE_IAM_API= |
| 69 | + |
| 70 | +# OIDC Client ID |
| 71 | +# OAuth 2.0/OIDC client identifier for authentication |
| 72 | +# Obtained from your OIDC provider configuration |
18 | 73 | VITE_IAM_OIDC_CLIENT_ID= |
| 74 | + |
| 75 | +# OIDC Issuer URL |
| 76 | +# The OAuth 2.0/OIDC issuer URL (authorization server) |
| 77 | +# Example: https://auth.example.com/realms/identity-service |
19 | 78 | VITE_IAM_OIDC_ISSUER= |
20 | 79 |
|
21 | | -######################## |
22 | | -# ANALYTICS |
23 | | -######################## |
| 80 | +# Multi-tenant support and authentication mode |
| 81 | +# This setting controls both multi-tenant functionality and authentication provider selection: |
| 82 | +# - true: Uses IAM authentication with multi-tenant support |
| 83 | +# - false: Uses secondary OIDC provider authentication |
| 84 | +# Values: true, false |
| 85 | +# Default: true |
| 86 | +VITE_MULTI_TENANT=true |
| 87 | + |
| 88 | +# ============================================================================= |
| 89 | +# SECONDARY OIDC PROVIDER CONFIGURATION (Optional) |
| 90 | +# ============================================================================= |
| 91 | +# These variables are for additional OIDC provider integration. |
| 92 | +# They are prefixed with VITE_ to be available on the client-side. |
| 93 | + |
| 94 | +# Secondary OIDC Provider UI URL |
| 95 | +# URL for the secondary OIDC provider user interface |
| 96 | +VITE_OIDC_UI= |
| 97 | + |
| 98 | +# Secondary OIDC Client ID |
| 99 | +# OAuth 2.0/OIDC client identifier for secondary authentication provider |
| 100 | +VITE_OIDC_CLIENT_ID= |
| 101 | + |
| 102 | +# Secondary OIDC Issuer URL |
| 103 | +# The OAuth 2.0/OIDC issuer URL for the secondary authentication provider |
| 104 | +VITE_OIDC_ISSUER= |
| 105 | + |
| 106 | +# ============================================================================= |
| 107 | +# ANALYTICS AND TRACKING |
| 108 | +# ============================================================================= |
| 109 | + |
| 110 | +# Segment Analytics ID |
| 111 | +# Tracking ID for Segment analytics integration |
| 112 | +# Example: abc123def456 |
| 113 | +# Leave empty to disable Segment tracking |
24 | 114 | VITE_SEGMENT_ID= |
| 115 | + |
| 116 | +# Maze Analytics ID |
| 117 | +# Tracking ID for Maze user testing and analytics |
| 118 | +# Example: xyz789uvw012 |
| 119 | +# Leave empty to disable Maze tracking |
25 | 120 | VITE_MAZE_ID= |
| 121 | + |
| 122 | +# ============================================================================= |
| 123 | +# SECURITY NOTES |
| 124 | +# ============================================================================= |
| 125 | +# 1. Never commit your actual .env file to version control |
| 126 | +# 2. All VITE_ prefixed variables are exposed to the client-side |
| 127 | +# 3. Use strong, unique values for client IDs and secrets |
| 128 | +# 4. Regularly rotate authentication credentials |
| 129 | +# 5. Use HTTPS URLs in production environments |
| 130 | +# 6. Validate all environment variables in your application code |
| 131 | +# ============================================================================= |
0 commit comments