ankhbayar/Assist_Design
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity
Assist_Design/env/portal-backend.env.sample

154 lines
4.7 KiB
Plaintext
Raw Normal View History

Update Plesk environment configuration and enhance Docker setup - Added detailed instructions for Plesk deployment in `.env.plesk` and `compose-plesk.yaml`. - Updated `.gitignore` to exclude Docker-related files. - Enhanced Dockerfiles for both frontend and backend to optimize for Plesk deployment. - Refined TypeScript configurations across various files for improved module resolution and compatibility. - Removed obsolete logger fixes summary file to streamline documentation.
2025-09-01 15:11:42 +09:00
NODE_ENV=production
# App
APP_BASE_URL=https://asolutions.jp
BFF_PORT=4000
Update package.json and health route to enhance functionality and environment configuration - Added new script "plesk:images" to package.json for building images. - Modified health route to include environment and version information in the response. - Updated portal-backend.env.sample to include new environment variables for application name and rate limiting settings.
2025-09-06 14:05:18 +09:00
APP_NAME=customer-portal-bff
Update Plesk environment configuration and enhance Docker setup - Added detailed instructions for Plesk deployment in `.env.plesk` and `compose-plesk.yaml`. - Updated `.gitignore` to exclude Docker-related files. - Enhanced Dockerfiles for both frontend and backend to optimize for Plesk deployment. - Refined TypeScript configurations across various files for improved module resolution and compatibility. - Removed obsolete logger fixes summary file to streamline documentation.
2025-09-01 15:11:42 +09:00
# Database (PostgreSQL)
POSTGRES_DB=portal_prod
POSTGRES_USER=portal
POSTGRES_PASSWORD=CHANGE_ME
DATABASE_URL=postgresql://portal:CHANGE_ME@database:5432/portal_prod?schema=public
# Cache (Redis)
REDIS_URL=redis://cache:6379/0
Refactor ESLint configuration to enforce stricter TypeScript rules across all packages. Update design documentation to clarify component categorization and address legacy issues. Enhance task documentation for codebase refactoring, ensuring clear requirements and testing coverage. Improve Dockerfile for BFF and portal applications by optimizing package copying and build processes. Introduce new environment variables for authentication and queue configurations, enhancing service reliability and maintainability.
2025-09-26 17:02:36 +09:00
AUTH_ALLOW_REDIS_TOKEN_FAILOPEN=false
# Redis-required token flow (when enabled, tokens require Redis to be available)
AUTH_REQUIRE_REDIS_FOR_TOKENS=false
# Maintenance mode for authentication service
AUTH_MAINTENANCE_MODE=false
AUTH_MAINTENANCE_MESSAGE=Authentication service is temporarily unavailable for maintenance. Please try again later.
Update Plesk environment configuration and enhance Docker setup - Added detailed instructions for Plesk deployment in `.env.plesk` and `compose-plesk.yaml`. - Updated `.gitignore` to exclude Docker-related files. - Enhanced Dockerfiles for both frontend and backend to optimize for Plesk deployment. - Refined TypeScript configurations across various files for improved module resolution and compatibility. - Removed obsolete logger fixes summary file to streamline documentation.
2025-09-01 15:11:42 +09:00
# Security
JWT_SECRET=CHANGE_ME
JWT_EXPIRES_IN=7d
BCRYPT_ROUNDS=12
Refactor Salesforce request handling and improve logging - Moved metrics tracking and logging from the queueing phase to the execution phase in SalesforceRequestQueueService for better accuracy. - Updated CSRF token generation in CsrfController to accept parameters in a more flexible manner. - Enhanced CacheService to handle immediate expiry requests without leaking stale values. - Improved error handling and re-authentication logic in SalesforceConnection for better resilience during session expiration. - Refactored logout functionality in AuthFacade to handle optional userId and improve logging during token revocation. - Updated AuthController to apply rate limit headers and improved type handling in various request contexts. - Streamlined imports and improved overall code organization across multiple modules for better maintainability.
2025-11-05 15:47:06 +09:00
# CSRF Protection
CSRF_TOKEN_EXPIRY=3600000
CSRF_SECRET_KEY=CHANGE_ME_AT_LEAST_32_CHARACTERS_LONG
CSRF_COOKIE_NAME=csrf-secret
CSRF_HEADER_NAME=X-CSRF-Token
Update Plesk environment configuration and enhance Docker setup - Added detailed instructions for Plesk deployment in `.env.plesk` and `compose-plesk.yaml`. - Updated `.gitignore` to exclude Docker-related files. - Enhanced Dockerfiles for both frontend and backend to optimize for Plesk deployment. - Refined TypeScript configurations across various files for improved module resolution and compatibility. - Removed obsolete logger fixes summary file to streamline documentation.
2025-09-01 15:11:42 +09:00
# CORS / Proxy
CORS_ORIGIN=https://asolutions.jp
TRUST_PROXY=true
Refactor rate limiting configuration and enhance UI components for improved performance - Updated rate limiting TTL values in env.validation.ts and throttler.config.ts to reduce response times and improve request handling. - Adjusted throttle settings in AuthController, CatalogController, and OrdersController to align with new rate limits, enhancing overall API responsiveness. - Refactored OrderCard and OrderCardSkeleton components for better loading states and visual consistency. - Improved AddressForm and ServiceConfigurationStep components for better state management and user experience. - Streamlined CSS styles in globals.css and responsive.css for better maintainability and clarity.
2025-10-29 15:54:45 +09:00
# Rate Limiting (optional; defaults shown - ttl values in seconds)
RATE_LIMIT_TTL=60
Update package.json and health route to enhance functionality and environment configuration - Added new script "plesk:images" to package.json for building images. - Modified health route to include environment and version information in the response. - Updated portal-backend.env.sample to include new environment variables for application name and rate limiting settings.
2025-09-06 14:05:18 +09:00
RATE_LIMIT_LIMIT=100
Refactor rate limiting configuration and enhance UI components for improved performance - Updated rate limiting TTL values in env.validation.ts and throttler.config.ts to reduce response times and improve request handling. - Adjusted throttle settings in AuthController, CatalogController, and OrdersController to align with new rate limits, enhancing overall API responsiveness. - Refactored OrderCard and OrderCardSkeleton components for better loading states and visual consistency. - Improved AddressForm and ServiceConfigurationStep components for better state management and user experience. - Streamlined CSS styles in globals.css and responsive.css for better maintainability and clarity.
2025-10-29 15:54:45 +09:00
AUTH_RATE_LIMIT_TTL=900
Update package.json and health route to enhance functionality and environment configuration - Added new script "plesk:images" to package.json for building images. - Modified health route to include environment and version information in the response. - Updated portal-backend.env.sample to include new environment variables for application name and rate limiting settings.
2025-09-06 14:05:18 +09:00
AUTH_RATE_LIMIT_LIMIT=3
Refactor Salesforce request handling and improve logging - Moved metrics tracking and logging from the queueing phase to the execution phase in SalesforceRequestQueueService for better accuracy. - Updated CSRF token generation in CsrfController to accept parameters in a more flexible manner. - Enhanced CacheService to handle immediate expiry requests without leaking stale values. - Improved error handling and re-authentication logic in SalesforceConnection for better resilience during session expiration. - Refactored logout functionality in AuthFacade to handle optional userId and improve logging during token revocation. - Updated AuthController to apply rate limit headers and improved type handling in various request contexts. - Streamlined imports and improved overall code organization across multiple modules for better maintainability.
2025-11-05 15:47:06 +09:00
AUTH_REFRESH_RATE_LIMIT_TTL=300
AUTH_REFRESH_RATE_LIMIT_LIMIT=10
LOGIN_RATE_LIMIT_TTL=900
LOGIN_RATE_LIMIT_LIMIT=5
LOGIN_CAPTCHA_AFTER_ATTEMPTS=3
SIGNUP_RATE_LIMIT_TTL=900
SIGNUP_RATE_LIMIT_LIMIT=5
PASSWORD_RESET_RATE_LIMIT_TTL=900
PASSWORD_RESET_RATE_LIMIT_LIMIT=5
# CAPTCHA Configuration
AUTH_CAPTCHA_PROVIDER=none
AUTH_CAPTCHA_SECRET=
AUTH_CAPTCHA_THRESHOLD=0
AUTH_CAPTCHA_ALWAYS_ON=false
Update package.json and health route to enhance functionality and environment configuration - Added new script "plesk:images" to package.json for building images. - Modified health route to include environment and version information in the response. - Updated portal-backend.env.sample to include new environment variables for application name and rate limiting settings.
2025-09-06 14:05:18 +09:00
Enhance WHMCS integration and validation processes - Updated .env.example and portal-backend.env.sample to include new development-specific WHMCS environment variables. - Improved error handling in AuthService with a new signupPreflight method for validating signup data without creating accounts. - Enhanced phone number validation in SignupDto to enforce stricter formatting rules. - Refactored WHMCS connection service to prioritize development environment variables and normalize redirect URLs for SSO tokens. - Added debug logging for SSO redirect hosts in non-production environments to aid in troubleshooting.
2025-09-06 17:38:42 +09:00
# Validation error visibility (set true to show field-level errors to clients)
EXPOSE_VALIDATION_ERRORS=false
Update Plesk environment configuration and enhance Docker setup - Added detailed instructions for Plesk deployment in `.env.plesk` and `compose-plesk.yaml`. - Updated `.gitignore` to exclude Docker-related files. - Enhanced Dockerfiles for both frontend and backend to optimize for Plesk deployment. - Refined TypeScript configurations across various files for improved module resolution and compatibility. - Removed obsolete logger fixes summary file to streamline documentation.
2025-09-01 15:11:42 +09:00
# WHMCS Credentials
WHMCS_BASE_URL=https://accounts.asolutions.co.jp
WHMCS_API_IDENTIFIER=
WHMCS_API_SECRET=
Update package.json and health route to enhance functionality and environment configuration - Added new script "plesk:images" to package.json for building images. - Modified health route to include environment and version information in the response. - Updated portal-backend.env.sample to include new environment variables for application name and rate limiting settings.
2025-09-06 14:05:18 +09:00
# Optional API access key if your deployment uses it
WHMCS_API_ACCESS_KEY=
# Optional webhook security for WHMCS webhooks
WHMCS_WEBHOOK_SECRET=
Add optional WHMCS admin credentials to environment configuration - Introduced WHMCS_ADMIN_USERNAME and WHMCS_ADMIN_PASSWORD_MD5 for elevated admin actions. - Updated env.validation.ts and portal-backend.env.sample to reflect new optional fields. - Enhanced order fulfillment service to set order status to "Pending Review" and include error diagnostics in updates to Salesforce.
2025-09-06 13:57:14 +09:00
# Optional elevated admin credentials for privileged actions (eg. AcceptOrder)
# Provide the admin username and MD5 hash of the admin password.
# When set, the backend will use these ONLY for the AcceptOrder action.
WHMCS_ADMIN_USERNAME=
WHMCS_ADMIN_PASSWORD_MD5=
Update Plesk environment configuration and enhance Docker setup - Added detailed instructions for Plesk deployment in `.env.plesk` and `compose-plesk.yaml`. - Updated `.gitignore` to exclude Docker-related files. - Enhanced Dockerfiles for both frontend and backend to optimize for Plesk deployment. - Refined TypeScript configurations across various files for improved module resolution and compatibility. - Removed obsolete logger fixes summary file to streamline documentation.
2025-09-01 15:11:42 +09:00
# Salesforce Credentials
SF_LOGIN_URL=https://asolutions.my.salesforce.com
SF_CLIENT_ID=
SF_PRIVATE_KEY_PATH=/app/secrets/sf-private.key
SF_USERNAME=
Update package.json and health route to enhance functionality and environment configuration - Added new script "plesk:images" to package.json for building images. - Modified health route to include environment and version information in the response. - Updated portal-backend.env.sample to include new environment variables for application name and rate limiting settings.
2025-09-06 14:05:18 +09:00
SF_WEBHOOK_SECRET=
Refactor ESLint configuration to enforce stricter TypeScript rules across all packages. Update design documentation to clarify component categorization and address legacy issues. Enhance task documentation for codebase refactoring, ensuring clear requirements and testing coverage. Improve Dockerfile for BFF and portal applications by optimizing package copying and build processes. Introduce new environment variables for authentication and queue configurations, enhancing service reliability and maintainability.
2025-09-26 17:02:36 +09:00
# Salesforce Authentication Timeouts (in milliseconds)
SF_AUTH_TIMEOUT_MS=30000
SF_TOKEN_TTL_MS=720000
SF_TOKEN_REFRESH_BUFFER_MS=60000
# Queue Throttling Configuration
WHMCS_QUEUE_CONCURRENCY=15
WHMCS_QUEUE_INTERVAL_CAP=300
WHMCS_QUEUE_TIMEOUT_MS=30000
SF_QUEUE_CONCURRENCY=15
SF_QUEUE_LONG_RUNNING_CONCURRENCY=22
SF_QUEUE_INTERVAL_CAP=600
SF_QUEUE_TIMEOUT_MS=30000
SF_QUEUE_LONG_RUNNING_TIMEOUT_MS=600000
Update Plesk environment configuration and enhance Docker setup - Added detailed instructions for Plesk deployment in `.env.plesk` and `compose-plesk.yaml`. - Updated `.gitignore` to exclude Docker-related files. - Enhanced Dockerfiles for both frontend and backend to optimize for Plesk deployment. - Refined TypeScript configurations across various files for improved module resolution and compatibility. - Removed obsolete logger fixes summary file to streamline documentation.
2025-09-01 15:11:42 +09:00
Implement Salesforce Platform Events for Order Provisioning - Added support for Salesforce Platform Events, specifically subscribing to `OrderProvisionRequested__e` to trigger provisioning jobs. - Introduced new environment variables for Salesforce event configuration, including SF_EVENTS_ENABLED, SF_PROVISION_EVENT_CHANNEL, and SF_PUBSUB_ENDPOINT. - Refactored order fulfillment process to utilize event-driven architecture, enhancing reliability and scalability. - Updated documentation to reflect changes in the provisioning workflow and environment variable requirements. - Removed deprecated webhook handling code to streamline the integration.
2025-09-06 10:01:44 +09:00
# Salesforce Platform Events (Provisioning)
SF_EVENTS_ENABLED=true
Enhance Salesforce integration and caching mechanisms - Added new environment variables for Salesforce event channels and Change Data Capture (CDC) to improve cache invalidation and event handling. - Updated Salesforce module to include new guards for write operations, enhancing request rate limiting. - Refactored various services to utilize caching for improved performance and reduced API calls, including updates to the Orders and Catalog modules. - Enhanced error handling and logging in Salesforce services to provide better insights during operations. - Improved cache TTL configurations for better memory management and data freshness across catalog and order services.
2025-11-06 16:32:29 +09:00
SF_CATALOG_EVENT_CHANNEL=/event/Product_and_Pricebook_Change__e
SF_ACCOUNT_EVENT_CHANNEL=/event/Account_Internet_Eligibility_Update__e
SF_ORDER_EVENT_CHANNEL=/event/Order_Fulfilment_Requested__e
Implement Salesforce Platform Events for Order Provisioning - Added support for Salesforce Platform Events, specifically subscribing to `OrderProvisionRequested__e` to trigger provisioning jobs. - Introduced new environment variables for Salesforce event configuration, including SF_EVENTS_ENABLED, SF_PROVISION_EVENT_CHANNEL, and SF_PUBSUB_ENDPOINT. - Refactored order fulfillment process to utilize event-driven architecture, enhancing reliability and scalability. - Updated documentation to reflect changes in the provisioning workflow and environment variable requirements. - Removed deprecated webhook handling code to streamline the integration.
2025-09-06 10:01:44 +09:00
SF_EVENTS_REPLAY=LATEST
SF_PUBSUB_NUM_REQUESTED=50
SF_PUBSUB_QUEUE_MAX=100
Enhance Salesforce integration and caching mechanisms - Added new environment variables for Salesforce event channels and Change Data Capture (CDC) to improve cache invalidation and event handling. - Updated Salesforce module to include new guards for write operations, enhancing request rate limiting. - Refactored various services to utilize caching for improved performance and reduced API calls, including updates to the Orders and Catalog modules. - Enhanced error handling and logging in Salesforce services to provide better insights during operations. - Improved cache TTL configurations for better memory management and data freshness across catalog and order services.
2025-11-06 16:32:29 +09:00
SF_PUBSUB_ENDPOINT=api.pubsub.salesforce.com:7443
# Salesforce Change Data Capture (CDC) for Catalog Cache Invalidation
# These use /data/ prefix for built-in CDC events (no setup needed in Salesforce)
SF_CATALOG_PRODUCT_CDC_CHANNEL=/data/Product2ChangeEvent
SF_CATALOG_PRICEBOOKENTRY_CDC_CHANNEL=/data/PricebookEntryChangeEvent
# Optional: Platform Event for account eligibility updates (requires Salesforce setup)
SF_ACCOUNT_ELIGIBILITY_CHANNEL=/event/Account_Internet_Eligibility_Update__e
# Salesforce Change Data Capture (CDC) for Order Cache Invalidation
# These use /data/ prefix for built-in CDC events (no setup needed in Salesforce)
# Smart filtering: Only invalidates cache for customer-facing field changes, NOT internal fulfillment fields
SF_ORDER_CDC_CHANNEL=/data/OrderChangeEvent
SF_ORDER_ITEM_CDC_CHANNEL=/data/OrderItemChangeEvent
Implement Salesforce Platform Events for Order Provisioning - Added support for Salesforce Platform Events, specifically subscribing to `OrderProvisionRequested__e` to trigger provisioning jobs. - Introduced new environment variables for Salesforce event configuration, including SF_EVENTS_ENABLED, SF_PROVISION_EVENT_CHANNEL, and SF_PUBSUB_ENDPOINT. - Refactored order fulfillment process to utilize event-driven architecture, enhancing reliability and scalability. - Updated documentation to reflect changes in the provisioning workflow and environment variable requirements. - Removed deprecated webhook handling code to streamline the integration.
2025-09-06 10:01:44 +09:00
Update Plesk environment configuration and enhance Docker setup - Added detailed instructions for Plesk deployment in `.env.plesk` and `compose-plesk.yaml`. - Updated `.gitignore` to exclude Docker-related files. - Enhanced Dockerfiles for both frontend and backend to optimize for Plesk deployment. - Refined TypeScript configurations across various files for improved module resolution and compatibility. - Removed obsolete logger fixes summary file to streamline documentation.
2025-09-01 15:11:42 +09:00
# Salesforce Pricing
PORTAL_PRICEBOOK_ID=
# Logging
LOG_LEVEL=info
LOG_FORMAT=json
# Email (SendGrid)
SENDGRID_API_KEY=
EMAIL_FROM=no-reply@asolutions.jp
EMAIL_FROM_NAME=Assist Solutions
EMAIL_ENABLED=true
EMAIL_USE_QUEUE=true
SENDGRID_SANDBOX=false
EMAIL_TEMPLATE_RESET=
EMAIL_TEMPLATE_WELCOME=
Update package.json and health route to enhance functionality and environment configuration - Added new script "plesk:images" to package.json for building images. - Modified health route to include environment and version information in the response. - Updated portal-backend.env.sample to include new environment variables for application name and rate limiting settings.
2025-09-06 14:05:18 +09:00
# Freebit (SIM management; optional)
FREEBIT_BASE_URL=https://i1.mvno.net/emptool/api
FREEBIT_OEM_ID=PASI
FREEBIT_OEM_KEY=
FREEBIT_TIMEOUT=30000
FREEBIT_RETRY_ATTEMPTS=3
FREEBIT_DETAILS_ENDPOINT=/master/getAcnt/
Update Plesk environment configuration and enhance Docker setup - Added detailed instructions for Plesk deployment in `.env.plesk` and `compose-plesk.yaml`. - Updated `.gitignore` to exclude Docker-related files. - Enhanced Dockerfiles for both frontend and backend to optimize for Plesk deployment. - Refined TypeScript configurations across various files for improved module resolution and compatibility. - Removed obsolete logger fixes summary file to streamline documentation.
2025-09-01 15:11:42 +09:00
# Node Options
NODE_OPTIONS=--max-old-space-size=512
Implement Salesforce Platform Events for Order Provisioning - Added support for Salesforce Platform Events, specifically subscribing to `OrderProvisionRequested__e` to trigger provisioning jobs. - Introduced new environment variables for Salesforce event configuration, including SF_EVENTS_ENABLED, SF_PROVISION_EVENT_CHANNEL, and SF_PUBSUB_ENDPOINT. - Refactored order fulfillment process to utilize event-driven architecture, enhancing reliability and scalability. - Updated documentation to reflect changes in the provisioning workflow and environment variable requirements. - Removed deprecated webhook handling code to streamline the integration.
2025-09-06 10:01:44 +09:00
# NOTE: Frontend (Next.js) uses a separate env file (portal-frontend.env)
# Do not include NEXT_PUBLIC_* variables here.
Enhance Salesforce integration and caching mechanisms - Added new environment variables for Salesforce event channels and Change Data Capture (CDC) to improve cache invalidation and event handling. - Updated Salesforce module to include new guards for write operations, enhancing request rate limiting. - Refactored various services to utilize caching for improved performance and reduced API calls, including updates to the Orders and Catalog modules. - Enhanced error handling and logging in Salesforce services to provide better insights during operations. - Improved cache TTL configurations for better memory management and data freshness across catalog and order services.
2025-11-06 16:32:29 +09:00
# Salesforce Account Portal Flags
ACCOUNT_PORTAL_STATUS_FIELD=Portal_Status__c
ACCOUNT_PORTAL_STATUS_SOURCE_FIELD=Portal_Registration_Source__c
ACCOUNT_PORTAL_LAST_SIGNED_IN_FIELD=Portal_Last_SignIn__c
Reference in New Issue Copy Permalink