Nebulous Program Mechanic
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    verdacciopublic

    A lightweight private npm proxy registry

    verdaccio is a fork of sinopia. It aims to keep backwards compatibility with sinopia, while keeping up with npm changes.

    CircleCI npm version badge downloads badge Gitter chat

    It allows you to have a local npm private registry with zero configuration. You don't have to install and replicate an entire database. Verdaccio keeps its own small database and, if a package doesn't exist there, it asks any other registry (npmjs.org) for it keeping only those packages you use.

    Quick Links

    Introduction

    Use private packages

    If you want to use all benefits of npm package system in your company without sending all code to the public, and use your private packages just as easy as public ones.

    Cache npmjs.org registry

    If you have more than one server you want to install packages on, you might want to use this to decrease latency (presumably "slow" npmjs.org will be connected to only once per package/version) and provide limited failover (if npmjs.org is down, we might still find something useful in the cache) or avoid issues like How one developer just broke Node, Babel and thousands of projects in 11 lines of JavaScript.

    Override public packages

    If you want to use a modified version of some 3rd-party package (for example, you found a bug, but maintainer didn't accept pull request yet), you can publish your version locally under the same name.

    See in detail each of these use cases.

    Get Started

    Prerequisites

    • Node.js >= 4.6.1
    • npm or yarn

    Installation and starting (application will create default config in config.yaml you can edit later)

    npm install --global verdaccio

    Run in your terminal

    verdaccio

    You would need set some npm configuration, this is optional.

    $ npm set registry http://localhost:4873/
    # if you use HTTPS, add an appropriate CA information 
    # ("null" means get CA list from OS) 
    $ npm set ca null

    Now you can navigate to http://localhost:4873/ where your local packages will be listed and can be searched.

    Warning: Verdaccio does not currently support PM2's cluster mode, running it with cluster mode may cause unknown behavior.

    Alpha

    ⚠️⚠️ Please, help us to test the version 3.x in order to release a stable version soon. Do never test with your original storage folder, do always a backup ⚠️⚠️

    If you are an adventurous developer you can use and install the latest beta version, this is a non stable version, I'd recommend only use for testing purporses.

    $ npm install -g verdaccio@alpha

    or using docker

    $ docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio:alpha

    Publishing Private Packages

    Create an user and log in

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

    Publish your package

    npm publish --registry http://localhost:4873

    This will prompt you for user credentials which will be saved on the verdaccio server.

    Docker

    Below are the most commony needed informations, every aspect of Docker and verdaccio is documented separately

    Prebuilt images

    To pull the latest pre-built docker image:

    docker pull verdaccio/verdaccio

    Since version 2 images for every version are available as tags.

    Running verdaccio using Docker

    To run the docker container:

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

    Using docker-compose

    1. Get the latest version of docker-compose.
    2. Build and run the container:
    $ docker-compose up --build

    Docker examples are available in this repository.

    Compatibility

    Verdaccio aims to support all features of a standard npm client that make sense to support in private repository. Unfortunately, it isn't always possible.

    Basic features

    • Installing packages (npm install, npm upgrade, etc.) - supported
    • Publishing packages (npm publish) - supported

    Advanced package control

    • Unpublishing packages (npm unpublish) - supported
    • Tagging (npm tag) - supported
    • Deprecation (npm deprecate) - not supported

    User management

    • Registering new users (npm adduser {newuser}) - supported
    • Transferring ownership (npm owner add {user} {pkg}) - not supported, verdaccio uses its own acl management system

    Misc stuff

    • Searching (npm search) - supported (cli / browser)
    • Starring (npm star, npm unstar) - not supported, doesn't make sense in private registry
    • Ping (npm ping) - supported

    FAQ / Contact / Troubleshoot

    If you have any issue you can try the following options, do no desist to ask or check our issues database, perhaps someone has asked already what you are looking for.

    install

    npm i verdaccio

    Downloadsweekly downloads

    4,522

    version

    2.7.4

    license

    WTFPL

    repository

    githubgithub

    last publish

    collaborators

    • avatar