feat: updat general solution for backend

Author: soul2zimate

src/main/java/io/github/guacsec/trustifyda/integration/report/BrandingConfig.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2023-2025 Trustify Dependency Analytics Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.github.guacsec.trustifyda.integration.report;
+
+import io.smallrye.config.ConfigMapping;
+
+@ConfigMapping(prefix = "branding")
+public interface BrandingConfig {
+  String displayName();
+
+  String exploreUrl();
+
+  String exploreTitle();
+
+  String exploreDescription();
+}

src/main/java/io/github/guacsec/trustifyda/integration/report/ReportTemplate.java

@@ -58,6 +58,9 @@ public class ReportTemplate {
   @ConfigProperty(name = "telemetry.disabled", defaultValue = "false")
   Boolean disabled;
 
+  // Branding configuration
+  @Inject Optional<BrandingConfig> brandingConfig;
+
   @Inject ObjectMapper mapper;
 
   public Map<String, Object> setVariables(
@@ -74,6 +77,8 @@ public Map<String, Object> setVariables(
     params.put("cveIssueTemplate", cveIssuePathRegex);
     params.put("imageMapping", getImageMapping());
     params.put("rhdaSource", rhdaSource);
+    // Only include branding config if it's present
+    brandingConfig.ifPresent(config -> params.put("brandingConfig", getBrandingConfigMap(config)));
     if (!disabled && writeKey.isPresent()) {
       params.put("userId", userId);
       params.put("anonymousId", anonymousId);
@@ -108,6 +113,15 @@ private String getImageMapping() throws JsonProcessingException {
     return objectWriter.writeValueAsString(urlMapping);
   }
 
+  private Map<String, String> getBrandingConfigMap(BrandingConfig config) {
+    Map<String, String> branding = new HashMap<>();
+    branding.put("displayName", config.displayName());
+    branding.put("exploreUrl", config.exploreUrl());
+    branding.put("exploreTitle", config.exploreTitle());
+    branding.put("exploreDescription", config.exploreDescription());
+    return branding;
+  }
+
   @RegisterForReflection
   public static record IssueLinkFormatter(String issuePathRegex) {
 

src/main/resources/application.properties

@@ -62,3 +62,13 @@ quarkus.hibernate-orm.sql-load-script=no-file
 %prod.quarkus.datasource.jdbc.url=jdbc:postgresql://${db.postgres.host}:${db.postgres.port}/${db.postgres.database}?sslmode=${db.postgres.sslmode}
 %prod.quarkus.datasource.username=${db.postgres.user}
 %prod.quarkus.datasource.password=${db.postgres.password}
+
+# ====================================================================
+# Branding Configuration Profiles
+# ====================================================================
+
+# Default branding configuration (Community/Trustify) Example:
+#branding.display.name=Trustify
+#branding.explore.url=https://guac.sh/trustify/
+#branding.explore.title=Learn more about Trustify
+#branding.explore.description=The Trustify project is a collection of software components that enables you to store and retrieve Software Bill of Materials (SBOMs), and advisory documents.

src/main/resources/freemarker/templates/generated/main.js

@@ -1,5 +1 @@
-GENERATE_SOURCEMAP=false
-
-# Default branding mode when no specific profile is used
-# Options: community, redhat
-REACT_APP_BRANDING_MODE=community
+GENERATE_SOURCEMAP=false

src/main/resources/freemarker/templates/generated/vendor.js

@@ -1,65 +1,215 @@
 # Branding Configuration
 
-This project supports two branding modes: **Red Hat** (enterprise) and **Community** (Trustify).
+This project supports flexible branding through backend environment variables. The system uses **default** branding and allows you to override specific elements as needed.
 
 ## Quick Start
 
-### Prerequisites
-Install the `env-cmd` package to enable environment-specific builds:
+### Using Predefined Profiles
+
+**Default branding:**
 ```bash
-npm install --save-dev env-cmd
+# Default profile - no additional flags needed
+./mvnw quarkus:dev
 ```
 
-### Development
+**Custom organization branding:**
 ```bash
-# Start development server with Community branding (default)
-npm run start:community
+# Example using a custom profile (e.g., myorg)
+./mvnw quarkus:dev -Dquarkus.profile=myorg
+```
 
-# Start development server with Red Hat branding
-npm run start:redhat
+### Using Environment Variables (Alternative)
+```bash
+# Start development server (branding controlled by backend environment variables)
+npm start
 ```
 
 ### Production Build
 ```bash
-# Build Community version
-npm run build:community
+# Build for production (branding controlled by backend environment variables)
+npm run build
+```
+
+## How It Works
+
+1. **Backend Configuration**: Java backend reads `BRANDING_XXX` environment variables
+2. **Runtime Injection**: Branding configuration is passed to the React app through `appData`
+3. **Component Usage**: React components read branding configuration from the app context
+4. **Default-First**: All defaults are set to standard values, specific brands override as needed
+
+## Available Environment Variables
+
+Configure branding by setting these environment variables for the Java backend:
+
+```bash
+# Brand identity
+BRANDING_DISPLAY_NAME=Your Brand Name           # Used for conditional logic and remediation title
 
-# Build Red Hat version
-npm run build:redhat
+# Explore section
+BRANDING_EXPLORE_URL=https://your-url.com       # URL for "Take me there" button
+BRANDING_EXPLORE_TITLE=Your Explore Title             # Title for explore section
+BRANDING_EXPLORE_DESCRIPTION=Your description text    # Description text
 ```
 
-## Configuration Files
+## Branding Logic
 
-### `.env.community` - Community/Trustify Version
-- Uses Trustify branding
-- Points to https://guac.sh/trustify/
-- Shows "Trustify Overview of security issues"
-- Uses Trustify icon for remediations
+The system uses `displayName` for all branding decisions:
 
-### `.env.redhat` - Red Hat Enterprise Version
-- Uses Red Hat branding
-- Points to Red Hat developer portal
-- Shows "Red Hat Overview of security Issues"
-- Uses Red Hat icon for remediations
-- Includes "from Red Hat" in remediation text
+- **Custom organization branding**: Uses the provided `displayName` (e.g., "MyOrg" shows "MyOrg Remediations")
+- **Default branding**: Used when no custom branding is configured
 
-## How It Works
+## Icon System
+
+The system uses a CSS-based icon override approach:
+
+- **Default icon**: Built-in Trustify logo (PNG)
+- **Custom icons**: Organizations can override the default icon using CSS in their private projects
+
+## Examples
+
+### Method 1: Using Predefined Profile
+
+**Default branding:**
+```bash
+# Default behavior (no profile needed)
+./mvnw quarkus:dev
+```
+
+**Custom organization branding:**
+```bash
+# Example using a custom profile
+./mvnw quarkus:dev -Dquarkus.profile=myorg
+```
+
+**Production builds with profiles:**
+```bash
+# Default production build
+./mvnw clean package
+
+# Custom organization production build
+./mvnw clean package -Dquarkus.profile=myorg
+```
+
+### Method 2: Using Environment Variables
+
+**Default Configuration (no environment variables needed):**
+```bash
+# No environment variables needed - uses default Trustify branding
+./mvnw quarkus:dev
+```
+
+**Custom Organization Configuration:**
+```bash
+export BRANDING_DISPLAY_NAME="MyOrg"
+export BRANDING_EXPLORE_URL="https://example.com/security-tools"
+export BRANDING_EXPLORE_TITLE="Learn about MyOrg Security"
+export BRANDING_EXPLORE_DESCRIPTION="Explore our comprehensive security analysis tools and vulnerability management platform."
+
+./mvnw quarkus:dev
+```
+
+## Backend Integration
+
+The branding configuration is handled using Quarkus `@ConfigMapping`:
+
+**BrandingConfig.java:**
+```java
+@ConfigMapping(prefix = "branding")
+public interface BrandingConfig {
+  String displayName();
+  String exploreUrl();
+  String exploreTitle();
+  String exploreDescription();
+}
+```
+
+**ReportTemplate.java:**
+```java
+@Inject Optional<BrandingConfig> brandingConfig;
+
+// Only include branding config if it's present
+brandingConfig.ifPresent(config -> params.put("brandingConfig", getBrandingConfigMap(config)));
+```
+
+The configuration is then passed to the frontend via the `appData` object in the Freemarker template.
+
+## Profile Configuration
+
+The branding profiles are defined in `src/main/resources/application.properties`:
+
+```properties
+# Default branding configuration (Community/Trustify)
+branding.display.name=Trustify
+branding.explore.url=https://guac.sh/trustify/
+branding.explore.title=Learn more about Trustify
+branding.explore.description=The Trustify project is a collection of software components that enables you to store and retrieve Software Bill of Materials (SBOMs), and advisory documents.
+
+# Example: Custom organization branding profile
+%myorg.branding.display.name=MyOrg
+%myorg.branding.explore.url=https://example.com/security-tools
+%myorg.branding.explore.title=Learn about MyOrg Security
+%myorg.branding.explore.description=Explore our comprehensive security analysis tools and vulnerability management platform.
+```
 
-1. **Environment Variables**: Different `.env` files define branding configuration
-2. **Branding Config**: `src/config/branding.ts` reads environment variables and provides typed configuration
-3. **Conditional Rendering**: Components use `getBrandingConfig()` to conditionally render content based on branding mode
+## Creating Custom Branding Profiles
 
-## Customizing Branding
+To create a new branding profile for your organization:
 
-To modify branding, edit the respective `.env` file:
+1. **Add profile configuration** to `src/main/resources/application.properties`:
+   ```properties
+   # Replace 'myorg' with your organization identifier
+   %myorg.branding.display.name=Your Organization Name
+   %myorg.branding.explore.url=https://your-org.com/security
+   %myorg.branding.explore.title=Learn about Your Org Security
+   %myorg.branding.explore.description=Your custom description here.
+   ```
+
+2. **Use the profile** when running the application:
+   ```bash
+   ./mvnw quarkus:dev -Dquarkus.profile=myorg
+   ```
+
+3. **Override icons in private projects** using CSS to provide custom organization icons
+
+Environment variables will override profile settings if both are provided.
+
+## Custom Icon Implementation
+
+To implement a completely custom icon for your organization, follow this step-by-step guide:
+
+**Step 1: Add your custom icon**
+```bash
+# Copy your organization's icon to the UI assets directory
+cp /path/to/myorg.png /path/to/trustify-dependency-analytics/ui/src/images/myorg.png
+```
+
+**Step 2: Create CSS override**
+Add the following CSS to `/ui/src/index.css`:
+```css
+/* Custom icon override - Replace Trustify icon with MyOrg icon */
+img[alt="My Org Icon"] {
+  content: url('./images/myorg.png') !important;
+  width: 16px !important;
+  height: 16px !important;
+}
+```
+
+**Step 3: Configure organization branding**
+Add to `/src/main/resources/application.properties`:
+```properties
+# MyOrg custom branding profile
+%myorg.branding.display.name=MyOrg
+%myorg.branding.explore.url=https://myorg.com/security
+%myorg.branding.explore.title=Learn about MyOrg Security
+%myorg.branding.explore.description=Explore our comprehensive security analysis tools and vulnerability management platform.
+```
+
+**Step 4: Build with your changes**
+```bash
+cd ui && npm run build
+```
 
+**Step 5: Run with your branding**
 ```bash
-REACT_APP_BRANDING_MODE=community|redhat
-REACT_APP_BRAND_NAME=Your Brand Name
-REACT_APP_BRAND_TITLE=Your Overview Title
-REACT_APP_REMEDIATION_TITLE=Your Remediation Title
-REACT_APP_BRAND_ICON=icon_name
-REACT_APP_BRAND_URL=https://your-url.com
-REACT_APP_EXPLORE_TITLE=Your Explore Title
-REACT_APP_EXPLORE_DESCRIPTION=Your description text
+./mvnw quarkus:dev -Dquarkus.profile=myorg
 ```

ui/.env

@@ -26,11 +26,7 @@
   },
   "scripts": {
     "start": "craco start",
-    "start:community": "env-cmd -f .env.community craco start",
-    "start:redhat": "env-cmd -f .env.redhat craco start",
     "build": "craco build && yarn copy:js:main && yarn copy:js:vendor && yarn copy:css:main && yarn copy:css:vendor",
-    "build:community": "env-cmd -f .env.community craco build && yarn copy:js:main && yarn copy:js:vendor && yarn copy:css:main && yarn copy:css:vendor",
-    "build:redhat": "env-cmd -f .env.redhat craco build && yarn copy:js:main && yarn copy:js:vendor && yarn copy:css:main && yarn copy:css:vendor",
     "test": "react-scripts test",
     "eject": "react-scripts eject",
     "copy:js:main": "cp build/static/js/main.js ../src/main/resources/freemarker/templates/generated/main.js",
@@ -64,7 +60,6 @@
     "@babel/plugin-proposal-private-property-in-object": "^7.21.11",
     "@babel/plugin-transform-destructuring": "^7.25.9",
     "@craco/craco": "^7.1.0",
-    "env-cmd": "^10.1.0",
     "prettier": "^3.0.1"
   }
 }