Verdaccio

https://www.verdaccio.org/docs/
Admin
Verdaccio is a lightweight private npm proxy registry that allows you to cache npm packages and host...
Tokens:40,266
Snippets:560
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install NVM and Node.js

Source: https://www.verdaccio.org/docs/amazon

Commands to update the system, install NVM, and install Node.js.

```bash
sudo apt update
```

```bash
wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash
```

```bash
exit
```

```bash
nvm install node
```

--------------------------------

### Start Verdaccio Server

Source: https://www.verdaccio.org/docs/installation

Execute the CLI command to start the Verdaccio server.

```bash
$> verdaccio  

 info -=- local storage path /Users/user/.local/share/verdaccio/storage/.verdaccio-db.json  

 info --- using htpasswd file: /Users/user/.config/verdaccio/htpasswd  

 info --- http address http://localhost:4873/  

 info --- version: 6.0.0  

 info --- server started
```

--------------------------------

### Install UI Components

Source: https://www.verdaccio.org/docs/ui-components

Command to install the experimental UI components package as a development dependency.

```bash
npm i -D @verdaccio/ui-components@6-next
```

--------------------------------

### Configure Storage Plugins

Source: https://www.verdaccio.org/docs/plugins

Example configuration for storage plugins under the store namespace.

```yaml
store:  
  memory:  
    limit: 1000
```

--------------------------------

### Install Theme Plugin

Source: https://www.verdaccio.org/docs/plugin-theme

Command to install a custom theme plugin globally.

```bash
$> npm install --global verdaccio-theme-dark
```

--------------------------------

### Install Verdaccio Plugins

Source: https://www.verdaccio.org/docs/plugins

Commands to install plugins globally using npm.

```bash
$> npm install --global verdaccio-activedirectory
```

```bash
$> npm install --global sinopia-memory
```

--------------------------------

### Install Verdaccio dependencies

Source: https://www.verdaccio.org/docs/iss-server

Commands to navigate to the installation directory and install required packages.

```bash
cd c:\verdaccio  

npm install  
```

--------------------------------

### Configure Authentication Plugins

Source: https://www.verdaccio.org/docs/plugins

Examples for configuring htpasswd and Active Directory authentication.

```yaml
auth:  
  htpasswd:  
    file: ./htpasswd  
    # max_users: 1000
```

```yaml
auth:  
  activedirectory:  
    url: 'ldap://10.0.100.1'  
    baseDN: 'dc=sample,dc=local'  
    domainSuffix: 'sample.local'
```

```yaml
auth:  
  htpasswd:  
    file: ./htpasswd  
    #max_users: 1000  
  activedirectory:  
    url: 'ldap://10.0.100.1'  
    baseDN: 'dc=sample,dc=local'  
    domainSuffix: 'sample.local'
```

--------------------------------

### Configure VERDACCIO_PUBLIC_URL examples

Source: https://www.verdaccio.org/docs/env

Examples showing how VERDACCIO_PUBLIC_URL interacts with url_prefix to determine the final server URL.

```text
VERDACCIO_PUBLIC_URL='https://somedomain.org';  

url_prefix: '/my_prefix'  

  

// url -> https://somedomain.org/my_prefix/  

  

VERDACCIO_PUBLIC_URL='https://somedomain.org';  

url_prefix: '/'  

  

// url -> https://somedomain.org/  

  

VERDACCIO_PUBLIC_URL='https://somedomain.org/first_prefix';  

url_prefix: '/second_prefix'  

  

// url -> https://somedomain.org/second_prefix/'
```

--------------------------------

### Install Verdaccio and PM2

Source: https://www.verdaccio.org/docs/amazon

Global installation of Verdaccio and PM2 for process management.

```bash
npm i -g verdaccio pm2
```

--------------------------------

### Forbidden Access Error Example

Source: https://www.verdaccio.org/docs/packages

Console output when attempting to install a protected package without authorization.

```bash
$ npm install npmuser-core  

npm install npmuser-core  

npm ERR! code E403  

npm ERR! 403 Forbidden: npmuser-core@latest  

  

npm ERR! A complete log of this run can be found in:  

npm ERR!     /Users/user/.npm/_logs/2017-07-02T12_20_14_834Z-debug.log  
```

--------------------------------

### Install memory storage plugins

Source: https://www.verdaccio.org/docs/caching

Use these commands to install plugins that store data in memory instead of the hard drive.

```bash
  npm install -g verdaccio-auth-memory  

  npm install -g verdaccio-memory  


```

--------------------------------

### Programmatically starting a Verdaccio server

Source: https://www.verdaccio.org/docs/node-api

Initializes a Verdaccio server instance with a custom configuration object and starts the web server on a specified port.

```javascript
const startServer = require("verdaccio").default;  

  

let config = {  

    storage: "./storage",  

    auth: {  

        htpasswd: {  

            file: "./htpasswd"  

        }  

    },  

    uplinks: {  

        npmjs: {  

            url: "https://registry.npmjs.org/",  

        }  

    },  

    self_path: "./",  

    packages: {  

        "@*/*": {  

            access: "$all",  

            publish: "$authenticated",  

            proxy: "npmjs",  

        },  

        "**": {  

            proxy: "npmjs"  

        }  

    },  

    log: {  

            type: "stdout",  

            format: "pretty",  

            level: "http",  

        };  

};  

  

startServer(  

    config,  

    6000,  

    undefined,  

    "1.0.0",  

    "verdaccio",  

    (webServer, addrs) => {  

        webServer.listen(  

            addrs.port || addrs.path,  

            addrs.host,  

            () => {  

                console.log(`verdaccio running on : ${addrs.host}:${addrs.port}`);  

            }  

        );  

    }  

);  
```

