Skip to main content

Installation

The packages are published to the private @krakentech npm registry on registry.npmjs.org. Kraken provides an npm access token for your team.

1. Configure .npmrc​

Add the following to a project-level or user-level .npmrc:

@krakentech:registry=https://registry.npmjs.org/
//registry.npmjs.org/:_authToken=${NPM_TOKEN}

2. Set NPM_TOKEN​

Set NPM_TOKEN to the token Kraken provided — in your shell environment, CI secrets, or deployment platform.

warning

Never commit the token to source control. Reference it via an environment variable as shown above.

3. Install​

Install the core package:

npm install @krakentech/ink-live-chat-widget

For React, install both packages (the wrapper has a peer dependency on the core widget):

npm install @krakentech/ink-live-chat-widget @krakentech/ink-live-chat-widget-react

pnpm add and yarn add work the same way.

Peer dependencies (React wrapper)​

Peer dependencyVersion
react / react-dom18+
@krakentech/ink-live-chat-widgetMatches your installed widget version

Version pinning​

Pin both packages to known versions in your package.json, and re-test when you upgrade. If you self-host the script-tag build, pin the copied dist/ assets to the same version and redeploy on upgrade.

Both packages are licensed under ISC.

Next step​

Continue to the Quick Start for a minimal working integration.