Verdaccio

https://verdaccio.org/docs/next/
Admin
Verdaccio is a lightweight private npm proxy registry that allows you to host and manage npm...
Tokens:36,152
Snippets:232
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Run Verdaccio Server

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

Starts the Verdaccio private registry server. This command executes the installed Verdaccio CLI, typically listening on http://localhost:4873. It logs information about the storage path, authentication method, and server version.

```shell
$> 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-6-next.48
 info --- server started
```

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

### Install and Start Verdaccio Service with WinSW

Source: https://verdaccio.org/docs/next/windows

These commands show how to install and start the Verdaccio Windows service after configuring it with WinSW. This ensures the service is registered and running on the system.

```bash
cd c:\verdaccio
verdaccio-winsw.exe install
verdaccio-winsw.exe start
```

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

### Deploy Verdaccio using Docker

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

Runs the official Verdaccio Docker image. This command starts a container named 'verdaccio', maps port 4873 on the host to the container, and uses the 'nightly-master' tag for the image. Assumes Docker is installed and running.

```shell
docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio:nightly-master
```

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

### Verdaccio CLI Command Example

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

This snippet shows a basic command to start the Verdaccio application using the CLI. It specifies the port to listen on and the configuration file to use. Dependencies include the Verdaccio CLI itself.

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

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

### Start Verdaccio Server

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

This command initiates the Verdaccio private npm registry server. No specific inputs are required, and it typically runs in the foreground, displaying logs. Ensure Verdaccio is installed before execution.

```bash
$> verdaccio  

```

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

### Install Verdaccio CLI Globally (npm, yarn, pnpm)

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

Installs the Verdaccio command-line interface globally on your system using npm, yarn@1.x (classic), or pnpm. Ensure you have Node.js v18 or higher and a compatible package manager installed. This command makes the 'verdaccio' command available for execution.

```shell
npm install -g verdaccio@next-7
```

```shell
yarn global add verdaccio@next-7
```

```shell
pnpm install -g verdaccio@next-7
```

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

### Verdaccio start.js for iisnode (< v3.0)

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

Alternate Node.js script for older Verdaccio versions (< v3.0) to start the application with iisnode. It configures the port via command-line arguments.

```javascript
process.argv.push('-l', 'unix:' + process.env.PORT);
require('./node_modules/verdaccio/src/lib/cli.js');
```

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

### Verdaccio start.js for iisnode (v3.0+)

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

Node.js script to configure and start Verdaccio for iisnode. It sets the port and configuration file path via command-line arguments.

```javascript
process.argv.push('-l', 'unix:' + process.env.PORT, '-c', './config.yaml');
require('./node_modules/verdaccio/build/lib/cli.js');
```

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

### Example `__VERDACCIO_BASENAME_UI_OPTIONS` Object

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

An example of the `__VERDACCIO_BASENAME_UI_OPTIONS` object, which is available in the browser's global context and contains configuration options for the UI theme.

```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 'forever'

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

Starts the Verdaccio process using the 'forever' tool, ensuring it runs in the background. This command assumes Verdaccio has been run at least once to generate configuration files. Requires Verdaccio and 'forever' to be installed.

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

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

### Start Verdaccio Server with runServer - Node.js

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

This snippet shows how to use the `runServer` function from the Verdaccio module to start the registry. It illustrates starting with default configuration, specifying a config file path, or passing a configuration object. The server listens on port 4000, and a callback is provided for post-listen actions. Note that `self_path` is required for older versions (v5) when passing a config object.

```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
});

```

```javascript
const { runServer, parseConfigFile } = require('verdaccio');
const configPath = join(__dirname, './config.yaml');
const c = parseConfigFile(configPath);
// workaround
// on v5 the `self_path` still exists and will be removed in v6
c.self_path = 'foo';
runServer(c).then(() => {});

```

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

### Install Verdaccio Theme Plugin (npm)

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

Command to install a custom Verdaccio theme plugin globally using npm. The plugin name must start with `verdaccio-theme-` to be recognized.

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

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

### Verdaccio Server API for Service Management (JavaScript)

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

This snippet shows basic JavaScript usage of the 'verdaccio-server' module for managing a local npm registry proxy. It includes functions for starting, stopping, listing, and stopping all instances, as well as displaying server information. It also demonstrates service installation and management for Windows .NET environments.

```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();
```

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

### Install Verdaccio Locally (npm)

Source: https://verdaccio.org/docs/next/windows

This snippet shows how to install Verdaccio locally within a project directory. It's recommended to avoid global installations to manage npm dependencies more effectively.

```bash
mkdir c:\verdaccio
cd c:\verdaccio
npm install verdaccio
```

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

### Verdaccio Theme Configuration Example

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

Example configuration snippet for Verdaccio to load a custom theme and pass options to it. Only one theme can be loaded at a time.

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

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

### Community Storage Plugins

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

A list of community-developed storage plugins that implement the Verdaccio Storage API, which can be used as examples or directly in your Verdaccio setup.

```APIDOC
## Community Storage Plugins