--------------------------------

### startServer(config, port, path, version, name, callback)

Source: https://www.verdaccio.org/docs/node-api

Initializes and starts a Verdaccio server instance with a provided configuration object.

```APIDOC
## startServer

### Description
Starts the Verdaccio server programmatically using a configuration object and a callback function to handle the server instance.

### Parameters
- **config** (object) - Required - The configuration object containing storage, auth, uplinks, and package settings.
- **port** (number) - Required - The port number to listen on.
- **path** (string) - Optional - The path for the server.
- **version** (string) - Required - The version string of the server.
- **name** (string) - Required - The name of the server instance.
- **callback** (function) - Required - A function executed once the server is ready, receiving the webServer instance and address details.
```

--------------------------------

### Install Package via Registry

Source: https://www.verdaccio.org/docs/what-is-verdaccio

Install a specific package using a custom registry URL via the command line.

```bash
npm install lodash --registry http://localhost:4873
```

--------------------------------

### Install Experimental Verdaccio

Source: https://www.verdaccio.org/docs/staged-publishing

Commands to install the experimental version of Verdaccio for testing the staged publishing feature.

```bash
npm install -g verdaccio@next-9
```

```bash
docker pull verdaccio/verdaccio:nightly-master
```

--------------------------------

### Manage Verdaccio with PM2

Source: https://www.verdaccio.org/docs/amazon

Commands to start, list, and configure Verdaccio as a startup service.

```bash
pm2 start verdaccio
```

```bash
pm2 list
```

```bash
pm2 stop verdaccio
```

```bash
pm2 delete verdaccio
```

```bash
pm2 startup
```

```bash
which verdaccio
```

```bash
pm2 start /home/ubuntu/.nvm/versions/node/v17.1.0/bin/verdaccio
```

```bash
pm2 status
```

```bash
pm2 save
```

--------------------------------

### Execute Registry Commands

Source: https://www.verdaccio.org/docs/setup-yarn

Examples of using the added registry commands with various flags and arguments.

```bash
yarn npm ping --registry http://localhost:4873  

yarn npm unpublish my-package@1.0.0  

yarn npm unpublish my-package --force            # every version  

yarn npm deprecate my-package@"<2.0.0" "Upgrade to v2"  

yarn npm deprecate my-package@1.0.0 ""           # un-deprecate  

yarn npm star lodash  
```

--------------------------------

### Example UI Options Configuration

Source: https://www.verdaccio.org/docs/plugin-theme

The shape of the window.__VERDACCIO_BASENAME_UI_OPTIONS object used for client-side configuration.

```json
{
    "darkMode": false,
    "basename": "/",
    "base": "https://registry.my.org/",
    "primaryColor": "#4b5e40",
    "version": "5.20.1",
    "pkgManagers": [
        "yarn",
        "pnpm",
        "npm"
    ],
    "login": true,
    "logo": "",
    "title": "Verdaccio Registry",
    "scope": "",
    "language": "es-US"
}
```

--------------------------------

### Start Verdaccio with Custom Configuration

Source: https://www.verdaccio.org/docs/cli

Launch the Verdaccio server on a specific port using a custom configuration file path.

```bash
verdaccio --listen 4000 --config ~./config.yaml
```

--------------------------------

### Configure Theme Plugins

Source: https://www.verdaccio.org/docs/plugins

Installation and configuration for theme plugins.

```bash
npm install --global verdaccio-theme-dark
```

```yaml
theme:  
  dark:  
    option1: foo  
    option2: bar
```

--------------------------------

### Configure Middleware Plugins

Source: https://www.verdaccio.org/docs/plugins

Example configuration for middleware plugins under the middlewares namespace.

```yaml
middlewares:  
  audit:  
    enabled: true
```

--------------------------------

### Install package with min-release-age

Source: https://www.verdaccio.org/docs/staged-publishing

Command to install a package while bypassing the min-release-age restriction.

```bash
npm install my-package --min-release-age=0
```

--------------------------------

### Locate binary paths

Source: https://www.verdaccio.org/docs/server-configuration

Identify the installation paths for forever and verdaccio binaries.

```bash
$ which forever

$ which verdaccio
```

--------------------------------

### Run Verdaccio with Docker

Source: https://www.verdaccio.org/docs/installation

Start a Verdaccio instance using the official Docker image.

```bash
docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio
```

--------------------------------

### Install Verdaccio Globally

Source: https://www.verdaccio.org/docs/installation

Install the Verdaccio CLI globally using common Node.js package managers.

```bash
npm install -g verdaccio
```

```bash
yarn global add verdaccio
```

```bash
pnpm install -g verdaccio
```

--------------------------------

### Handle unauthorized package installation

Source: https://www.verdaccio.org/docs/protect-your-dependencies

Expected error output when an unauthorized user attempts to install a protected package.

```bash
➜ npm install my-company-core  

npm ERR! code E403  

npm ERR! 403 Forbidden: webpack-1@latest  
```

```bash
➜ yarn add my-company-core  

yarn add v0.24.6  

info No lockfile found.  

[1/4] 🔍  Resolving packages...  

error An unexpected error occurred: "http://localhost:5555/webpack-1: unregistered users are not allowed to access package my-company-core".  
```

--------------------------------

### Install experimental Verdaccio versions

Source: https://www.verdaccio.org/docs/two-factor-authentication

Commands to install or pull the experimental 9.x release of Verdaccio for testing the TFA feature.

```bash
npm install -g verdaccio@next-9  

# or  

docker pull verdaccio/verdaccio:nightly-master  
```

--------------------------------

### Install Yeoman CLI

Source: https://www.verdaccio.org/docs/plugin-generator

