verdaccio / verdaccio-htpasswd Goto Github PK

View Code? Open in Web Editor NEW

🔑 Auth based on htpasswd file plugin (built-in) for verdaccio

License: MIT License

JavaScript 5.93% TypeScript 87.52% HCL 4.81% Shell 1.74%

verdaccio-htpasswd's Introduction

Deprecated repository

This repository has been moved to a monorepo you can find in verdaccio/monorepo. This package is located in plugins/htpasswd folder

Verdaccio Module For User Auth Via Htpasswd

verdaccio-htpasswd is a default authentication plugin for the Verdaccio.

This plugin is being used as dependency after v3.0.0-beta.x. The v2.x still contains this plugin built-in.

Install

As simple as running:

$ npm install -g verdaccio-htpasswd

Configure

auth:
    htpasswd:
        file: ./htpasswd
        # Maximum amount of users allowed to register, defaults to "+infinity".
        # You can set this to -1 to disable registration.
        #max_users: 1000

Logging In

To log in using NPM, run:

    npm adduser --registry  https://your.registry.local

Generate htpasswd username/password combination

If you wish to handle access control using htpasswd file, you can generate username/password combination form here and add it to htpasswd file.

How does it work?

The htpasswd file contains rows corresponding to a pair of username and password separated with a colon character. The password is encrypted using the UNIX system's crypt method and may use MD5 or SHA1.

Plugin Development in Verdaccio

There are many ways to extend Verdaccio, currently it support authentication plugins, middleware plugins (since v2.7.0) and storage plugins since (v3.x).