### Description
These community plugins implement the Storage API and can serve as examples or direct replacements for the default storage.

### List of Plugins
* **verdaccio-memory**: Storage plugin to host packages in Memory.
* **verdaccio-s3-storage**: Storage plugin to host packages on Amazon S3.
* **verdaccio-aws-s3-storage**: Storage plugin to host packages on Amazon S3 (maintained by Verdaccio core team).
* **verdaccio-google-cloud**: Storage plugin to host packages on Google Cloud Storage.
* **verdaccio-minio**: A Verdaccio plugin for storing data in Minio.
* **verdaccio-offline-storage**: Local-storage plugin that prioritizes locally available packages.
```

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

### Configure npm Client to Use Verdaccio Registry

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

Configures your npm client to use the locally running Verdaccio registry. This can be done temporarily using the --registry flag during commands or permanently by setting the 'registry' field in your .npmrc file or 'publishConfig' in package.json.

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

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

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

```json
{
  "publishConfig": {
    "registry": "http://localhost:4873"
  }
}
```

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

### Install Verdaccio Active Directory Plugin

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

Installs the verdaccio-activedirectory plugin globally using npm. This plugin provides Active Directory authentication for Verdaccio.

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

```

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

### Install Sinopia Memory Plugin (Legacy)

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

Installs the sinopia-memory plugin globally using npm. This is a legacy plugin compatible with Verdaccio due to its Sinopia fork heritage.

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

```

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

### Example .npmrc configuration for Verdaccio

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

Example content of an .npmrc file showing registry configuration and authentication tokens for both Verdaccio and npmjs.org. It includes registry URLs and their corresponding auth tokens.

```ini
registry=http://localhost:5555/  
//localhost:5555/:_authToken="secretVerdaccioToken"  
//registry.npmjs.org/:_authToken=secretNpmjsToken  

```

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

### Install Verdaccio Dependencies using npm

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

Commands to navigate to the Verdaccio directory and install its Node.js dependencies using npm. Assumes you are in the directory where package.json is saved.

```bash
cd c:\verdaccio  
npm install  
```

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

### Install Verdaccio Dark Theme

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

Installs the verdaccio-theme-dark plugin globally using npm. This plugin provides a dark theme for the Verdaccio UI.

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

```

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

### Install Verdaccio UI Components

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

Install the Verdaccio UI components as a development dependency in your local project. This command adds the necessary package for using the reusable React components.

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

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

### Deploy Verdaccio using Helm Chart

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

Deploys Verdaccio to a Kubernetes cluster using the Helm package manager. This involves adding the Verdaccio Helm repository, updating it, and then installing the Verdaccio chart, specifying the 'nightly-master' image tag.

```shell
$ helm repo add verdaccio https://charts.verdaccio.org
$ helm repo update
$ helm install registry --set image.tag=nightly-master verdaccio/verdaccio
```

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

### Start Verdaccio Programmatically with Node.js API

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

This code snippet demonstrates how to start a Verdaccio server programmatically using its Node.js API. It requires the 'verdaccio' package and involves defining a configuration object that specifies storage, authentication, uplinks, and package routing. The server is then started with a specific port and callback function.

```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}`);
            }
        );
    }
);
```

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

### Install NVM and Node.js

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

Installs Node Version Manager (nvm) and then installs the latest Node.js version using nvm. This is a prerequisite for installing Verdaccio.

```bash
sudo apt update
wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash
exit
nvm install node
```

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

### React App Example with Verdaccio UI Components

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

An example of how to integrate Verdaccio UI components into a React application. It demonstrates setting up routing, Redux store, context providers for configuration, translation, and version information, along with basic layout components like Header and Footer. This example requires React v17+, Material UI v5.x+, Redux v4.x+, Emotion v11+, and i18next v20.x+.

```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>
  );
};