Install the Yeoman command-line tool globally to enable the use of custom generators.

```bash
npm install -g yo
```

--------------------------------

### Authenticated Group List Example

Source: https://www.verdaccio.org/docs/packages

Example of group list when a user is logged in as 'npmUser'.

```text
// groups without '$' are going to be deprecated eventually  

('$all', '$anonymous', '@all', '@anonymous', 'all', 'undefined', 'anonymous', 'npmUser');  
```

--------------------------------

### Configure Scoped Plugins

Source: https://www.verdaccio.org/docs/plugins

Example configuration for scoped plugins in config.yaml.

```yaml
auth:  
  '@my-org/auth-awesome-plugin':  
    foo: some value  
    bar: another value  
store:  
  '@my-org/store-awesome-plugin':  
    foo: some value  
    bar: another value  
middleware:  
  '@my-org/middleware-awesome-plugin':  
    foo: some value  
    bar: another value
```

--------------------------------

### Custom Package Usage Configuration

Source: https://www.verdaccio.org/docs/packages

Example configuration for scoped packages and private package patterns.

```yaml
packages:  

  # scoped packages  

  '@scope/*':  

    access: $all  

    publish: $all  

    proxy: server2  

  

  'private-*':  

    access: $all  

    publish: $all  

    proxy: uplink1  

  

  '**':  

    # allow all users (including non-authenticated users) to read and  

    # publish all packages  

    access: $all  

    publish: $all  

    proxy: uplink2  
```

--------------------------------

### Install and run forever

Source: https://www.verdaccio.org/docs/server-configuration

Use the forever package to keep the Verdaccio process running in the background.

```bash
$ sudo npm install -g forever
```

```bash
$ forever start `which verdaccio`
```

--------------------------------

### Install Verdaccio Plugin Generator

Source: https://www.verdaccio.org/docs/plugin-generator

Install the specific Verdaccio plugin generator package globally via npm.

```bash
npm install -g generator-verdaccio-plugin
```

--------------------------------

### Theme Configuration in Verdaccio

Source: https://www.verdaccio.org/docs/plugin-theme

Example of how to pass options to a theme plugin within the Verdaccio configuration file.

```yaml
theme:
  dark:
    option1: foo
    option2: bar
```

--------------------------------

### Verdaccio Storage Configuration

Source: https://www.verdaccio.org/docs/kubernetes

Example configuration snippet for defining storage paths in Verdaccio.

```yaml
storage: /verdaccio/storage/data

auth:

  htpasswd:

    file: /verdaccio/storage/htpasswd
```

--------------------------------

### Interactive npm publish with 2FA

Source: https://www.verdaccio.org/docs/two-factor-authentication

Example of the terminal prompt encountered when publishing with 2FA enabled in an interactive shell.

```bash
npm publish  

# This operation requires a one-time password.  

# Enter OTP:  
```

--------------------------------

### runServer(config)

Source: https://www.verdaccio.org/docs/verdaccio-programmatically

Starts the Verdaccio server programmatically. It accepts no arguments (default config), a path to a YAML configuration file, or a configuration object.

```APIDOC
## runServer(config)

### Description
Starts the Verdaccio server instance. This is the recommended method for programmatic usage.

### Parameters
- **config** (string|object) - Optional - Either the absolute path to a config.yaml file or a configuration object.

### Returns
- **Promise<app>** - A promise that resolves to the server application instance.
```

--------------------------------

### Deploy Verdaccio with Helm

Source: https://www.verdaccio.org/docs/installation

Install Verdaccio on a Kubernetes cluster using the official Helm chart.

```bash
$ helm repo add verdaccio https://charts.verdaccio.org  

$ helm repo update  

$ helm install registry --set image.tag=6 verdaccio/verdaccio
```

--------------------------------

### Install Yarn Registry Plugins

Source: https://www.verdaccio.org/docs/setup-yarn

Use the importer to download and register specific registry plugins in your .yarnrc.yml file.

```bash
yarn dlx @verdaccio/yarn-import npm-ping  

yarn dlx @verdaccio/yarn-import npm-login  

yarn dlx @verdaccio/yarn-import npm-unpublish  

yarn dlx @verdaccio/yarn-import npm-deprecate  

yarn dlx @verdaccio/yarn-import npm-star  
```

--------------------------------

### Handlebars Template Format Examples

Source: https://www.verdaccio.org/docs/notifications

Basic syntax for iterating through package versions and accessing publisher information in notification templates.

```handlebars
# iterate all versions  

{{ name }}{{#each versions}} v{{version}}{{/each}}  

  

# publisher and `dist-tag` package published  

{{ publisher.name }} has published {{ publishedPackage }}  
```

--------------------------------

### Configure Web Interface Settings

Source: https://www.verdaccio.org/docs/webui

Example configuration block for the Verdaccio web interface, including branding, script injection, and feature toggles.

```yaml
web:  

  enable: true  

  title: Verdaccio  

  logo: http://somedomain/somelogo.png  

  primary_color: '#4b5e40'  

  gravatar: true | false  

  scope: '@scope'  

  sort_packages: asc | desc  

  darkMode: false  

  favicon: http://somedomain/favicon.ico | /path/favicon.ico  

  rateLimit:  

    windowMs: 50000  

    max: 1000  

  pkgManagers:  

    - npm  

    - yarn  

    - pnpm  

  login: true  

  scriptsBodyAfter:  

    - '<script type="text/javascript" src="https://my.company.com/customJS.min.js"></script>'  

  metaScripts:  

    - '<script type="text/javascript" src="https://code.jquery.com/jquery-3.5.1.slim.min.js"></script>'  

    - '<script type="text/javascript" src="https://browser.sentry-cdn.com/5.15.5/bundle.min.js"></script>'  

    - '<meta name="robots" content="noindex" />'  

  scriptsbodyBefore:  

    - '<div id="myId">html before webpack scripts</div>'  

  html_cache: true  

  showInfo: true  

  showSettings: true  

  # In combination with darkMode you can force specific theme  

  showThemeSwitch: true  

  showFooter: true  

  showSearch: true  

  showDownloadTarball: true  

  showRaw: true
```

