Note: This section is not required if using Docker or only using the CLI.
Before you install Zowe™ on z/OS, you must install IBM SDK for Node.js on the same z/OS server that hosts the Zowe Application Server and z/OS Explorer Services. Review the information in this topic to obtain and install Node.js.
- Supported Node.js versions
- How to obtain IBM SDK for Node.js - z/OS
- Hardware and software prerequisites
- Installing the PAX edition of Node.js - z/OS
- Installing the SMP/E edition of Node.js - z/OS
The following Node.js versions are supported to run Zowe. See the Hardware and software prerequisites section for the prerequisites that are required by Zowe.
The corresponding IBM Knowledge Center for Node.js - z/OS lists all the prerequisites for Node.js. Some software packages, which might be listed as prerequisites there, are NOT required by Zowe. Specifically, you do NOT need to install Python, Make, Perl, or C/C++ runtime or compiler. If you can run
node --version successfully, you have installed the prerequisites required by Zowe.
v8.x (except v8.16.1)
Known issue: There is a known issue with node.js v8.16.1 and Zowe desktop encoding. See the GitHub issue for details.
Workaround: Use node.js v8.16.2 or later, which is available at https://www.ibm.com/ca-en/marketplace/sdk-nodejs-compiler-zos. Download the
You can obtain IBM SDK for Node.js - z/OS for free in one of the following ways:
- Order the SMP/E edition through your IBM representative for production use
- Use the PAX edition for non-production deployments
For more information, see the blog "How to obtain IBM SDK for Node.js - z/OS, at no charge".
To install Node.js for Zowe, the following requirements must be met.
The corresponding IBM Knowledge Center for Node.js - z/OS lists all the prerequisites for Node.js. Some software packages, which might be listed as prerequisites there, are NOT required by Zowe. Specifically, you do NOT need to install Python, Make, Perl, or C/C++ runtime or compiler.
If you can run
node --version successfully, you have installed the Node.js prerequisites required by Zowe.
IBM zEnterprise® 196 (z196) or newer
z/OS UNIX System Services enabled
Integrated Cryptographic Service Facility (ICSF) configured and started
ICSF is required for Node.js to operate successfully on z/OS. If you have not configured your z/OS environment for ICSF, see Cryptographic Services ICSF: System Programmer's Guide. To see whether ICSF has been started, check whether the started task
Follow these steps to install the PAX edition of Node.js - z/OS to run Zowe.
Download the pax.Z file to a z/OS machine.
Extract the pax.Z file inside an installation directory of your choice. For example:
pax -rf <path_to_pax.Z_file> -x pax
Add the full path of your installation directory to your PATH environment variable:
Run the following command from the command line to verify the installation.
If Node.js is installed correctly, the version of Node.js is displayed.
After you install Node.js, set the NODE_HOME environment variable to the directory where Node.js is installed. For example,
To install the SMP/E edition of Node.js, see the documentation for IBM SDK for Node.js - z/OS. Remember that the software packages Perl, Python, Make, or C/C++ runtime or compiler that the Node.js documentation might mention are NOT needed by Zowe.