mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-23 22:27:34 -05:00

History

Behrang Yarahmadi 13310814da #2606 add prettier plugin sort imports (#2607 ) * #2606 add prettier plugin sort imprts * #2606 update pnpm-lock.yaml * #2606 update eslint rules * #2606 fixes website directory formatting Co-authored-by: Ayush Sharma <ayush.sharma@trivago.com>		2021-10-29 17:33:05 +02:00
..
src	#2606 add prettier plugin sort imports (#2607 )	2021-10-29 17:33:05 +02:00
tests	#2606 add prettier plugin sort imports (#2607 )	2021-10-29 17:33:05 +02:00
.babelrc
.eslintignore
.eslintrc.json
CHANGELOG.md	chore: update versions (6-next) (#2597 )	2021-10-27 18:16:16 +02:00
htpasswd
jest.config.js
LICENSE
package.json	chore: update versions (6-next) (#2597 )	2021-10-27 18:16:16 +02:00
README.md
tsconfig.build.json
tsconfig.json

README.md

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
        # Hash algorithm, possible options are: "bcrypt", "md5", "sha1", "crypt".
        #algorithm: bcrypt
        # Rounds number for "bcrypt", will be ignored for other algorithms.
        #rounds: 10

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