Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 2. Installation

This chapter guides you through the steps to install Red Hat build of Rhea in your environment.

2.1. Prerequisites
Copy link

  • You must have a subscription to access AMQ release files and repositories.
  • You must install the npm command line tool in your environment. See the npm website for more information.
  • To use Red Hat build of Rhea, you must install Node.js in your environment. See the Node.js website for more information.
  • Red Hat build of Rhea depends on the Node.js debug module. See the debug npm page for installation instructions.

2.2. Using the Red Hat NPM registry
Copy link

Configure your NPM environment to download the client library from the Red Hat NPM registry.

Procedure

  1. Use the npm config set command to add the Red Hat NPM registry to your environment: 

    $ sudo npm config set @redhat:registry https://npm.registry.redhat.com
    Copy to Clipboard Toggle word wrap

  2. Use the npm install command to install the client: 

    $ sudo npm install -g @redhat/rhea@3.0.4-redhat-00001
    Copy to Clipboard Toggle word wrap
Note

The procedure above is for system-wide installations. You can run the commands without sudo and without the -g option to perform local installations.

To configure your environment to use the installed library, add the node_modules/@redhat directory to the NODE_PATH environment variable:

Red Hat Enterprise Linux

$ export NODE_PATH=/usr/local/lib/node_modules/@redhat:$NODE_PATH
Copy to Clipboard Toggle word wrap

Windows

$ set NODE_PATH=%AppData%\Roaming\npm\node_modules\@redhat;%NODE_PATH%
Copy to Clipboard Toggle word wrap

To test your installation, use the following command. It prints OK to the console if it successfully imports the installed library. 

$ node -e 'require("rhea")' && echo OK
OK
Copy to Clipboard Toggle word wrap

2.3. Deploying the client in a browser
Copy link

Red Hat build of Rhea can run inside a web browser. The NPM package includes a file named rhea.js at the following location that can be used in browser-based applications: 

/usr/local/lib/node_modules/@redhat/rhea/dist/rhea.js
Copy to Clipboard Toggle word wrap

Copy the rhea.js file to a location exposed by your web server and reference it using the HTML <script> element, as in this example:

Example: Running the client in a browser

<!DOCTYPE html>
<html>
<head>
  <title>Example</title>
  <script src="rhea.js"></script>
</head>
<body>
  <script>
    const rhea = require("rhea");
    const container = rhea.create_container();

    container.on("message", (event) => {
        console.log(event.message.body);
    });

    const ws = container.websocket_connect(WebSocket);
    const details = ws("ws://example.net:5673", ["binary", "AMQPWSB10", "amqp"])

    const conn = container.connect({"connection_details": details});
    conn.open_receiver("notifications");
  </script>
</body>
Copy to Clipboard Toggle word wrap

2.4. Installing the examples
Copy link

  1. Use the git clone command to clone the source repository to a local directory named rhea: 
$ git clone https://github.com/amqp/rhea.git
Copy to Clipboard Toggle word wrap

Change to the rhea directory and use the git checkout command to checkout the commit associated with this release: 

$ cd rhea
$ git checkout 3.0.4
Copy to Clipboard Toggle word wrap

The resulting local directory is referred to as <source-dir> in this guide.

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat