{"id":19874466,"url":"https://github.com/strongloop/loopback-oracle-installer","last_synced_at":"2025-05-02T10:31:12.607Z","repository":{"id":9217478,"uuid":"11030765","full_name":"strongloop/loopback-oracle-installer","owner":"strongloop","description":"Loopback Oracle Installer","archived":false,"fork":false,"pushed_at":"2020-05-08T15:59:32.000Z","size":92,"stargazers_count":7,"open_issues_count":0,"forks_count":4,"subscribers_count":32,"default_branch":"master","last_synced_at":"2025-04-07T01:05:15.154Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/strongloop.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null}},"created_at":"2013-06-28T15:57:21.000Z","updated_at":"2022-03-03T01:03:18.000Z","dependencies_parsed_at":"2022-08-02T18:45:43.006Z","dependency_job_id":null,"html_url":"https://github.com/strongloop/loopback-oracle-installer","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strongloop%2Floopback-oracle-installer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strongloop%2Floopback-oracle-installer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strongloop%2Floopback-oracle-installer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/strongloop%2Floopback-oracle-installer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/strongloop","download_url":"https://codeload.github.com/strongloop/loopback-oracle-installer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252023239,"owners_count":21682146,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T16:23:28.012Z","updated_at":"2025-05-02T10:31:12.326Z","avatar_url":"https://github.com/strongloop.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# loopback-oracle-installer\n\nThe Oracle connector version 3.0.0 or above depends on the [oracledb](https://github.com/oracle/node-oracledb) module as the Node.js driver for Oracle databases. Since `oracledb` is a [C++ add-on](http://nodejs.org/api/addons.html), the installation requires C++ development tools to compile and build the module from source code.  For more information, see [Installing compiler tools](http://loopback.io/doc/en/lb3/Installing-compiler-tools.html).\n\nAt runtime, strong-oracle also requires dynamic libraries from \n[Oracle Database Instant Client](http://www.oracle.com/technetwork/database/features/instant-client/index.html).\n\nThe `loopback-oracle-installer` module takes care of the binary dependencies and simplifies the whole process.  \n\nThe installer automatically downloads and extracts the prebuilt `oracledb` to the `/loopback-connector-oracle/node_modules` directory and Oracle Database Instant Client into `\u003cUserHomeDirectory\u003e/oracle-instant-client`.  If a prebuilt bundle does not exist for your client platform and Node version, the installer prompts you to install Oracle prerequisites.\nFor more information, see  [Installing node-oracledb](https://github.com/oracle/node-oracledb/blob/master/INSTALL.md).\n\nOnce you've installed the Oracle prerequisites, re-install the Oracle connector by entering following command:\n\n```shell\n$ npm install loopback-connector-oracle --save\n```\n\nThis internally executes the `npm install oracledb` command.\n\n## Troubleshooting\n\nIf you have problems installing `loopback-connector-oracle`, make sure this symbolic link exists:\n\n```\nlibclntsh.dylib -\u003e libclntsh.dylib.11.1\n```\n\nMake sure you've set the following environment variables (for example on OS X):\n\n```\n$ export OCI_LIB_DIR=$HOME/oracle-instant-client\n$ export OCI_INC_DIR=$HOME/oracle-instant-client/sdk/include\n```\n\nIf a prebuilt bundle does not exist for your client platform and Node version, and you have installed\nOracle pre-requisites as described in [Installing node-oracledb](https://github.com/oracle/node-oracledb/blob/master/INSTALL.md), then\nset the environment variables as follows:\n\n```\n$ export OCI_LIB_DIR=/opt/oracle/instantclient\n$ export OCI_INC_DIR=/opt/oracle/instantclient/sdk/include\n```\n\n## Post-installation setup\n\n{% include warning.html content=\"Before you run the application, you **MUST** configure the environment variable depending on the target platform to make sure the dynamic libraries\nfrom Oracle Instant Client are available to your Node process.\n\" %}\n\n### MacOS X or Linux\n\nEnter this command to set the `LD_LIBRARY_PATH` environment variable:\n\n```\n$ export LD_LIBRARY_PATH=\"$LD_LIBRARY_PATH:$HOME/oracle-instant-client\"\n```\n\nIf a prebuilt bundle does not exist for your client platform and Node version, and you have installed Oracle prerequisites as per [Installing node-oracledb](https://github.com/oracle/node-oracledb/blob/master/INSTALL.md), then set the environment variables as follows:\n\n```\n$ export LD_LIBRARY_PATH=\"$LD_LIBRARY_PATH:$OCI_LIB_DIR\"\n```\n\n### Linux\n\nOn Linux systems, the `libaio` library is required. If it is not present, you must install it as follows:\n\nUbuntu/Debian:\n\n```\n$ sudo apt-get install libaio1\n```\n\nFedora/CentOS/RHEL:\n\n```\n$ sudo yum install libaio\n```\n\n### Windows\n\nSet the PATH environment variable for the logged-in user.  Note however that the PATH setting will NOT be effective immediately. You  must activate it using one of the methods below:\n\n1.  Log off the current user session and log in again.\n2.  Follow these steps to reset environment variables:\n    - Open Control Panel --\u003e System --\u003e Advanced System Settings --\u003e Environment Variables.\n    - Examine the **Path** under **User variables**, and click **OK** to activate it.\n    - Open a new Command Prompt then enter the 'path' command to verify.\n\n## Installation behind a proxy server\n\n{% include important.html content=\"\nThis feature is supported by loopback-oracle-installer vesion 1.1.3 or later.\n\" %}\n\nIf your system is behind a corporate HTTP/HTTPS proxy to access the internet, you must set the proxy for npm before running `npm install`.\n\nFor example,\n\n```shell\n$ npm config set proxy http://proxy.mycompany.com:8080\n$ npm config set https-proxy http://https-proxy.mycompany.com:8080\n```\n\nIf the proxy URL requires username/password, use the following syntax:\n\n```shell\n$ npm config set proxy http://youruser:yourpass@proxy.mycompany.com:8080\n$ npm config set https-proxy http://youruser:yourpass@https-proxy.mycompany.com:8080\n```\n\nYou can also set the proxy as part of the npm command as follows:\n\n```shell\n$ npm --proxy=http://proxy.mycompany.com:8080 install\n$ npm --https-proxy=http://https-proxy.mycompany.com:8080 install\n```\n\nNOTE: npm's default value for [proxy](https://www.npmjs.org/doc/misc/npm-config.html#proxy) is from the `HTTP_PROXY` or `http_proxy` environment variable.\nAnd the default value for [https-proxy](https://www.npmjs.org/doc/misc/npm-config.html#https-proxy) \nis from the `HTTPS_PROXY`, `https_proxy`, `HTTP_PROXY`, or `http_proxy` environment variable.\nSo you can configure the proxy using environment variables too.\n\nLinux or Mac:\n\n```shell\nHTTP_PROXY=http://proxy.mycompany.com:8080 npm install\n```\n\nWindows:\n\n```shell\nset HTTP_PROXY=http://proxy.mycompany.com:8080\nnpm install\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstrongloop%2Floopback-oracle-installer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstrongloop%2Floopback-oracle-installer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstrongloop%2Floopback-oracle-installer/lists"}