--------------------------------

### Set URL Prefix

Source: https://www.verdaccio.org/docs/configuration

Configure a URL prefix for reverse proxy setups.

```yaml
url_prefix: /verdaccio/  


```

--------------------------------

### Configure Secret Environment Variables

Source: https://www.verdaccio.org/docs/kubernetes

Example values.yaml configuration for injecting sensitive environment variables.

```yaml
# values.yaml

secretEnvVars:

  FOO_TOKEN: superSecretBarToken
```

--------------------------------

### Run Verdaccio using runServer API

Source: https://www.verdaccio.org/docs/verdaccio-programmatically

The recommended way to start Verdaccio programmatically. Supports default configuration, file paths, or configuration objects.

```javascript
const { runServer } = require('verdaccio');  

const app = await runServer(); // default configuration  

const app = await runServer('./config/config.yaml');  

const app = await runServer({ configuration });  

app.listen(4000, (event) => {  

  // do something  

});  
```

--------------------------------

### Configure anonymous package access

Source: https://www.verdaccio.org/docs/authentication

Example configuration for allowing anonymous access and publishing for specific package patterns.

```yaml
'my-company-*':

  access: $anonymous

  publish: $anonymous

  proxy: npmjs
```

--------------------------------

### Build a custom Verdaccio image with plugins

Source: https://www.verdaccio.org/docs/docker

Uses a multi-stage build to install plugins and copy them into the final Verdaccio image.

```dockerfile
FROM node:lts-alpine as builder  

RUN mkdir -p /verdaccio/plugins  

  && cd /verdaccio/plugins  

  && npm install --install-strategy=shallow --no-bin-links --omit=optional verdaccio-auth-memory@latest  

FROM verdaccio/verdaccio:6  

ADD docker.yaml /verdaccio/conf/config.yaml  

COPY --chown=$VERDACCIO_USER_UID:root --from=builder  

  /verdaccio/plugins/node_modules/verdaccio-auth-memory  

  /verdaccio/plugins/verdaccio-auth-memory  
```

--------------------------------

### Configure crontab for reboots

Source: https://www.verdaccio.org/docs/server-configuration

Schedule Verdaccio to start automatically upon server reboot.

```bash
$ crontab -e
```

```bash
@reboot /usr/bin/forever start /usr/lib/node_modules/verdaccio/bin/verdaccio
```

--------------------------------

### SELinux Configuration Errors

Source: https://www.verdaccio.org/docs/docker

Example error message and audit log entry indicating SELinux access denial.

```text
fatal--- cannot open config file /verdaccio/conf/config.yaml: Error: CONFIG: it does not look like a valid config file
```

```text
type=AVC msg=audit(1606833420.789:9331): avc:  denied  { read } for  pid=1251782 comm="node" name="config.yaml" dev="dm-2" ino=8178250 scontext=system_u:system_r:container_t:s0:c32,c258 tcontext=unconfined_u:object_r:user_home_t:s0 tclass=file permissive=0
```

--------------------------------

### Configure memory storage

Source: https://www.verdaccio.org/docs/caching

Example configuration for using memory-based authentication and storage. Note that data is lost upon server restart.

```yaml
auth:  

  auth-memory:  

    users:  

      foo:  

        name: test  

        password: test  

store:  

  memory:  

    limit: 1000  


```

--------------------------------

### Webhook Notification Configuration

Source: https://www.verdaccio.org/docs/notifications

Example configuration for a POST webhook notification using template variables.

```yaml
notify:  

  method: POST  

  headers: [{'Content-Type': 'application/json'}]  

  endpoint: https://usagge.hipchat.com/v2/room/3729485/notification?auth_token=mySecretToken  

  content: '{"color":"green","message":"New package published: * {{ name }}*. Publisher name: * {{ publisher.name }} *.","notify":true,"message_format":"text"}'  
```

--------------------------------

### Define start.js

Source: https://www.verdaccio.org/docs/iss-server

Entry point scripts for launching the Verdaccio application.

```javascript
process.argv.push('-l', 'unix:' + process.env.PORT, '-c', './config.yaml');

require('./node_modules/verdaccio/build/lib/cli.js');
```

```javascript
process.argv.push('-l', 'unix:' + process.env.PORT);

require('./node_modules/verdaccio/src/lib/cli.js');
```

--------------------------------

### Bash Script for Verdaccio E2E Testing

Source: https://www.verdaccio.org/docs/e2e

A script to start a local Verdaccio instance, authenticate, and publish a package for testing purposes.

```bash
#!/bin/sh  
  
  
set -e  
  
  
local_registry="http://0.0.0.0:4873"  
  
  
# start local registry  
  
tmp_registry_log=`mktemp`  
  
sh -c "mkdir -p $HOME/.config/verdaccio"  
  
sh -c "cp --verbose /config.yaml $HOME/.config/verdaccio/config.yaml"  
  
sh -c "nohup verdaccio --config $HOME/.config/verdaccio/config.yaml &>$tmp_registry_log &"  
  
# wait for `verdaccio` to boot  
  
grep -q 'http address' <(tail -f $tmp_registry_log)  
  
# login so we can publish packages  
  
sh -c "npm-auth-to-token -u test -p test -e test@test.com -r $local_registry"  
  
# Run nmp command  
  
sh -c "npm --registry $local_registry publish"  


```

