Skip to content

Commit f44f867

Browse files
committed
Emphasize the OCI_{INC,LIB}_DIR are install time only
1 parent f1ff797 commit f44f867

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

INSTALL.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Installing node-oracledb
1+
Installing node-oracledb
22

33
*Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.*
44

@@ -131,8 +131,8 @@ Node-oracledb will automatically be configured to use the highest version
131131
Instant Client RPMs installed. To use a different version, follow the
132132
instructions to
133133
[install on Linux with Instant Client ZIP files](#instzip) instead,
134-
setting `OCI_LIB_DIR` and `OCI_INC_DIR` to the appropriate
135-
directories.
134+
setting the install-time variables `OCI_LIB_DIR` and `OCI_INC_DIR` to
135+
the appropriate directories.
136136

137137
If you have other Oracle software installed on the same machine, and
138138
the runtime linker is configured to find this other software via
@@ -224,6 +224,8 @@ export OCI_LIB_DIR=/opt/oracle/instantclient_12_1
224224
export OCI_INC_DIR=/opt/oracle/instantclient_12_1/sdk/include
225225
```
226226

227+
These variables are only needed during installation.
228+
227229
If Instant Client is in `/opt/oracle/instantclient` and you have no
228230
other Oracle software installed, then these variables are not
229231
required. See
@@ -310,6 +312,8 @@ export OCI_LIB_DIR=$ORACLE_HOME/lib
310312
export OCI_INC_DIR=$ORACLE_HOME/rdbms/public
311313
```
312314

315+
These variables are only needed during installation.
316+
313317
If you are behind a firewall, you may need to set your proxy, for
314318
example:
315319

@@ -412,8 +416,10 @@ export OCI_LIB_DIR=/whereever/instantclient
412416
export OCI_INC_DIR=/whereever/instantclient/sdk/include
413417
```
414418

419+
These variables are only needed during installation.
420+
415421
If Instant Client is in `/opt/oracle/instantclient`, then these
416-
variables are not needed.
422+
variables are not needed at all.
417423

418424
If you are behind a firewall, you may need to set your proxy, for
419425
example:
@@ -516,10 +522,12 @@ restart the command shell.
516522
Tell the installer where to locate the Instant Client:
517523

518524
```
519-
set OCI_LIB_DIR=C:\oracle\instantclient_12_1\sdk\lib\msvc
520-
set OCI_INC_DIR=C:\oracle\instantclient_12_1\sdk\include
525+
set OCI_LIB_DIR=C:\wherever\instantclient_12_1\sdk\lib\msvc
526+
set OCI_INC_DIR=C:\wherever\instantclient_12_1\sdk\include
521527
```
522528

529+
These variables are only needed during installation.
530+
523531
If Instant Client is in `C:\oracle\instantclient` (this should
524532
contain, amongst others, the file `C:\oracle\instantclient\oci.dll`
525533
and directory `C:\oracle\instantclient\sdk`), then these variables are
@@ -607,6 +615,7 @@ If you want to use Instant Client RPMs without using rpath, then set
607615
export OCI_LIB_DIR=/usr/lib/oracle/12.1/client64/lib
608616
export OCI_INC_DIR=/usr/include/oracle/12.1/client64
609617
npm install oracledb
618+
unset OCI_LIB_DIR OCI_INC_DIR
610619
export LD_LIBRARY_PATH=/usr/lib/oracle/12.1/client64/lib:$LD_LIBRARY_PATH
611620
node example.js
612621
```
@@ -628,5 +637,6 @@ to any value. For example:
628637
export OCI_LIB_DIR=/opt/oracle/instantclient
629638
export OCI_INC_DIR=/opt/oracle/instantclient/sdk/include
630639
FORCE_RPATH=1 npm install oracledb
640+
unset OCI_LIB_DIR OCI_INC_DIR
631641
node example.js
632642
```

0 commit comments

Comments
 (0)