```

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

### Install Verdaccio and PM2

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

Installs Verdaccio globally using npm and also installs PM2, a process manager, to run Verdaccio as a background service.

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

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

### Verdaccio Programmatic Start (Deprecated) - Node.js

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

This code demonstrates a method for programmatically starting Verdaccio, which is discouraged for future releases but functional for versions prior to v5.11.0. It involves reading a YAML configuration file, manually setting `self_path`, and then calling the Verdaccio function with various parameters including the configuration, port, cache path, version, and name.

```javascript
const fs = require('fs');
const path = require('path');
const verdaccio = require('verdaccio').default;
const YAML = require('js-yaml');

const getConfig = () => {
  return YAML.load(fs.readFileSync(path.join(__dirname, 'config.yaml'), 'utf8'));
};

const cache = path.join(__dirname, 'cache');
const config = Object.assign({}, getConfig(), {
  self_path: cache,
});

verdaccio(config, 6000, cache, '1.0.0', 'verdaccio', (webServer, addrs, pkgName, pkgVersion) => {
  try {
    webServer.unref();
    webServer.listen(addrs.port || addrs.path, addrs.host, () => {
      console.log('verdaccio running');
    });
  } catch (error) {
    console.error(error);
  }
});

```

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

### Bash Script for Local Verdaccio Registry and NPM Publish

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

This Bash script demonstrates how to start a local Verdaccio registry, configure it, log in using npm-auth-to-token, and publish an npm package to the local registry. It's extracted from create-react-app.

```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"

```

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

### Configure Bun Project Registry

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

Set the local Verdaccio registry for a specific project by creating a `bunfig.toml` file. This ensures `bun install` uses your local registry. Authentication can be enabled by setting tokens within the `[install.scopes]` section.

```toml
[install]
registry = "http://localhost:4873"

```

```toml
[install.scopes]

# as an object with token
"@scope" = { token = "$npm_token", url = "https://localhost:4873/" }

```

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

### Install 'forever' Package

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

Installs the 'forever' Node.js package globally using npm. 'Forever' is used to ensure that the Verdaccio process runs continuously and restarts automatically if it crashes. Requires root or sudo access.

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

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

### Configure Verdaccio Service with NSSM

Source: https://verdaccio.org/docs/next/windows

This section details how to set up Verdaccio as a Windows service using NSSM. It requires specifying the path to the node executable, the startup directory, and the arguments for the Verdaccio CLI, including the configuration file path.

```bash
nssm install verdaccio

# In the NSSM application tab:
# Path: node
# Startup directory: c:\verdaccio
# Arguments: c:\verdaccio\node_modules\verdaccio\build\lib\cli.js -c c:\verdaccio\config.yaml

sc start verdaccio
```

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

### Handlebars Template Examples for Notifications

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

These examples showcase how to use the Handlebars templating engine to format notification messages. They demonstrate iterating through package versions and including publisher information.

```handlebars
# iterate all versions
{{ name }}{{#each versions}} v{{version}}{{/each}}

# publisher and `dist-tag` package published
{{ publisher.name }} has published {{ publishedPackage }}
```

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

### Access Scaffolded Plugin Directory and Package.json

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

This example shows how to navigate into the newly created Verdaccio plugin directory and view its `package.json` file. This step is performed after the `yo verdaccio-plugin` command has finished, allowing the developer to inspect the generated project structure and metadata.

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

  {
  "name": "verdaccio-plugin-service-name",
  "version": "0.0.1",
  "description": "awesome auth plugin",
  ...

}
```

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

### Start and Configure Verdaccio

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

Starts Verdaccio to generate the configuration file and then configures it to listen on all network interfaces and restricts access to authenticated users. It also sets the maximum number of users.

```yaml
listen:
 - 0.0.0.0:4873

access: $authenticated
#max_users: 1000
max_users: 1
```

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

### Run Verdaccio with PM2

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

Starts Verdaccio as a background service using PM2, lists the running processes, and saves the current PM2 process list to ensure Verdaccio launches on system startup.

```bash
pm2 start verdaccio
pm2 list
pm2 stop verdaccio
pm2 delete verdaccio
pm2 startup
which verdaccio
pm2 start /home/ubuntu/.nvm/versions/node/v17.1.0/bin/verdaccio
pm2 status
pm2 save
```

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

### Verdaccio package.json for iisnode

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

Defines the project name, version, main script, and dependencies for hosting Verdaccio with iisnode. Specifies 'verdaccio' as a dependency.

```json
{
  "name": "iisnode-verdaccio",
  "version": "1.0.0",
  "description": "Hosts verdaccio in iisnode",
  "main": "start.js",
  "dependencies": {
    "verdaccio": "^3.11.0"
  }
}
```

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

### Install Verdaccio using npm

Source: https://verdaccio.org/docs/next/index

Installs Verdaccio globally on your system using the Node Package Manager (npm). This command makes the Verdaccio executable available in your terminal.

```bash
npm install --global verdaccio
```

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

### Verdaccio Plugin Generator CLI Interaction (Bash)

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

Demonstrates the command-line interaction for generating a Verdaccio plugin using the 'yo verdaccio-plugin' command. It shows the prompts for plugin name, language, type, description, author details, and keywords, followed by file creation and npm install.

```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.


⸨ ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░  
```
    }
  ]
}
```
```

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