--------------------------------

### Build Verdaccio Docker Image

Source: https://www.verdaccio.org/docs/docker

Builds the Docker image using the local Dockerfile. Requires Docker to be installed and available in the system PATH.

```bash
docker build -t verdaccio .
```

--------------------------------

### Implement Custom UI with Components

Source: https://www.verdaccio.org/docs/ui-components

Example showing the integration of Verdaccio UI components, providers, and routing within a React application.

```typescript
import React from 'react';  

import { Route, Router, Switch } from 'react-router-dom';  

import { Provider } from 'react-redux';  

import {  

  Home,  

  store,  

  Loading,  

  NotFound,  

  Route as Routes,  

  TranslatorProvider,  

  VersionProvider,  

  loadable,  

} from '@verdaccio/ui-components';  

  

// to enable webpack code splitting  

const VersionPage = loadable(() => import('../pages/Version'));  

  

const App: React.FC = () => {  

  // configuration from config.yaml  

  const { configOptions } = useConfig();  

  const listLanguages = [{lng: 'en-US', icon: <someSVGIcon>, menuKey: 'lng.english'}];  

  return (  

      <Provider store={store}>  

        <AppConfigurationProvider>  

          <ThemeProvider>  

            <TranslatorProvider i18n={i18n} listLanguages={listLanguages} onMount={() => {}}>  

              <Suspense fallback={<Loading />}>  

                <Router history={history}>  

                  <Header HeaderInfoDialog={CustomInfoDialog} />  

                    <Switch>  

                      <Route exact={true} path={Routes.ROOT}>  

                        <Home />  

                      </Route>  

                      <Route exact={true} path={Routes.SCOPE_PACKAGE}>  

                        <VersionProvider>  

                          <VersionPage />  

                        </VersionProvider>  

                      </Route>  

                    </Switch>  

                </Router>  

                {configOptions.showFooter && <Footer />}  

              </Suspense>  

            </TranslatorProvider>  

          </ThemeProvider>  

        </AppConfigurationProvider>  

      </Provider>  

  );  

};
```

--------------------------------

### Build Docker Image via Package Manager

Source: https://www.verdaccio.org/docs/docker

Alternative method to build the Docker image using configured npm scripts. Ensure dependencies are installed via yarn or pnpm before running.

```bash
yarn (or pnpm) run build:docker
```

--------------------------------

### Example of npm v7+ lockfile with mixed registries

Source: https://www.verdaccio.org/docs/setup-npm

This JSON structure illustrates a lockfile containing dependencies resolved from both the public npm registry and a local Verdaccio instance.

```json
{
  "name": "npm7",
  "version": "1.0.0",
  "lockfileVersion": 2,
  "requires": true,
  "packages": {
    "": {
      "version": "1.0.0",
      "license": "ISC",
      "dependencies": {
        "lodash": "4.17.20",
        "underscore": "^1.11.0"
      }
    },
    ..... // removed for simplicity
  },
  "dependencies": {
    "lodash": {
      "version": "4.17.20",
      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.20.tgz",
      "integrity": "sha512-PlhdFcillOINfeV7Ni6oF1TAEayyZBoZ8bcshTHqOYJYlrqzRK5hagpagky5o4HfCzzd1TRkXPMFq6cKk9rGmA=="
    },
    "underscore": {
      "version": "1.11.0",
      "resolved": "http://localhost:4873/underscore/-/underscore-1.11.0.tgz",
      "integrity": "sha512-xY96SsN3NA461qIRKZ/+qox37YXPtSBswMGfiNptr+wrt6ds4HaMw23TP612fEyGekRE6LNRiLYr/aqbHXNedw=="
    }
  }
}
```

--------------------------------

### Enroll in 2FA via NPM

Source: https://www.verdaccio.org/docs/two-factor-authentication

Use the npm CLI to initiate the 2FA enrollment process for your account.

```bash
npm profile enable-2fa auth-and-writes  
```

--------------------------------

### Using verdaccio-server implementation

Source: https://www.verdaccio.org/docs/node-api

Demonstrates methods for managing a Verdaccio server instance and handling Windows services.

```javascript
// js  

import * as verdaccioServer from 'verdaccio-server';  

  

verdaccioServer.start();  

verdaccioServer.stop();  

verdaccioServer.list();  

verdaccioServer.stopAll();  

verdaccioServer.show();  

verdaccioServer.cli();  

// windows .net2  

verdaccioServer.serviceInstall();  

verdaccioServer.serviceUninstall();  

verdaccioServer.serviceStart();  

verdaccioServer.serviceStop();  

verdaccioServer.serviceRestart();  
```

--------------------------------

### Initialize Verdaccio Configuration

Source: https://www.verdaccio.org/docs/amazon

Run Verdaccio once to generate the default configuration file.

```bash
verdaccio
```

--------------------------------

### Configure project registry in bunfig.toml

Source: https://www.verdaccio.org/docs/setup-bun

Create a bunfig.toml file in the project root to point Bun to a local registry.

```toml
[install]  

registry = "http://localhost:4873"  

  
```

--------------------------------

### Register and Login to Registry

Source: https://www.verdaccio.org/docs/amazon

Commands to create a user and authenticate with the private registry.

```bash
npm adduser
```

```bash
npm set registry http://your-ec2-public-ip-address:4873
```

```bash
npm login
```

--------------------------------

### Verify the generated package configuration

Source: https://www.verdaccio.org/docs/plugin-auth

Navigate to the newly created directory and inspect the package.json file to confirm the project details.

```bash
➜ cd verdaccio-plugin-service-name  

➜ cat package.json  

  

  {  

  "name": "verdaccio-plugin-service-name",  

  "version": "0.0.1",  

  "description": "awesome auth plugin",  

  ...  
```

