feat: Enable Extensions catalog installation feature by default [RHDHPLAN-747] (#147)

Co-authored-by: Fortune Ndlovu <ndlovufortune97@gmail.com>
Co-authored-by: Ben Wilcock <benwilcock@gmail.com>

Author: 3 people

README.md

@@ -41,16 +41,31 @@ The built-in documentation provides step-by-step technical instructions with exa
 
 ## Quick Commands
 
-**Restart after config changes:**
+> **Note**: Replace `podman` with `docker` if using Docker.
+
+### After Plugin changes
+
+After modifying the plugins configuration, for example after configuring plugins using the Extensions in the RHDH UI:
+
+```sh
+# Reinstall plugins and restart RHDH
+podman compose run install-dynamic-plugins  # or: docker compose run install-dynamic-plugins
+podman compose restart rhdh                  # or: docker compose restart rhdh
+```
+
+### Quick restart (No Plugin changes)
+
+For configuration-only changes:
 
 ```sh
-podman compose stop rhdh && podman compose start rhdh
+# Just restart RHDH (if plugins haven't changed)
+podman compose restart rhdh  # or: docker compose restart rhdh
 ```
 
-**Clean up:**
+### Clean up
 
 ```sh
-podman compose down --volumes
+podman compose down --volumes  # or: docker compose down --volumes
 ```
 
 ## Additional Configuration Guides

configs/dynamic-plugins/dynamic-plugins.override.example.yaml

@@ -3,6 +3,9 @@
 
 includes:
   - dynamic-plugins.default.yaml
+  # Uncomment the following line (and the corresponding 'red-hat-developer-hub-backstage-plugin-marketplace*' plugins)
+  # to enable dynamic plugins installation using the Extensions UI.
+  # - /dynamic-plugins-root/dynamic-plugins.extensions.yaml
 
 # # Below you can add custom dynamic plugins, including local ones.
 
@@ -93,3 +96,39 @@ includes:
 #               - path: /admin/rbac
 #                 module: RbacPlugin
 #                 importName: RbacPage
+
+# # Uncomment the following two plugins to enable dynamic plugins installation via the Extensions UI
+# - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace
+#   disabled: false
+#   pluginConfig:
+#     dynamicPlugins:
+#       frontend:
+#         red-hat-developer-hub.backstage-plugin-marketplace:
+#           translationResources:
+#             - importName: marketplaceTranslations
+#               ref: marketplaceTranslationRef
+#               module: Alpha
+#           appIcons:
+#             - name: pluginsIcon
+#               importName: PluginsIcon
+#           dynamicRoutes:
+#             - path: /extensions
+#               importName: DynamicMarketplacePluginRouter
+#               menuItem:
+#                 icon: pluginsIcon
+#                 text: Extensions
+#                 textKey: menuItem.extensions
+#           menuItems:
+#             extensions:
+#               parent: default.admin
+# - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace-backend-dynamic
+#   disabled: false
+#   pluginConfig:
+#     extensions:
+#       installation:
+#         enabled: true
+#         saveToSingleFile:
+#           # NOTE: Default path. If you want to change this path, make sure to choose a path that is writable by the main RHDH container user.
+#           # Otherwise, the extensions backend plugin will not be able to save the dynamic plugins configuration.
+#           # Also add the path in the 'includes' section of this file, so the plugins installed via the Extensions UI can be loaded at runtime.
+#           file: /opt/app-root/src/dynamic-plugins-root/dynamic-plugins.extensions.yaml

configs/dynamic-plugins/dynamic-plugins.yaml

@@ -1,6 +1,8 @@
 # This is the default dynamic plugins config, and any user configuration should be added dynamic-plugins.override.yaml instead
 includes:
   - dynamic-plugins.default.yaml
+  # Writable path in the init container for extensions plugin configuration.
+  - /dynamic-plugins-root/dynamic-plugins.extensions.yaml
 
 plugins:
   # Tech Radar frontend plugin
@@ -52,3 +54,41 @@ plugins:
                   toolTip: "RHDH Documentation"
                   to: "https://docs.redhat.com/en/documentation/red_hat_developer_hub/"
                   visibleOnPaths: ["/"]
+
+  #########################################################
+  # Enable dynamic plugins installation by using Extensions
+  #########################################################
+  - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace
+    disabled: false
+    pluginConfig:
+      dynamicPlugins:
+        frontend:
+          red-hat-developer-hub.backstage-plugin-marketplace:
+            translationResources:
+              - importName: marketplaceTranslations
+                ref: marketplaceTranslationRef
+                module: Alpha
+            appIcons:
+              - name: pluginsIcon
+                importName: PluginsIcon
+            dynamicRoutes:
+              - path: /extensions
+                importName: DynamicMarketplacePluginRouter
+                menuItem:
+                  icon: pluginsIcon
+                  text: Extensions
+                  textKey: menuItem.extensions
+            menuItems:
+              extensions:
+                parent: default.admin
+
+  - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace-backend-dynamic
+    disabled: false
+    pluginConfig:
+      extensions:
+        installation:
+          enabled: true
+          saveToSingleFile:
+            # NOTE: the path needs to be writable by the main RHDH container user
+            file: /opt/app-root/src/dynamic-plugins-root/dynamic-plugins.extensions.yaml
+  ########## End Extensions #################################

default.env

@@ -15,6 +15,9 @@ BASE_URL=http://localhost:7007
 #AUTH_GITHUB_CLIENT_ID=
 #AUTH_GITHUB_CLIENT_SECRET=
 
+# Node environment for extensions plugin installation
+NODE_ENV=development
+
 # Disable TLS certificate validation (development only)
 NODE_TLS_REJECT_UNAUTHORIZED=0
 

docs/images/dynamic-plugins-extensions-restart-required.png

@@ -62,11 +62,22 @@ Common variables to customize:
 
 After making configuration changes:
 
-```bash
-# For app-config changes
-podman compose stop rhdh && podman compose start rhdh
-
-# For plugin changes  
-podman compose run install-dynamic-plugins
-podman compose stop rhdh && podman compose start rhdh
-```
+=== "Podman (Recommended)"
+    ```bash
+    # For app-config changes
+    podman compose restart rhdh
+
+    # For plugin changes
+    podman compose run install-dynamic-plugins
+    podman compose restart rhdh
+    ```
+
+=== "Docker"
+    ```bash
+    # For app-config changes
+    docker compose restart rhdh
+
+    # For plugin changes
+    docker compose run install-dynamic-plugins
+    docker compose restart rhdh
+    ```

docs/rhdh-local-guide/configuration.md

@@ -1,5 +1,67 @@
 The dynamic plugin system in RHDH enables you to add, remove, enable, and disable plugins without rebuilding the container. This provides incredible flexibility for testing different plugin combinations and developing custom plugins locally.
 
+## Managing Plugins from the UI
+
+By default, RHDH Local enables the built-in **Extensions** feature that lets you browse, install, and configure plugins directly from the RHDH web interface, without any need to manually edit YAML files for basic plugin management.
+
+!!! warning "Local Development Only"
+    The UI-based plugin management feature is enabled by default with RHDH Local for development and testing purposes. **This functionality is not recommended in production environments.** In production, plugin management should be handled through proper configuration management and deployment pipelines.
+
+### Why a Restart is Required
+
+When you install or uninstall a plugin through the UI, you're changing which code RHDH needs to load. The restart ensures that:
+
+- New plugin code is downloaded and made available
+- The backend services can load the new functionality
+- Configuration changes are properly applied across all services
+
+Without a restart, your changes won't take effect because the running instance is still using the previous set of loaded plugins.
+
+### How to Restart RHDH Local
+
+After making plugin changes through the UI, restart your local instance with these commands:
+
+=== "Podman (Recommended)"
+    ```bash
+    # Reinstall plugins and restart RHDH
+    podman compose run install-dynamic-plugins
+    podman compose restart rhdh
+    ```
+
+=== "Docker"
+    ```bash
+    # Reinstall plugins and restart RHDH
+    docker compose run install-dynamic-plugins
+    docker compose restart rhdh
+    ```
+
+This process typically may take a few minutes. You can monitor the startup progress in the container logs:
+
+=== "Podman (Recommended)"
+    ```bash
+    podman compose logs -f rhdh
+    ```
+
+=== "Docker"
+    ```bash
+    docker compose logs -f rhdh
+    ```
+
+### Example: Installing the TODO Plugin
+
+Let's walk through installing a simple plugin to try out the UI-based management feature.
+
+**[TODO](https://github.com/backstage/community-plugins/tree/main/workspaces/todo)** is a plugin that scans your repository code and displays all TODO, FIXME, and similar comments in one place. It's a great plugin to test with because it requires minimal configuration and provides immediate, practical value.
+
+1. **Open the Extensions page**: Navigate to **Administration** → **Extensions** in the RHDH sidebar
+2. **Find the TODO plugin**: Use the search bar to find "TODO" or browse the available plugins
+3. **Install the plugin**: Click on the TODO plugin and follow the installation prompts. The UI will then warn that a backend restart is required, like so:
+   ![Extensions page showing "Backend restart required" warning after installing the TODO plugin](../images/dynamic-plugins-extensions-restart-required.png)
+4. **Restart RHDH Local**: Run the restart commands shown above
+5. **Verify the installation**: After restart, navigate to a component entity page and you should see a new "TODO" section in the entity Overview that lists any TODO comments found in the related repository, if any.
+
+To uninstall, simply return to the Extensions page, find the installed plugin, and remove it; then restart again.
+
 ## Configuration File Location
 
 Plugin configuration is managed through `configs/dynamic-plugins/dynamic-plugins.override.yaml` or `configs/dynamic-plugins/dynamic-plugins.yaml` if the former does not exist.
@@ -134,26 +196,41 @@ podman compose up -d
 
 # Reinstall plugins without clearing other data
 podman compose run install-dynamic-plugins
-podman compose stop rhdh && podman compose start rhdh
+podman compose restart rhdh
 ```
 
 ## Applying Plugin Changes
 
 ### Standard Plugin Changes
 
-After modifying the plugin configuration:
+After modifying the plugin configuration, for example after configuring plugins using the Extensions in the RHDH UI:
 
-```bash
-# Reinstall plugins and restart RHDH
-podman compose run install-dynamic-plugins
-podman compose stop rhdh && podman compose start rhdh
-```
+=== "Podman (Recommended)"
+    ```bash
+    # Reinstall plugins and restart RHDH
+    podman compose run install-dynamic-plugins
+    podman compose restart rhdh
+    ```
+
+=== "Docker"
+    ```bash
+    # Reinstall plugins and restart RHDH
+    docker compose run install-dynamic-plugins
+    docker compose restart rhdh
+    ```
 
 ### Quick Restart (No Plugin Changes)
 
 For configuration-only changes:
 
-```bash
-# Just restart RHDH (if plugins haven't changed)
-podman compose stop rhdh && podman compose start rhdh
-```
+=== "Podman (Recommended)"
+    ```bash
+    # Just restart RHDH (if plugins haven't changed)
+    podman compose restart rhdh
+    ```
+
+=== "Docker"
+    ```bash
+    # Just restart RHDH (if plugins haven't changed)
+    docker compose restart rhdh
+    ```

docs/rhdh-local-guide/dynamic-plugins-management.md

@@ -37,13 +37,13 @@ After modifying `app-config.local.yaml`:
 === "Podman (Recommended)"
     ```bash
     # Restart RHDH to load new configuration
-    podman compose stop rhdh && podman compose start rhdh
+    podman compose restart rhdh
     ```
 
 === "Docker"
     ```bash
     # Restart RHDH to load new configuration
-    docker compose stop rhdh && docker compose start rhdh
+    docker compose restart rhdh
     ```
 
 ## Troubleshooting

docs/rhdh-local-guide/loading-content.md

@@ -51,5 +51,20 @@ else
     echo "No .npmrc found, skipping NPM_CONFIG_USERCONFIG"
 fi
 
+DYNAMIC_PLUGINS_EXTENSIONS_FILE="/dynamic-plugins-root/dynamic-plugins.extensions.yaml"
+if [ ! -f "$DYNAMIC_PLUGINS_EXTENSIONS_FILE" ]; then
+    echo "$DYNAMIC_PLUGINS_EXTENSIONS_FILE does not exist - creating it to enable dynamic plugins installation by using Extensions..."
+    cat <<EOF > "$DYNAMIC_PLUGINS_EXTENSIONS_FILE"
+includes:
+  - dynamic-plugins.default.yaml
+
+plugins: []
+EOF
+    # The file needs to be writable by the main RHDH container user.
+    # Otherwise, the extensions backend plugin will not be able to save the dynamic plugins configuration
+    chown 1001 "$DYNAMIC_PLUGINS_EXTENSIONS_FILE"
+    echo '... file '$DYNAMIC_PLUGINS_EXTENSIONS_FILE' created!'
+fi
+
 echo "Running install-dynamic-plugins.sh"
-./install-dynamic-plugins.sh /dynamic-plugins-root
+./install-dynamic-plugins.sh /dynamic-plugins-root