### Full ES5 Authentication Plugin Implementation

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

This JavaScript code provides a full implementation example of an authentication plugin using ES5 syntax. It defines a constructor function `Auth` that initializes the plugin with configuration and Verdaccio's logger, and includes an `authenticate` method that utilizes an external LDAP authentication library.

```javascript
function Auth(config, stuff) {
  var self = Object.create(Auth.prototype);
  self._users = {};

  // config for this module
  self._config = config;

  // verdaccio logger
  self._logger = stuff.logger;

  // pass verdaccio logger to ldapauth
  self._config.client_options.log = stuff.logger;

  return self;
}

Auth.prototype.authenticate = function (user, password, callback) {
  var LdapClient = new LdapAuth(self._config.client_options);
  ....
  LdapClient.authenticate(user, password, function (err, ldapUser) {
    ...
    var groups;
     ...
    callback(null, groups);
  });
};

module.exports = Auth;
```

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

### Build Verdaccio Plugin with Native Dependencies (Dockerfile)

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

This Dockerfile snippet demonstrates how to build a Verdaccio plugin with native dependencies. It uses a multi-stage build, first installing the plugin in a builder stage and then copying the installed plugin to the final Verdaccio image. Ensure the base image matches the Verdaccio Dockerfile.

```dockerfile
FROM node:lts-alpine as builder  
RUN mkdir -p /verdaccio/plugins \  
  && cd /verdaccio/plugins \  
  && npm install --global-style --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  

```

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

### Install Protected Package (npm CLI)

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

This command demonstrates attempting to install a package ('npmuser-core') that is protected by Verdaccio's access control. The expected output shows a 403 Forbidden error, indicating that the current user does not have the necessary permissions to install the package.

```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  
```

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

### Configure Deno to Use Verdaccio Registry

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

Set up a .npmrc file in your project to direct Deno installations to your local Verdaccio registry. This ensures packages are fetched from your private registry.

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

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

### Verdaccio Authentication Callback Examples (JavaScript)

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

Provides examples of how to use callback functions within Verdaccio authentication plugins to signal success, failure, or errors. Covers 'authenticate', 'adduser', 'changePassword', and access control callbacks.

```javascript
callback(null, false);

```

```javascript
callback(null, groups);

```

```javascript
import { getInternalError } from '@verdaccio/commons-api';

callback(getInternalError('something bad message), null);

```

```javascript
callback(null, true);

```

```javascript
import { getConflict } from '@verdaccio/commons-api';

const err = getConflict('maximum amount of users reached');

callback(err);

```

```javascript
const user = serviceUpdatePassword(user, password, newPassword);

callback(null, user);

```

```javascript
import { getNotFound } from '@verdaccio/commons-api';

const err = getNotFound('user not found');

callback(err);

```

```javascript
allow_access(user: RemoteUser, pkg: PackageAccess, cb: Callback): void {
  const isAllowed: boolean = checkAction(user, pkg);

  callback(null, isAllowed)
}

```

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

### Configure Verdaccio Service with WinSW (XML)

Source: https://verdaccio.org/docs/next/windows

This snippet demonstrates how to configure Verdaccio as a Windows service using WinSW. It involves placing the WinSW executable, renaming it, and creating an XML configuration file that specifies the service details and the Verdaccio executable path.

```xml
<service>
  <id>verdaccio</id>
  <name>Verdaccio</name>
  <description>Lightweight private npm proxy registry</description>
  <executable>node</executable>
  <arguments>c:\verdaccio\node_modules\verdaccio\src\lib\cli.js -c c:\verdaccio\config.yaml</arguments>
  <workingdirectory>c:\verdaccio\</workingdirectory>
</service>
```

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

### Navigating to Plugin Directory (Bash)

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

Command to change the current directory to the newly scaffolded Verdaccio plugin project. This allows for further development and npm installation.

```bash
➜ cd verdaccio-plugin-auth-service-name
```
Tokens:
Raw