--------------------------------

### Theme Plugin Main Entry Point

Source: https://www.verdaccio.org/docs/plugin-theme

The index.js file must export a function returning the static path, manifest, and manifest files.

```javascript
module.exports = () => {
  return {
    // location of the static files, webpack output
    staticPath: path.join(__dirname, 'static'),
    // webpack manifest json file
    manifest: require('./static/manifest.json'),
    // main manifest files to be loaded
    manifestFiles: {
      js: ['runtime.js', 'vendors.js', 'main.js'],
    },
  };
};
```

--------------------------------

### Verdaccio Sub-directory Configuration

Source: https://www.verdaccio.org/docs/reverse-proxy

Defines the url_prefix in the Verdaccio configuration file for sub-directory installations.

```yaml
url_prefix: /sub_directory/  
```

--------------------------------

### Configure Deno registry for a project

Source: https://www.verdaccio.org/docs/setup-deno

Create a .npmrc file in your project root to point Deno to the local Verdaccio registry.

```text
registry=http://localhost:4873  
```

--------------------------------

### Staged Publishing Workflow Overview

Source: https://www.verdaccio.org/docs/staged-publishing

A visual representation of the command flow for managing staged packages.

```text
npm stage publish        the version is uploaded but not installable  

npm stage list           maintainers see what is waiting  

npm stage view <id>      inspect the metadata  

npm stage download <id>  inspect the actual tarball  

        │  

        ├── npm stage approve <id>   published for real, installable now  

        └── npm stage reject <id>    record and tarball deleted, never existed  
```

--------------------------------

### Troubleshoot Invalid Checksum Errors

Source: https://www.verdaccio.org/docs/reverse-proxy

Identify and resolve gzip-related checksum failures during npm install.

```text
npm WARN tar TAR_ENTRY_INVALID checksum failure  

npm WARN tar zlib: incorrect data check
```

--------------------------------

### Run Verdaccio with volume mapping

Source: https://www.verdaccio.org/docs/docker

Mounts local directories for configuration, storage, and plugins to the container.

```bash
V_PATH=/path/for/verdaccio; docker run -it --rm --name verdaccio  

  -p 4873:4873  

  -v $V_PATH/conf:/verdaccio/conf  

  -v $V_PATH/storage:/verdaccio/storage  

  -v $V_PATH/plugins:/verdaccio/plugins  

  verdaccio/verdaccio  
```

--------------------------------

### Publish Packages

Source: https://www.verdaccio.org/docs/amazon

Commands to navigate to the package directory and publish to the registry.

```bash
cd [custom library package path]
```

```bash
[custom library package path] >> npm publish your-library-name-0.0.1.tgz
```

```bash
[custom library package path] >> npm publish
```

```bash
[custom library package path] >> npm publish --registry http://your-ec2-public-ip-address:4873
```

--------------------------------

### Webpack Manifest Plugin Configuration

Source: https://www.verdaccio.org/docs/plugin-theme

Example configuration for generating the required manifest using WebpackManifestPlugin.

```javascript
const { WebpackManifestPlugin } = require('webpack-manifest-plugin');

  plugins: [
    ...
    new WebpackManifestPlugin({
      // this is optional depends of your implementation
      removeKeyHash: true,
    }),
    ...
  ],
```

--------------------------------

### Stage a Package Version

Source: https://www.verdaccio.org/docs/staged-publishing

Commands to stage a package and the resulting output confirming the staging action.

```bash
npm stage publish  
```

```bash
npm notice Staging to http://localhost:4873/ with tag latest and default access  

+ my-package@1.0.0 (staged with id 9efe8b0c-50b3-4183-ba3f-c46dfc784adb)  
```

--------------------------------

### Access the generated plugin package

Source: https://www.verdaccio.org/docs/plugin-middleware

Navigate to the generated directory and inspect the package.json file.

```bash
➜ cd verdaccio-plugin-auth-service-name
➜ cat package.json

  {
  "name": "verdaccio-plugin-custom-endpoint",
  "version": "0.0.1",
  "description": "awesome middleware plugin",
  ...
```

--------------------------------

### Set VERDACCIO_FORWARDED_PROTO

Source: https://www.verdaccio.org/docs/env

Example of overriding the default protocol header for environments using non-standard headers.

```bash
$ VERDACCIO_FORWARDED_PROTO=CloudFront-Forwarded-Proto verdaccio --listen 5000
```

--------------------------------

### Configure runServer with object

Source: https://www.verdaccio.org/docs/verdaccio-programmatically

Demonstrates manually setting self_path when passing a configuration object to runServer.

```javascript
const { runServer, parseConfigFile } = require('verdaccio');  

const configPath = join(__dirname, './config.yaml');  

const c = parseConfigFile(configPath);  

// workaround  

// self_path still exists in 6.x; it was removed in 7.x  

c.self_path = 'foo';  

runServer(c).then(() => {});  
```

--------------------------------

### AWS CodeArtifact Uplink Configuration

Source: https://www.verdaccio.org/docs/uplinks

Example configuration for connecting to AWS CodeArtifact with custom headers and authentication.

```yaml
uplinks:  

  aws-codeArtifact:  

    url: https://private-registry.domain.com/registry  

    cache: false  

    auth:  

      type: bearer  

      token_env: CODEARTIFACT_AUTH_TOKEN  

    strict_ssl: false  

    headers:  

      'Accept': '*/*'  

      'Accept-Encoding': 'gzip, deflate, br'  

      'Cache-Control': 'no-cache'  
```

--------------------------------

### Enable User Registration

Source: https://www.verdaccio.org/docs/user-registration

