Installation and Prerequisites
Overview
Profound API does not have a separate installation. Profound API and Profound.js are the same runtime, delivered in a single profoundjs npm package. Profound API is enabled by the Profound API module on your license key.
For that reason, there is one set of installation documentation covering both products. The Profound.js installation pages linked below apply to a Profound API instance exactly as written.
Wherever the installation pages say "Profound.js", it applies to Profound API as well. The npm package, the installation directory layout, the complete_install.js prompts, the IBM i Connector, and the uninstall steps are all identical. The only Profound API-specific step is applying a license key that includes the Profound API module.
Where to Go
Task | Documentation |
|---|---|
Review prerequisites (Node.js, IBM i, Profound UI) | |
Install or upgrade from a command line | |
Install or upgrade using a GUI | |
Apply a license key | |
Verify the installation | |
Start and end instances | |
Upgrade to a new major release | |
Install on a system without internet access | |
Uninstall |
Supported Versions
Supported Profound API releases and their compatible Node.js versions are listed in two places, and those two pages are the only place they should be maintained:
Support windows - Product Support Policy, for standard and extended support dates;
NPM tags and Node.js versions - Installation Process, for the tag to install and the Node.js versions each release supports.
Version History
To install a specific release, see the Profound API Version Log.