Skip to content

Commit 3ba12f4

Browse files
committed
Align Dockerfiles with latest Oracle Linux files. Remove some very old version info
1 parent 7c7d0ba commit 3ba12f4

File tree

1 file changed

+26
-54
lines changed

1 file changed

+26
-54
lines changed

INSTALL.md

Lines changed: 26 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,6 @@ limitations under the License.
4646
- 3.9 [Hosting your own node-oracledb Packages](#selfhost)
4747
- 3.10 [Using node-oracledb in Docker](#docker)
4848
4. [Installing Older Versions of Node-oracledb](#installingoldvers)
49-
- 4.1 [Installing node-oracledb 2.x and 3.x](#installingv2)
50-
- 4.2 [Installing node-oracledb 1.x](#installingv1)
5149
5. [Troubleshooting Node-oracledb Installation Problems](#troubleshooting)
5250

5351
## <a name="overview"></a> 1. Node-oracledb Overview
@@ -58,11 +56,10 @@ The steps below create a Node.js installation for testing. Adjust the
5856
steps for your environment.
5957

6058
This node-oracledb release has been tested with Node.js 10, 12 and 14 on 64-bit
61-
Oracle Linux, Windows and macOS Mojave 10.14. Note Node.js 10.16, or later is
62-
required. The add-on can also build on some 32-bit Linux, 32-bit Windows,
63-
Solaris and AIX environments, but these architectures have not been fully
64-
tested. Older versions of node-oracledb may work with older versions of
65-
Node.js.
59+
Oracle Linux, Windows and macOS. Note Node.js 10.16, or later is required. The
60+
add-on can also build on some 32-bit Linux, 32-bit Windows, Solaris and AIX
61+
environments, but these architectures have not been fully tested. Older
62+
versions of node-oracledb may work with older versions of Node.js.
6663

6764
Node-oracledb requires Oracle Client libraries version 11.2 or later, and
6865
can connect to Oracle Database 9.2 or later, depending on the Oracle Client library
@@ -663,7 +660,7 @@ Questions and issues can be posted as [GitHub Issues][10].
663660

664661
Review the generic [prerequisites](#prerequisites).
665662

666-
The pre-built binaries were built on macOS Mojave, 10.14.6.
663+
The pre-built binaries were built on macOS Mojave 10.14.6.
667664

668665
Oracle Instant Client libraries are required on macOS. Note that Oracle Instant
669666
Client 19c and earlier are not supported on macOS Catalina 10.15: you will need
@@ -1540,6 +1537,8 @@ or your `package.json` would contain:
15401537
have a `Dockerfile` with steps to create a Docker image. Once created, the
15411538
image can be shared and run.
15421539

1540+
Sample Dockerfiles for Oracle Linux are available on [GitHub][65].
1541+
15431542
#### Installing Node.js in Docker
15441543

15451544
If your `Dockerfile` uses Oracle Linux:
@@ -1551,14 +1550,13 @@ FROM oraclelinux:7-slim
15511550
Then you can install Node.js from [yum.oracle.com][46] using:
15521551

15531552
```
1554-
RUN yum -y install oracle-release-el7 oracle-nodejs-release-el7 && \
1555-
yum-config-manager --disable ol7_developer_EPEL && \
1553+
RUN yum -y install oracle-nodejs-release-el7 && \
15561554
yum -y install nodejs && \
15571555
rm -rf /var/cache/yum
15581556
```
15591557

1560-
Alternatively you may prefer to use a [Node.js image from
1561-
Docker Hub][56], for example using:
1558+
One alternative to Oracle Linux is to use a [Node.js image from Docker Hub][56],
1559+
for example using:
15621560

15631561
```
15641562
FROM node:12-buster-slim
@@ -1585,7 +1583,6 @@ install Instant Client. Three methods are shown below.
15851583

15861584
```
15871585
RUN yum -y install oracle-release-el7 && \
1588-
yum-config-manager --enable ol7_oracle_instantclient && \
15891586
yum -y install oracle-instantclient19.6-basiclite && \
15901587
rm -rf /var/cache/yum
15911588
```
@@ -1720,7 +1717,6 @@ If you use Oracle Linux, your `Dockerfile` will be like:
17201717
FROM oraclelinux:7-slim
17211718
17221719
RUN yum -y install oracle-release-el7 oracle-nodejs-release-el7 && \
1723-
yum-config-manager --disable ol7_developer_EPEL --enable ol7_oracle_instantclient && \
17241720
yum -y install nodejs oracle-instantclient19.6-basiclite && \
17251721
rm -rf /var/cache/yum
17261722
@@ -1767,7 +1763,7 @@ For either Dockerfile, the `package.json` is:
17671763
"myapp"
17681764
],
17691765
"dependencies": {
1770-
"oracledb" : "^4"
1766+
"oracledb" : "^5"
17711767
},
17721768
"author": "Me",
17731769
"license": "UPL"
@@ -1827,55 +1823,31 @@ The output is like:
18271823
rows: [ { D: '24-Nov-2019 23:39' } ] }
18281824
```
18291825

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

1832-
### <a name="installingv2"></a> 4.1 Installing node-oracledb 2.x and 3.x
1833-
1834-
Pre-built node-oracledb 2 and 3 binaries are available for some platforms and
1828+
Pre-built node-oracledb 3 and 4 binaries are available for some platforms and
18351829
Node.js versions. Review the [release tags][41] for availability. You can
1836-
compile the add-on for other platforms or Node.js versions.
1830+
compile the add-on for other platforms or versions.
1831+
1832+
The node-oracledb 4.2 installation steps are in the [version 4.2 INSTALL
1833+
guide][66].
18371834

18381835
The node-oracledb 3.1 installation steps are in the [version 3.1 INSTALL
18391836
guide][55].
18401837

1841-
The node-oracledb 3.0 installation steps are in the [version 3.0 INSTALL
1842-
guide][54].
1843-
1844-
The node-oracledb 2.x installation steps are in the [version 2.x INSTALL
1845-
guide][52]
1846-
1847-
To get an old add-on you must explicitly use its version when installing:
1848-
1849-
```
1850-
npm install [email protected]
1851-
```
1852-
1853-
or your `package.json` could contain:
1854-
1855-
```
1856-
. . .
1857-
"dependencies": {
1858-
"oracledb": "2.3.0"
1859-
},
1860-
. . .
1861-
```
1862-
1863-
### <a name="installingv1"></a> 4.2 Installing node-oracledb 1.x
1864-
1865-
The node-oracledb 1.x installation steps are in the [version 1.x
1866-
INSTALL guide][32]. This version always requires compilation. To get
1867-
an old add-on you must explicitly use its version when installing:
1838+
To get an old add-on you must explicitly use its version when installing, for
1839+
example:
18681840

18691841
```
1870-
npm install oracledb@1.13.1
1842+
npm install oracledb@4.2.0
18711843
```
18721844

18731845
or your `package.json` could contain:
18741846

18751847
```
18761848
. . .
18771849
"dependencies": {
1878-
"oracledb": "1.13.1"
1850+
"oracledb": "4.2.0"
18791851
},
18801852
. . .
18811853
```
@@ -1911,8 +1883,9 @@ If `npm install oracledb` fails:
19111883

19121884
If creating a connection fails:
19131885

1914-
- If you got *DPI-1047: Cannot locate an Oracle Client library*,
1915-
then review any messages and the installation instructions.
1886+
- If you got *DPI-1047: Cannot locate an Oracle Client library*, then review any
1887+
messages, the installation instructions, and see [Initializing
1888+
Node-oracledb][17].
19161889

19171890
- If you got *DPI-1072: the Oracle Client library version is unsupported*, then
19181891
review the installation requirements. Node-oracledb needs Oracle client
@@ -1974,7 +1947,6 @@ Issues and questions about node-oracledb can be posted on [GitHub][10] or
19741947
[29]: https://www.microsoft.com/en-us/download/details.aspx?id=3387
19751948
[30]: https://www.oracle.com/database/technologies/instant-client/aix-ppc64-downloads.html
19761949
[31]: https://www.oracle.com/database/technologies/instant-client/solx8664-downloads.html
1977-
[32]: https://github.com/oracle/node-oracledb/blob/v1.13.1/INSTALL.md
19781950
[40]: https://github.com/oracle/node-oracledb/tags
19791951
[41]: https://github.com/oracle/node-oracledb/releases
19801952
[42]: https://oracle.github.io/node-oracledb/doc/api.html#migratev1v2
@@ -1987,9 +1959,7 @@ Issues and questions about node-oracledb can be posted on [GitHub][10] or
19871959
[49]: https://join.slack.com/t/node-oracledb/shared_invite/enQtNDU4Mjc2NzM5OTA2LWMzY2ZlZDY5MDdlMGZiMGRkY2IzYjI5OGU4YTEzZWM5YjQ3ODUzMjcxNWQyNzE4MzM5YjNkYjVmNDk5OWU5NDM
19881960
[50]: http://yum.oracle.com/repo/OracleLinux/OL6/oracle/instantclient/x86_64/index.html
19891961
[51]: http://yum.oracle.com/repo/OracleLinux/OL7/oracle/instantclient/x86_64/index.html
1990-
[52]: https://github.com/oracle/node-oracledb/blob/v2.3.0/INSTALL.md
19911962
[53]: https://nodejs.org/api/n-api.html
1992-
[54]: https://github.com/oracle/node-oracledb/blob/v3.0.1/INSTALL.md
19931963
[55]: https://github.com/oracle/node-oracledb/blob/v3.1.2/INSTALL.md
19941964
[56]: https://hub.docker.com/_/node/
19951965
[57]: https://oracle.github.io/node-oracledb/doc/api.html#connectionadb
@@ -2000,3 +1970,5 @@ Issues and questions about node-oracledb can be posted on [GitHub][10] or
20001970
[62]: https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-81D364CE-326D-4B3C-8C82-F468FF1AF30C
20011971
[63]: https://github.com/oracle/node-oracledb/tree/master/examples/example.js
20021972
[64]: https://oracle.github.io/node-oracledb/doc/api.html#odbinitoracleclient
1973+
[65]: https://github.com/oracle/docker-images/tree/master/OracleLinuxDevelopers/oraclelinux7/nodejs
1974+
[66]: https://github.com/oracle/node-oracledb/blob/v4.2.0/INSTALL.md

0 commit comments

Comments
 (0)