npmjs-server

A simple private NPM registry running on Node.js.

What is this?

A server for storing and distributing NPM packages within an organization or for personal use. Standard npm clients can publish, search for, and install packages.

Packages and user information are stored in files, so no database is required. Both scoped and unscoped packages are supported.

A browser-based administration UI lets you browse packages and versions, read READMEs, download packages, upload multiple .tgz files, manage users, revoke npm tokens, and configure two-step authentication.

Key Features

• npm client support, including npm publish, npm install, npm search, and npm dist-tag.
• File-based storage without a database.
• Three authentication modes: no authentication, authentication for publishing, or authentication for both reading and publishing.
• Optional two-step authentication per user, with QR registration, authenticator codes, and recovery codes.
• Read-only upstream npm registry proxying with package caching.
• Bulk imports from existing hosted registries, using the Nexus 3 enumeration API or a package name list.
• Reverse proxy support through a fixed public URL or forwarded headers.
• Run with Docker or Podman.

System Requirements

Node.js 20.19.0 or later is required. The administration UI is available in a browser.

Installation

npm install -g npmjs-server

Usage

# Start on the default port, 4873
npmjs-server

# Use a different port
npmjs-server --port 3000

Open http://localhost:4873/ in a browser to use the administration UI. Authentication is disabled by default, allowing anyone to read and publish packages. See the documentation to enable authentication.

Documentation

See the repository documentation for npm client setup, storage, configuration, authentication and TOTP recovery, upstream proxying, Docker, and CI usage.

Pull Requests

Pull requests are welcome. Please submit them against the develop branch.

License

Under MIT.