Skip to content

Commit 3a54f91

Browse files
committed
Add some detail to INSTALL
1 parent 0ae3b9e commit 3a54f91

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

INSTALL.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ limitations under the License.
2727

2828
## <a name="overview"></a> 1. Overview
2929

30+
The Oracle Database Node.js driver node-oracledb powers high performance Node.js applications.
31+
3032
The steps below create a Node.js installation for testing. Adjust the
3133
steps for your environment.
3234

@@ -87,6 +89,8 @@ cd /opt
8789
tar -zxf node-v0.10.38-linux-x64.tar.gz
8890
```
8991

92+
This node-oracledb release currently works only with Node.js 0.10.
93+
9094
Set PATH to include Node.js:
9195

9296
```
@@ -158,6 +162,8 @@ cd /opt
158162
tar -zxf node-v0.10.38-linux-x64.tar.gz
159163
```
160164

165+
This node-oracledb release currently works only with Node.js 0.10.
166+
161167
Set PATH to include Node.js:
162168

163169
```
@@ -181,7 +187,8 @@ cd instantclient
181187
ln -s libclntsh.so.12.1 libclntsh.so
182188
```
183189

184-
You will need `libaio` installed.
190+
You will need `libaio` installed. On some platforms the package is
191+
called `libaio1`.
185192

186193
To run applications, you will need to set the link path:
187194

@@ -218,6 +225,9 @@ Install node-oracledb from the
218225
npm install oracledb
219226
```
220227

228+
If you are installing with `sudo`, you may need to use `sudo -E` to
229+
preserve the environment variable values.
230+
221231
### 3.4 Run an example program
222232

223233
Download the
@@ -263,6 +273,8 @@ cd /opt
263273
tar -zxf node-v0.10.38-linux-x64.tar.gz
264274
```
265275

276+
This node-oracledb release currently works only with Node.js 0.10.
277+
266278
Set your PATH variable to include Node.js:
267279

268280
```
@@ -289,6 +301,9 @@ Install node-oracledb from the
289301
npm install oracledb
290302
```
291303

304+
If you are installing with `sudo`, you may need to use `sudo -E` to
305+
preserve the environment variable values.
306+
292307
### 4.3 Run an example program
293308

294309
Set `LD_LIBRARY_PATH` to the Oracle library directory. This variable,
@@ -333,6 +348,8 @@ Node.js 0.10 can be installed from various sources, such as via *brew*.
333348
brew install node010
334349
```
335350

351+
This node-oracledb release currently works only with Node.js 0.10.
352+
336353
Set your PATH to include the *node* and *npm* binaries:
337354

338355
```
@@ -381,6 +398,9 @@ Install node-oracledb from the
381398
npm install oracledb
382399
```
383400

401+
If you are installing with `sudo`, you may need to use `sudo -E` to
402+
preserve the environment variable values.
403+
384404
### 5.5 Run an example program
385405

386406
Download the
@@ -433,11 +453,11 @@ Install the 64-bit Node.js 0.10 MSI (e.g. node-v0.10.38-x64.msi) from
433453
[nodejs.org](http://nodejs.org/download/). Make sure the option to
434454
add the Node and npm directories to the path is selected.
435455

436-
Node-oracledb 0.4 will not build with Node.js 0.12.
456+
This node-oracledb release currently works only with Node.js 0.10.
437457

438458
### 6.3 Install the free Oracle Instant Client ZIPs
439459

440-
Skip this step if you already have Oracle Database or full Oracle client on your machine.
460+
Skip this step if you already have Oracle Database or the full Oracle client on your machine.
441461

442462
Download the free 'Basic' and 'SDK' ZIP files from
443463
[Oracle Technology Network](http://www.oracle.com/technetwork/topics/winx64soft-089540.html).
@@ -560,6 +580,9 @@ This is useful if you will need to upgrade Oracle Instant Client RPMs
560580
to a new major or minor version (for example from 11.2 to 12.1)
561581
without re-installing node-oracledb.
562582

583+
If you are installing with `sudo`, you may need to use `sudo -E` to
584+
preserve the environment variable values.
585+
563586
### Forcing RPATH
564587

565588
If you want to force using rpath when installing node-oracledb on

0 commit comments

Comments
 (0)