Nexus (NPM)

Teams using Sonatype Nexus can manage access to NES packages through 3 easy steps:

1. Create a Proxy Repository (NES Remote Repository) for our private NPM registry.
2. Configure the Proxy Repository with a Routing Rule
3. Configure a Group Repository to access both NES and OSS packages.

Step 1: Create a Proxy Repository

1. Navigate to Server Administration and Config > Repositories
   
2. Select Create Repository, then select NPM (proxy) as the recipe.
   
3. Provide the following configuration values on the Create Repository page. For configuration values not defined below, use the default value that Nexus provides.

   Name	npm-registry
   Remote Storage	https://registry.npmjs.org/
   Blob Store	provide the appropriate store for your environment

4. Create the repository.

Step 2: Create a Routing Rule

1. Navigate to Server Administration and Config > Routing Rules
2. Select Create Routing Rule
   
3. Provide the following configuration values on the Create Routing Rule page. For configuration values not defined below, use the default value that Nexus provides.

   Name	neverendingsupport
   Description	Route NES requests to HeroDevs registry
   Mode	Allow
   Matchers	^/@neverendingsupport/.*

4. Create the Routing Rule

Step 3: Create a NES Proxy Repository & Group Repository for your team

First, create a NES Proxy Repository which will handle only the NES packages requested.

1. Navigate to Server Administration and Config > Repositories
   
2. Select Create Repository, then select NPM (proxy) as the recipe.
   
3. Provide the following configuration values on the Create Repository page. For configuration values not defined below, use the default value that Nexus provides.

   Name	nes-registry
   Remote Storage	https://registry.nes.herodevs.com/npm/pkg
   Blob Store	provide the appropriate store for your environment
   Routing Rule	neverendingsupport (from Step 2)
   Authentication	checked
   Authentication Type	Preemptive Bearer Token
   Username	nexus
   Password	<NES_ACCESS_TOKEN>

4. Create the repository.

Next, create a Group Repository for your team so that they can access both NES and public packages from a single remote repository.

1. Navigate to Server Administration and Config > Repositories
   
2. Select Create Repository, but this time select NPM (group) as the recipe.
   
3. Provide the following configuration values on the Create Repository page. For configuration values not defined below, use the default value that Nexus provides.

   Name	npm-global
   Blob Store	provide the appropriate store for your environment
   Members	npm-registry, nes-registry

4. Create the repository.

Configuring your NPM client

Review the Nexus .npmrc documentation or npm client authentication documentation to setup your project or npm client accordingly. Nexus supports two authentication methods for the npm client:

1. Realm and Login
2. Basic Auth

Here is an example of what an .npmrc file should look like using the Realm and Login method:

registry=https://<NEXUS_DNS>/repository/npm-global/
email=<USER_EMAIL>
always-auth=true
_authToken=NpmToken.XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Here is an example of what an .npmrc file should look like using the Basic Auth method:

registry=https://<NEXUS_DNS>/repository/npm-global/
email=<USER_EMAIL>
always-auth=true
_auth=<BASE64_ENCODED_CREDENTIALS>

Replace each of the following placeholder values:

• NEXUS_DNS - The domain that the Nexus instance is reachable at.
• USER_EMAIL - The email address of the user authenticating against the Nexus repository.
• BASE64_ENCODED_CREDENTIALS - The base64 encoded username and password of the Nexus user. This is not provided by HeroDevs, and the string should be the base64 encoded value of “username:password”.