Skip to main content
Redhat Developers  Logo
  • Products

    Featured

    • Red Hat Enterprise Linux
      Red Hat Enterprise Linux Icon
    • Red Hat OpenShift AI
      Red Hat OpenShift AI
    • Red Hat Enterprise Linux AI
      Linux icon inside of a brain
    • Image mode for Red Hat Enterprise Linux
      RHEL image mode
    • Red Hat OpenShift
      Openshift icon
    • Red Hat Ansible Automation Platform
      Ansible icon
    • Red Hat Developer Hub
      Developer Hub
    • View All Red Hat Products
    • Linux

      • Red Hat Enterprise Linux
      • Image mode for Red Hat Enterprise Linux
      • Red Hat Universal Base Images (UBI)
    • Java runtimes & frameworks

      • JBoss Enterprise Application Platform
      • Red Hat build of OpenJDK
    • Kubernetes

      • Red Hat OpenShift
      • Microsoft Azure Red Hat OpenShift
      • Red Hat OpenShift Virtualization
      • Red Hat OpenShift Lightspeed
    • Integration & App Connectivity

      • Red Hat Build of Apache Camel
      • Red Hat Service Interconnect
      • Red Hat Connectivity Link
    • AI/ML

      • Red Hat OpenShift AI
      • Red Hat Enterprise Linux AI
    • Automation

      • Red Hat Ansible Automation Platform
      • Red Hat Ansible Lightspeed
    • Developer tools

      • Red Hat Trusted Software Supply Chain
      • Podman Desktop
      • Red Hat OpenShift Dev Spaces
    • Developer Sandbox

      Developer Sandbox
      Try Red Hat products and technologies without setup or configuration fees for 30 days with this shared Openshift and Kubernetes cluster.
    • Try at no cost
  • Technologies

    Featured

    • AI/ML
      AI/ML Icon
    • Linux
      Linux Icon
    • Kubernetes
      Cloud icon
    • Automation
      Automation Icon showing arrows moving in a circle around a gear
    • View All Technologies
    • Programming Languages & Frameworks

      • Java
      • Python
      • JavaScript
    • System Design & Architecture

      • Red Hat architecture and design patterns
      • Microservices
      • Event-Driven Architecture
      • Databases
    • Developer Productivity

      • Developer productivity
      • Developer Tools
      • GitOps
    • Secure Development & Architectures

      • Security
      • Secure coding
    • Platform Engineering

      • DevOps
      • DevSecOps
      • Ansible automation for applications and services
    • Automated Data Processing

      • AI/ML
      • Data Science
      • Apache Kafka on Kubernetes
      • View All Technologies
    • Start exploring in the Developer Sandbox for free

      sandbox graphic
      Try Red Hat's products and technologies without setup or configuration.
    • Try at no cost
  • Learn

    Featured

    • Kubernetes & Cloud Native
      Openshift icon
    • Linux
      Rhel icon
    • Automation
      Ansible cloud icon
    • Java
      Java icon
    • AI/ML
      AI/ML Icon
    • View All Learning Resources

    E-Books

    • GitOps Cookbook
    • Podman in Action
    • Kubernetes Operators
    • The Path to GitOps
    • View All E-books

    Cheat Sheets

    • Linux Commands
    • Bash Commands
    • Git
    • systemd Commands
    • View All Cheat Sheets

    Documentation

    • API Catalog
    • Product Documentation
    • Legacy Documentation
    • Red Hat Learning

      Learning image
      Boost your technical skills to expert-level with the help of interactive lessons offered by various Red Hat Learning programs.
    • Explore Red Hat Learning
  • Developer Sandbox

    Developer Sandbox

    • Access Red Hat’s products and technologies without setup or configuration, and start developing quicker than ever before with our new, no-cost sandbox environments.
    • Explore Developer Sandbox

    Featured Developer Sandbox activities

    • Get started with your Developer Sandbox
    • OpenShift virtualization and application modernization using the Developer Sandbox
    • Explore all Developer Sandbox activities

    Ready to start developing apps?

    • Try at no cost
  • Blog
  • Events
  • Videos

RHDH Local — Test & Develop Locally With Red Hat Developer Hub Using Containers

March 31, 2025
Ben Wilcock
Related topics:
Developer ProductivityDeveloper ToolsDevOpsDevSecOps
Related products:
Red Hat Developer Hub

