# Installing node-oracledb

*Copyright (c) 2015, 2023, Oracle and/or its affiliates.*

This software is dual-licensed to you under the Universal Permissive License
(UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose
either license.

If you elect to accept the software under the Apache License, Version 2.0,
the following applies:

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied.  See the License for the
specific language governing permissions and limitations under the License.

## Note: The node-oracledb installation instructions have moved to [https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html).

## <a name="overview"></a> 1. Node-oracledb Overview

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#overview)

## <a name="quickstart"></a> 2. Quick Start node-oracledb Installation

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#quickstart)

## <a name="instructions"></a> 3. Node-oracledb Installation Instructions

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instructions)

### <a name="prerequisites"></a> 3.1 Prerequisites

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#prerequisites)

#### <a name="linuxinstall"></a> 3.2 Node-oracledb Installation on Linux

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#linuxinstall)

#### <a name="instzip"></a> 3.2.1 Node-oracledb Installation on Linux x86_64 with Instant Client ZIP files

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instzip)

#### <a name="instoh"></a> 3.2.2 Node-oracledb installation on Linux x86_64 with a Local Database or Full Client

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instoh)

#### <a name="instrpm"></a> 3.2.3 Node-oracledb Installation on Linux x86_64 with Instant Client RPMs

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instrpm)

#### <a name="aarch64"></a> 3.2.4 Node-oracledb Installation on Linux ARM (aarch64)

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#aarch64)

#### <a name="instnoderpms"></a> 3.2.5 Installing Node.js and node-oracledb RPMs from yum.oracle.com

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instnoderpms)

### <a name="instosx"></a> 3.3 Node-oracledb Installation on Apple macOS (Intel x86)

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instosx)

### <a name="windowsinstallation"></a> 3.4 Node-oracledb Installation on Microsoft Windows

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#windowsinstallation)

#### <a name="instwin"></a> 3.4.1 Node-oracledb Installation on Microsoft Windows with Instant Client ZIP files

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instwin)

#### <a name="instwinoh"></a> 3.4.2 Node-oracledb Installation on Microsoft Windows with a Local Database or Full Client

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instwinoh)

### <a name="instaix"></a> 3.5 Node-oracledb Installation on AIX on Power Systems with Instant Client ZIP files

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instaix)

### <a name="instsolarisx8664"></a> 3.6 Node-oracledb Installation on Oracle Solaris x86-64 (64-Bit) with Instant Client ZIP files

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instsolarisx8664)

### <a name="github"></a> <a name="compileenv"></a> 3.7 Node-oracledb Installation from Source Code

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#github)

#### <a name="githubclone"></a> 3.7.1 Installing GitHub clones and ZIP files

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#githubclone)

#### <a name="githubtags"></a> 3.7.2 Installing using GitHub branches and tags

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#githubtags)

#### <a name="sourcepackage"></a> 3.7.3 Installing from a source package

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#sourcepackage)

#### <a name="nogithubaccess"></a> 3.7.4 Installing from Oracle's repository

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#nogithubaccess)

#### <a name="compilepackage"></a> 3.7.5 Creating a node-oracledb package from source code

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#compilepackage)

### <a name="offline"></a> <a name="intermediateinstall"></a> 3.8 Node-oracledb Installation Without Internet Access

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#offline)

#### <a name="winbins"></a> 3.8.1 Copying node-oracledb Binaries on Windows

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#winbins)

### <a name="selfhost"></a> 3.9 Hosting your own node-oracledb Packages

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#selfhost)

### <a name="docker"></a> 3.10 Using node-oracledb in Docker

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#docker)

## <a name="installingoldvers"></a> <a name="installingv2"></a> <a name="installingv1"></a> 4. Installing Older Versions of Node-oracledb

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#installingoldvers)

## <a name="troubleshooting"></a> 5. Troubleshooting Node-oracledb Installation Problems

[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#troubleshooting)