Set the createUser flag to true in the configuration file to enable the sign-up form in the web UI.

```yaml
flags:  

  createUser: true  
```

--------------------------------

### Publish Type Webhook Payload

Source: https://www.verdaccio.org/docs/notifications

Example of including the publishType event in a webhook payload for routing purposes.

```yaml
notify:  

  method: POST  

  endpoint: https://hooks.example.org/registry  

  content: '{"type":"{{ publishType }}","package":"{{ publishedPackage }}","by":"{{ publisher.name }}"}'  
```

--------------------------------

### Configure NGINX Ingress Body Size

Source: https://www.verdaccio.org/docs/kubernetes

Example annotation configuration to increase the NGINX proxy body-size limit.

```yaml
...

  

annotations:

...

  

    kubernetes.io/proxy-body-size: 20m

....

...
```

--------------------------------

### Download Default Configuration

Source: https://www.verdaccio.org/docs/kubernetes

Downloads the default Docker configuration file for customization.

```bash
wget https://raw.githubusercontent.com/verdaccio/verdaccio/master/packages/config/src/conf/docker.yaml -O config.yaml
```

--------------------------------

### Using recovery codes for npm publish

Source: https://www.verdaccio.org/docs/two-factor-authentication

Demonstrates using a recovery code in place of a standard one-time password.

```bash
npm publish --otp=d9723b8e995d164a  
```

--------------------------------

### Configure Registry

Source: https://www.verdaccio.org/docs/installation

Methods to point your package manager to the local Verdaccio registry.

```bash
npm set registry http://localhost:4873/
```

```bash
npm install --registry http://localhost:4873
```

```text
registry=http://localhost:4873
```

```json
{

  "publishConfig": {

    "registry": "http://localhost:4873"

  }

}
```

--------------------------------

### adduser(user, password, callback)

Source: https://www.verdaccio.org/docs/plugin-auth

Handles user creation. The callback should be invoked with (null, true) for success or an error object for failure.

```APIDOC
## adduser(user, password, callback)

### Description
Attempts to create a new user. Returns true on success or an error object if the operation fails.
```

--------------------------------

### Configure staged publishing for release review

Source: https://www.verdaccio.org/docs/best

Requires Verdaccio 7.x or later. Allows users to propose releases that require approval from a maintainer before becoming installable.

```yaml
flags:  

  stage: true  

  

packages:  

  '@my-company/*':  

    access: $authenticated  

    stage: developers  

    publish: release-managers  
```

--------------------------------

### Log in to Verdaccio via npm

Source: https://www.verdaccio.org/docs/authentication

Use the npm CLI to authenticate against a specific Verdaccio registry instance.

```bash
npm adduser --registry http://localhost:4873
```

--------------------------------

### Define package.json

Source: https://www.verdaccio.org/docs/iss-server

Configuration file defining the project dependencies for hosting Verdaccio in iisnode.

```json
{

  "name": "iisnode-verdaccio",

  "version": "1.0.0",

  "description": "Hosts verdaccio in iisnode",

  "main": "start.js",

  "dependencies": {

    "verdaccio": "^3.11.0"

  }

}
```

--------------------------------

### Initialize Helm Tiller

Source: https://www.verdaccio.org/docs/kubernetes

Initializes the Helm controller required for managing packages.

```bash
helm init
```

--------------------------------

### Running Verdaccio with Bind Mounts

Source: https://www.verdaccio.org/docs/docker

Command to run Verdaccio while mounting local directories for configuration, storage, and plugins.

```bash
V_PATH=/path/for/verdaccio; docker run -it --rm --name verdaccio \
  -p 4873:4873 \
  -v $V_PATH/conf:/verdaccio/conf \
  -v $V_PATH/storage:/verdaccio/storage \
  -v $V_PATH/plugins:/verdaccio/plugins \
  verdaccio/verdaccio
```

--------------------------------

### Create Kubernetes ConfigMap

Source: https://www.verdaccio.org/docs/kubernetes

Creates a ConfigMap from the local configuration file for use in the cluster.

```bash
kubectl create configmap verdaccio-config --from-file ./config.yaml
```

--------------------------------

### Configure systemd service

Source: https://www.verdaccio.org/docs/server-configuration

Copy the systemd unit file and reload the daemon to manage Verdaccio as a system service.

```bash
$ sudo cp /usr/lib/node_modules/verdaccio/systemd/verdaccio.service /lib/systemd/system/ && sudo systemctl daemon-reload
```

--------------------------------

### Configure Authentication Settings

Source: https://www.verdaccio.org/docs/configuration

Sets up htpasswd authentication with a defined user limit.

```yaml
auth:  

  htpasswd:  

    file: ./htpasswd  

    max_users: 1000  
```

--------------------------------

### Generate Plugin with Yeoman

Source: https://www.verdaccio.org/docs/plugin-storage

Use the yo command to scaffold a new Verdaccio storage plugin project.