Share:

    For developers and platform engineers using Backstage, the ability to test configurations, plugins, and templates in an isolated environment is invaluable. That’s where RHDH Local comes in—a lightweight, self-contained way to run Red Hat Developer Hub (RHDH) on your local machine using containers and without a full Kubernetes setup.

    Whether you need to validate the configuration of software catalogs, write and test TechDocs, or build RHDH dynamic plugins, RHDH Local simplifies the process, allowing you to iterate quickly and troubleshoot locally before deploying changes to a production system.

    Let’s dive into what makes RHDH Local a valuable development tool for platform engineers and how they can get started.


    Why Use RHDH Local?

    1. Test Without Kubernetes
      Running a full Backstage-based developer portal typically requires Kubernetes, but not everyone wants to spin up a cluster just to experiment. RHDH Local removes that barrier—just install Docker or Podman, and you’re good to go.
       
    2. Experiment with Configurations & Plugins
      Need to tweak a homepage layout, test a new dynamic plugin, or configure GitHub integrations? RHDH Local provides a safe playground to validate these changes before rolling them out to a larger team.
       
    3. Simple, Fast, and Disposable
      Because it runs in a containerized environment, you can spin up RHDH Local in seconds and tear it down just as easily when you're done—without cluttering your system.
       
    4. Debugging in a Controlled Setup
      For developers working on custom Backstage plugins, RHDH Local offers a structured way to attach a debugger and troubleshoot issues without interfering with a production environment.
       
    5. Iterate Quickly On Your Dev Portal Content
      When writing and testing TechDocs, Templates, or Catalog items, RHDH Local offers a fast and simple solution that lets you work quickly and retain full control over your setup and your database.
    RHDH Local running in a browser and displaying a lightly modified home page view.
    RHDH Local running in a browser and displaying a lightly modified home page view.

    What You Need to Get Started

    • x86_64 (amd64) PC (ARM support is coming soon)
    • Podman or Docker installed
    • Internet connection (to access the code and container images)
    • git (for cloning the RHDH Local code repository)

    Setting Up RHDH Local

    Clone the repository

    git clone https://github.com/redhat-developer/rhdh-local.git
    cd rhdh-local

    Prepare your environment

    cp env.sample .env


    Most default settings in the copied .env file should work without requiring you to modify them.

    The RHDH_IMAGE used by default in the .env file requires an AMD64 based CPU to function. However, the community nightly image (quay.io/rhdh-community/rhdh:next) supports ARM64 and can be used as an alternative on Apple M* based systems.

    Start RHDH Local Using Podman

    podman-compose up -d

    Start RHDH Local Using Docker

    docker compose up -d

    That's it! If you use the defaults you can now access RHDH Local from your browser at http://localhost:7007 and start your testing.


    Modifying Your Configuration

    Updating app-config.local.yaml

    To apply any configuration changes you make, restart the RHDH container:

    podman-compose stop rhdh && podman-compose start rhdh

    Or for Docker:

    docker compose restart rhdh

    Testing Local Dynamic Plugins

    To load a new dynamic plugin from a local directory:

    1. Place the dynamic plugin in the local-plugins/ directory.
      To create a dynamic plugin out of the regular Backstage plugin, run npx @janus-idp/cli package export-dynamic-plugin inside the plugin’s source code. The dynamic plugin package will be generated in the dist-dynamic directory.
       
    2. Update configs/dynamic-plugins.yaml
      Enable the plugin and add any additional configuration that you need.

    Then you must run:

    podman-compose run install-dynamic-plugins
    podman-compose stop rhdh && podman-compose start rhdh

    Or for Docker:

    docker compose run install-dynamic-plugins
    docker compose restart rhdh

    Final Thoughts

    RHDH Local is a powerful tool for developers and platform engineers looking to test and refine their Backstage-based developer portals in a fast, lightweight, and disposable environment. While it’s not a replacement for a full RHDH deployment, it’s an invaluable resource for local development and testing.

    RHDH-Local is a Developer Preview. 🚀 Try it today and let us know what you think. Contributions and feedback are always welcome!

    👉 GitHub Repository

    Last updated: April 28, 2025
    Disclaimer: Please note the content in this blog post has not been thoroughly reviewed by the Red Hat Developer editorial team. Any opinions expressed in this post are the author's own and do not necessarily reflect the policies or positions of Red Hat.

    Recent Posts

    • How to use RHEL 10 as a WSL Podman machine

    • MINC: Fast, local Kubernetes with Podman Desktop & MicroShift

    • How to stay informed with Red Hat status notifications

    • Getting started with RHEL on WSL

    • llm-d: Kubernetes-native distributed inferencing

    Red Hat Developers logo LinkedIn YouTube Twitter Facebook

    Products

    • Red Hat Enterprise Linux
    • Red Hat OpenShift
    • Red Hat Ansible Automation Platform

    Build

    • Developer Sandbox
    • Developer Tools
    • Interactive Tutorials
    • API Catalog

    Quicklinks

    • Learning Resources
    • E-books
    • Cheat Sheets
    • Blog
    • Events
    • Newsletter

    Communicate

    • About us
    • Contact sales
    • Find a partner
    • Report a website issue
    • Site Status Dashboard
    • Report a security problem

    RED HAT DEVELOPER

    Build here. Go anywhere.

    We serve the builders. The problem solvers who create careers with code.

    Join us if you’re a developer, software engineer, web designer, front-end designer, UX designer, computer scientist, architect, tester, product manager, project manager or team lead.

    Sign me up

    Red Hat legal and privacy links

    • About Red Hat
    • Jobs
    • Events
    • Locations
    • Contact Red Hat
    • Red Hat Blog
    • Inclusion at Red Hat
    • Cool Stuff Store
    • Red Hat Summit

    Red Hat legal and privacy links

    • Privacy statement
    • Terms of use
    • All policies and guidelines
    • Digital accessibility

    Report a website issue