Skip to content

Commit 6c715d6

Browse files
committed
Misc install doc updates
1 parent f419b74 commit 6c715d6

File tree

1 file changed

+39
-34
lines changed

1 file changed

+39
-34
lines changed

INSTALL.md

+39-34
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,19 @@ limitations under the License.
2020
1. [Node-oracledb Overview](#overview)
2121
2. [Quick Start Node-oracledb Installation](#quickstart)
2222
3. [Node-oracledb Installation Instructions](#instructions)
23-
- 3.1 [Prerequisites](#prerequisites)
24-
- 3.2 [Node-oracledb Installation on Linux with Instant Client RPMs](#instrpm)
25-
- 3.3 [Node-oracledb Installation on Linux with Instant Client ZIP files](#instzip)
26-
- 3.4 [Node-oracledb Installation on Linux with a Local Database or Full Client](#instoh)
27-
- 3.5 [Node-oracledb Installation on macOS](#instosx)
28-
- 3.6 [Node-oracledb Installation on Windows with Instant Client ZIP files](#instwin)
29-
- 3.7 [Node-oracledb Installation on Windows with a Local Database or Full Client](#instwinoh)
30-
- 3.8 [Copying node-oracledb Binaries on Windows](#winbins)
31-
- 3.9 [Node-oracledb Installation on AIX on Power Systems with Instant Client ZIP files](#instaix)
32-
- 3.10 [Node-oracledb Installation on Oracle Solaris x86-64 (64-Bit) with Instant Client ZIP files](#instsolarisx8664)
33-
- 3.11 [Node-oracledb Installation from Source Code](#github)
34-
- 3.12 [Node-oracledb Installation Without Internet Access](#offline)
35-
- 3.13 [Installing Node.js and Node-oracledb RPMs from yum.oracle.com](#instnoderpms)
23+
- 3.1 [Prerequisites](#prerequisites)
24+
- 3.2 [Node-oracledb Installation on Linux with Instant Client RPMs](#instrpm)
25+
- 3.3 [Node-oracledb Installation on Linux with Instant Client ZIP files](#instzip)
26+
- 3.4 [Node-oracledb Installation on Linux with a Local Database or Full Client](#instoh)
27+
- 3.5 [Node-oracledb Installation on macOS](#instosx)
28+
- 3.6 [Node-oracledb Installation on Windows with Instant Client ZIP files](#instwin)
29+
- 3.7 [Node-oracledb Installation on Windows with a Local Database or Full Client](#instwinoh)
30+
- 3.8 [Copying node-oracledb Binaries on Windows](#winbins)
31+
- 3.9 [Node-oracledb Installation on AIX on Power Systems with Instant Client ZIP files](#instaix)
32+
- 3.10 [Node-oracledb Installation on Oracle Solaris x86-64 (64-Bit) with Instant Client ZIP files](#instsolarisx8664)
33+
- 3.11 [Node-oracledb Installation from Source Code](#github)
34+
- 3.12 [Node-oracledb Installation Without Internet Access](#offline)
35+
- 3.13 [Installing Node.js and Node-oracledb RPMs from yum.oracle.com](#instnoderpms)
3636
4. [Installing Node-oracledb 1.x](#installingv1)
3737
5. [Useful Resources for Node-oracledb](#otherresources)
3838
6. [Troubleshooting Node-oracledb Installation Problems](#troubleshooting)
@@ -236,18 +236,18 @@ compatible glibc.
236236
#### 3.2.2 Install Node.js
237237

238238
Download and extract the [Node.js "Linux Binaries"][11] package. For
239-
example, if you downloaded version 6.9.4 for 64-bit you could install
239+
example, if you downloaded version 8.9.4 for 64-bit you could install
240240
Node.js into `/opt`:
241241

242242
```
243243
cd /opt
244-
tar -Jxf node-v6.9.4-linux-x64.tar.xz
244+
tar -Jxf node-v8.9.4-linux-x64.tar.xz
245245
```
246246

247247
Set `PATH` to include Node.js:
248248

249249
```
250-
export PATH=/opt/node-v6.9.4-linux-x64/bin:$PATH
250+
export PATH=/opt/node-v8.9.4-linux-x64/bin:$PATH
251251
```
252252

253253
#### 3.2.3 Install the add-on
@@ -377,18 +377,18 @@ compatible glibc.
377377
#### 3.3.2 Install Node.js
378378

379379
Download and extract the [Node.js "Linux Binaries"][11] package. For
380-
example, if you downloaded version 6.9.4 for 64-bit you could install
380+
example, if you downloaded version 8.9.4 for 64-bit you could install
381381
Node.js into `/opt`:
382382

383383
```
384384
cd /opt
385-
tar -Jxf node-v6.9.4-linux-x64.tar.xz
385+
tar -Jxf node-v8.9.4-linux-x64.tar.xz
386386
```
387387

388388
Set `PATH` to include Node.js:
389389

390390
```
391-
export PATH=/opt/node-v6.9.4-linux-x64/bin:$PATH
391+
export PATH=/opt/node-v8.9.4-linux-x64/bin:$PATH
392392
```
393393

394394
#### 3.3.3 Install the add-on
@@ -516,18 +516,18 @@ immediately used with other editions of the Oracle Database.
516516
#### 3.4.2 Install Node.js
517517

518518
Download and extract the [Node.js "Linux Binaries"][11] package. For
519-
example, if you downloaded version 6.9.4 for 64-bit you could install
519+
example, if you downloaded version 8.9.4 for 64-bit you could install
520520
Node.js into `/opt`:
521521

522522
```
523523
cd /opt
524-
tar -zxf node-v6.9.4-linux-x64.tar.gz
524+
tar -zxf node-v8.9.4-linux-x64.tar.gz
525525
```
526526

527527
Set `PATH` to include Node.js:
528528

529529
```
530-
export PATH=/opt/node-v6.9.4-linux-x64/bin:$PATH
530+
export PATH=/opt/node-v8.9.4-linux-x64/bin:$PATH
531531
```
532532

533533
#### 3.4.3 Install the add-on
@@ -1571,21 +1571,26 @@ about SQL or PL/SQL can be asked at
15711571

15721572
If `npm install oracledb` fails:
15731573

1574+
- Did you get an HTTPS 404 failure? A pre-built node-oracledb binary
1575+
package is probably not available on
1576+
https://github.com/oracle/node-oracledb/releases for your Node.js
1577+
version or operatiing system. Change your Node.js version or
1578+
compile node-oracledb from source code.
1579+
1580+
- Was there a network connection error? Do you need to set
1581+
`http_proxy` and/or `https_proxy`?
1582+
15741583
- Use `npm install --verbose oracledb`. Review your output and logs.
15751584
Try to install in a different way. Try some potential solutions.
15761585
Before installing on Windows also do `set
15771586
NODE_ORACLEDB_TRACE_INSTALL=TRUE`. On Linux and macOS use `export
15781587
NODE_ORACLEDB_TRACE_INSTALL=TRUE`.
15791588

1580-
- Was there a network connection error? Do you need to set
1581-
`http_proxy` and/or `https_proxy`?
1582-
1583-
- Was a pre-built node-oracledb binary available? If not, you will need
1584-
to compile one from source code.
1585-
1586-
- Does your compiler have C++11 support, e.g. use VS 2015 or GCC 4.8.
1589+
- When compiling node-oracledb from source, does your compiler have
1590+
C++11 support, e.g. use VS 2015 or GCC 4.8.
15871591

1588-
- Do you have Python 2.7? Run `python --version`.
1592+
- When compiling node-oracledb from source, do you have Python 2.7?
1593+
Run `python --version`.
15891594

15901595
- Do you have an old version of `node-gyp` installed? Try updating
15911596
it. Also try deleting `$HOME/.node-gyp` or equivalent.
@@ -1633,13 +1638,13 @@ Questions and issues can be posted as [GitHub Issues][10].
16331638

16341639

16351640

1636-
[1]: https://github.com/oracle/node-oracledb
1641+
[1]: http://oracle.github.io/node-oracledb/
16371642
[2]: https://www.python.org/downloads/
16381643
[3]: http://www.oracle.com/technetwork/database/database-technologies/instant-client/overview/index.html
16391644
[4]: https://www.npmjs.com/package/oracledb
16401645
[5]: https://blogs.oracle.com/opal/getting-a-c11-compiler-for-node-4,-5-and-6-on-oracle-linux-6
16411646
[6]: https://support.oracle.com/epmos/faces/DocumentDisplay?id=207303.1
1642-
[7]: https://github.com/oracle/node-oracledb/blob/master/doc/api.md#connectionstrings
1647+
[7]: https://oracle.github.io/node-oracledb/doc/api.html#connectionstrings
16431648
[8]: https://www.oracle.com/technetwork/community/oca-486395.html
16441649
[9]: https://www.github.com/oracle/odpi
16451650
[10]: https://github.com/oracle/node-oracledb/issues
@@ -1673,8 +1678,8 @@ Questions and issues can be posted as [GitHub Issues][10].
16731678
[39]: https://asktom.oracle.com/
16741679
[40]: https://github.com/oracle/node-oracledb/tags
16751680
[41]: https://github.com/oracle/node-oracledb/releases
1676-
[42]: https://github.com/oracle/node-oracledb/blob/master/doc/api.md#migratev1v2
1681+
[42]: https://oracle.github.io/node-oracledb/doc/api.html#migratev1v2
16771682
[43]: https://github.com/oracle/node-oracledb/blob/master/CHANGELOG.md
1678-
[44]: https://github.com/oracle/node-oracledb/blob/master/doc/api.md
1683+
[44]: https://oracle.github.io/node-oracledb/doc/api.html
16791684
[45]: https://www.youtube.com/watch?v=WDJacg0NuLo
16801685
[46]: http://yum.oracle.com/oracle-linux-nodejs.html

0 commit comments

Comments
 (0)