```bash
➜ yo verdaccio-plugin  

  

Just found a `.yo-rc.json` in a parent directory.  

Setting the project root at: /Users/user/verdaccio_yo_generator  

  

     _-----_     ╭──────────────────────────╮  

    |       |    │        Welcome to        │  

    |--(o)--|    │ generator-verdaccio-plug │  

   `---------´   │   in plugin generator!   │  

    ( _´U`_ )    ╰──────────────────────────╯  

    /___A___\   /  

     |  ~  |  

   __'.___.'__  

 ´   `  |° ´ Y `  

  

? What is the name of your plugin? custom-endpoint  

? Select Language typescript  

? What kind of plugin you want to create? storage  

? Please, describe your plugin awesome storage plugin  

? GitHub username or organization myusername  

? Author's Name Juan Picado  

? Author's Email jotadeveloper@gmail.com  

? Key your keywords (comma to split) verdaccio,plugin,storage,awesome,verdaccio-plugin  

   create verdaccio-plugin-storage-package-database/package.json  

   create verdaccio-plugin-storage-package-database/.gitignore  

   create verdaccio-plugin-storage-package-database/.npmignore  

   create verdaccio-plugin-storage-package-database/jest.config.js  

   create verdaccio-plugin-storage-package-database/.babelrc  

   create verdaccio-plugin-storage-package-database/.travis.yml  

   create verdaccio-plugin-storage-package-database/README.md  

   create verdaccio-plugin-storage-package-database/.eslintrc  

   create verdaccio-plugin-storage-package-database/.eslintignore  

   create verdaccio-plugin-storage-package-database/src/PackageStorage.ts  

   create verdaccio-plugin-storage-package-database/src/index.ts  

   create verdaccio-plugin-storage-package-database/src/plugin.ts  

   create verdaccio-plugin-storage-package-database/index.ts  

   create verdaccio-plugin-storage-package-database/tsconfig.json  

   create verdaccio-plugin-storage-package-database/types/index.ts  

   create verdaccio-plugin-storage-package-database/.editorconfig  

  

I'm all done. Running npm install for you to install the required dependencies. If this fails, try running the command yourself.  

  

⸨ ░░░░░░░░░░░░░░░░░⸩ ⠋ fetchMetadata: sill pacote range manifest for @babel/plugin-syntax-jsx@^7.7.4 fetc  
```

--------------------------------

### Protecting Packages with Regex

Source: https://www.verdaccio.org/docs/packages

Configuration to protect packages matching a specific prefix.

```yaml
packages:  

  'npmuser-*':  

    access: npmuser  

    publish: npmuser  
```

--------------------------------

### Login to Self-Hosted Registry

Source: https://www.verdaccio.org/docs/setup-yarn

Use the legacy authentication flow for self-hosted registries like Verdaccio.

```bash
yarn npm login --auth-type=legacy --registry http://localhost:4873  
```

```bash
yarn npm login --auth-type=legacy \
  --user "$NPM_USER" --password "$NPM_PASS" --email "$NPM_EMAIL"  
```

--------------------------------

### Inspect Deno cache locations

Source: https://www.verdaccio.org/docs/setup-deno

Use the info command to locate the Deno cache directories on your system.

```bash
> deno info  

  

DENO_DIR location: /Users/user/Library/Caches/deno  

  

Remote modules cache: /Users/user/Library/Caches/deno/deps  

  

npm modules cache: /Users/user/Library/Caches/deno/npm  

  

Emitted modules cache: /Users/user/Library/Caches/deno/gen  

  

Language server registries cache: /Users/user/Library/Caches/deno/registries  

  

Origin storage: /Users/user/Library/Caches/deno/location_data  
```

--------------------------------

### Configure Apache with SSL

Source: https://www.verdaccio.org/docs/reverse-proxy

Secure the Verdaccio proxy using SSL certificates and pass the protocol header.

```apache
<IfModule mod_ssl.c>  

    <VirtualHost *:443>  

        ServerName npm.your.domain.com  

        SSLEngine on  

        SSLCertificateFile      /etc/letsencrypt/live/npm.your.domain.com/fullchain.pem  

        SSLCertificateKeyFile   /etc/letsencrypt/live/npm.your.domain.com/privkey.pem  

        SSLProxyEngine          On  

        ProxyRequests           Off  

        ProxyPreserveHost       On  

        AllowEncodedSlashes     NoDecode  

        LimitRequestBody        0  

        ProxyPass               /       http://127.0.0.1:4873/ nocanon  

        ProxyPassReverse        /       http://127.0.0.1:4873/  

        RequestHeader set       X-Forwarded-Proto "https"  

    </VirtualHost>  

    </IfModule>
```

--------------------------------

### Yarn interactive publish with 2FA

Source: https://www.verdaccio.org/docs/two-factor-authentication

The prompt behavior when publishing packages using Yarn with 2FA enabled.

```bash
yarn npm publish  

# Provide a one-time password from your authenticator app.  

# One-time password: ‹  
```

--------------------------------

### Configure package proxy settings

Source: https://www.verdaccio.org/docs/best

Shows the default proxy configuration versus a hardened configuration that removes the proxy for specific private scopes to prevent unnecessary external registry lookups.

```yaml
packages:  

  '@*/*':  

    access: $authenticated  

    publish: $authenticated  

    proxy: npmjs  

  '**':  

    access: $authenticated  

    publish: $authenticated  

    proxy: npmjs  
```

```yaml
packages:  

  '@my-company/*':  

    access: $authenticated  

    publish: $authenticated  

    unpublish: $authenticated  

  '@*/*':  

    access: $authenticated  

    publish: $authenticated  

    proxy: npmjs  

  '**':  

    access: $authenticated  

    publish: $authenticated  

    proxy: npmjs  
```

--------------------------------

### Configure Apache VirtualHost for Relative Path

Source: https://www.verdaccio.org/docs/reverse-proxy

Set up a reverse proxy for Verdaccio hosted at a sub-path like /npm.

```apache
<VirtualHost *:80>  

  AllowEncodedSlashes NoDecode  

  ProxyPass /npm http://127.0.0.1:4873 nocanon  

  ProxyPassReverse /npm http://127.0.0.1:4873  

</VirtualHost>
```

--------------------------------

### Configure NPM Registry

Source: https://www.verdaccio.org/docs/amazon

Set the local Verdaccio instance as the default NPM registry.

```bash
npm set registry http://localhost:4873
```

```bash
npm set ca null
```
Tokens:
Raw