|author||Igor Sapego <email@example.com>||Tue Feb 08 11:32:44 2022 +0300|
|committer||Igor Sapego <firstname.lastname@example.org>||Tue Feb 08 11:32:44 2022 +0300|
IGNITE-16490 Add index.md to generate main page and added info to README.md This closes #4
npm are installed, you can use one of the following installation options.
This is a recommended way for users. Execute the following command to install the Node.js Thin Client package:
npm install -g apache-ignite-client
This way is more suitable for developers or if you install client from zip archive. If you want to install the Thin Client library from Ignite sources, please follow the steps:
npm link apache-ignite-clientcommand
cd nodejs-thin-client npm link npm link apache-ignite-client #linking examples (optional)
If you installed GridGain client globally, run the following command:
npm update -g @gridgain/thin-client
If you installed GridGain client locally, follow the following instruction:
npm outdatedcommand. There should not be any output
cd nodejs-thin-client npm update npm outdated
Node.js Client for Apache Ignite contains Jasmine tests to check the behavior of the client. the tests include:
Tests are installed along with the client. Follow the Installation instructions.
npm test command from
npm run test:examples command from
Active Ignite server node with non-default configuration is required (authentication and TLS switched on).
If the server runs locally:
nodejs-thin-client/examples/certs/folder. Password for the files:
If the server runs remotely, and/or other certificates are required, and/or non-default username/password is required - see this instruction.
npm run test:auth_example command from
either use pre-generated certificates provided in the examples/certs folder. Password for the files:
123456. Note, these certificates work for an Ignite server installed locally only.
or obtain other existing certificates applicable for a concrete Ignite server.
or generate new certificates applicable for a concrete Ignite server.
The following files are needed:
Place client.key, client.crt and ca.crt files somewhere locally, eg. into the examples/certs folder.
If needed, modify
TLS_CA_FILE_NAME constants in the example source file. The default values point to the files in the examples/certs folder.
Setup Ignite server to accept TLS - see appropriate Ignite documentation. Provide the obtained keystore.jks and truststore.jks certificates during the setup.
Switch on and setup authentication in Ignite server - see appropriate Ignite documentation.
If needed, modify
PASSWORD constants in the example source file. The default values are the default Ignite username/password.
Start three Ignite server nodes.
If needed, modify
ENDPOINT2 constants in an example source file - Ignite node endpoints. Default values are
Run an example by calling
Shut down the node the client is connected to (you can find it out from the client logs in the console).
From the logs, you will see that the client automatically reconnects to another node which is available.
Shut down all the nodes. You will see the client being stopped after failing to connect to each of the nodes.
It should be done if a public API class/method has been changed.
npm install -g jsdocto install jsdoc (https://www.npmjs.com/package/jsdoc)
jsdoc -c conf.json --readme index.mdcommand.
nodejs-thin-client/api_spec/conf.json is a file with jsdoc configuration.
For more information, see Ignite Node.js Thin Client documentation.