JavaScript CSS HTML Other
Clone or download
Permalink
Failed to load latest commit information.
bin fix: "start" should wait for "stop" to remove the pid file(using Prom… Sep 5, 2017
common refactor: use yield instead of yield* Aug 21, 2017
config feat: can config to not sync deleted versions (#1282) Jan 7, 2018
controllers feat: auto retry if download tgz error (#1363) Jul 20, 2018
docs docs: Dockerized cnpmjs.org configuration with installation guide (#1191 Jun 13, 2017
lib fix: add other_urls on download dist tarball (#1345) Jun 5, 2018
middleware feat: let opensearch host can be config (#1258) Nov 22, 2017
models refactor: use yield instead of yield* Aug 21, 2017
public feat: add security check badge for public package (#971) Jun 26, 2016
routes refactor: use yield instead of yield* Aug 21, 2017
servers feat: support pass through querystring to tgz url (#1334) May 21, 2018
services refactor: use yield instead of yield* Aug 21, 2017
sync fix: save sync last time when successes > 1000 Mar 15, 2018
test fix: add other_urls on download dist tarball (#1345) Jun 5, 2018
tools fix: try to sync from official replicate (#1076) Nov 19, 2016
view/web fix: don't sync upstream on every sync request (#1216) Aug 22, 2017
.dockerignore docs: Dockerized cnpmjs.org configuration with installation guide (#1191 Jun 13, 2017
.editorconfig update editorconfig Nov 25, 2014
.gitignore change proxy/user.js => models/user.js Oct 12, 2014
.jshintignore feat: list packages by username Sep 28, 2015
.jshintrc mv proxy/module.js into services/package.js Oct 15, 2014
.node-dev.json feat(mock): use koa-mock for front end dev Nov 21, 2014
.npmignore docs: Deploy a private npm registry in 5 minutes Feb 3, 2015
.travis.yml deps: agentkeepalive to v3.3.0 Aug 21, 2017
AUTHORS Release 2.19.0 Dec 20, 2016
CONTRIBUTING.md add contribute guidelines Apr 9, 2014
Dockerfile docs: Dockerized cnpmjs.org configuration with installation guide (#1191 Jun 13, 2017
History.md refactor: use yield instead of yield* Aug 21, 2017
LICENSE.txt fix: should sync missing public scoped package on install (#946) Jun 5, 2016
Makefile refactor: use koa-rt, koa-rewrite, koa-conditional-get, koa-etag Aug 21, 2017
README.md docs: Dockerized cnpmjs.org configuration with installation guide (#1191 Jun 13, 2017
dispatch.js feat: add changes stream syncer (#970) Jun 25, 2016
docker-compose.yml docs: Dockerized cnpmjs.org configuration with installation guide (#1191 Jun 13, 2017
index.js feat: list packages by username Sep 28, 2015
logo.png add module controller test cases; fix next module not exists logic bug. Dec 5, 2013
package.json Release 3.0.0-beta.5 Jun 5, 2018
worker.js feat: enable maxrequests middleware (#1003) Jul 26, 2016

README.md

cnpmjs.org

NPM version build status Test coverage David deps Known Vulnerabilities npm download

logo

What is this?

Private npm registry and web for Enterprise, base on koa, MySQL and Simple Store Service.

Our goal is to provide a low cost maintenance and easy to use solution for private npm.

What can you do with cnpmjs.org

  • Build a private npm for your own enterprise. (alibaba is using cnpmjs.org now)
  • Build a mirror NPM. (we use it to build a mirror in China: cnpmjs.org)
  • Build a completely independent NPM registry to store whatever you like.

Features

  • Support "scoped" packages: npm/npm#5239
  • Support CORS
  • Simple to deploy: only need mysql and a simple store system. You can get the source code through npm or git.
  • Low cost and easy maintenance: package.json info store in MySQL, MariaDB, SQLite or PostgreSQL databases, tarball(tgz file) store in CDN or other store systems.
  • Automatic synchronization: automatic synchronization from any registry specified, support two sync modes:
    • Sync all modules from a specified registry, like npm registry.
    • Only sync the modules that exists in your own registry.
  • Manual synchronization: automatic synchronization may has little delay, but you can syn immediately by manually.
  • Customized client: we provide a client cnpm to extend npm with more features(sync command, gzip support). And it easy to wrap for your own registry which build with cnpmjs.org.
  • Compatible with NPM client: you can use the origin NPM client with cnpmjs.org, only need to change the registry in config. Even include manual synchronization (through install command).
  • Version badge: base on shields.io cnpm-badge
  • Support http_proxy: if you're behind firewall, need to request through http proxy

PROTIP Be sure to read Migrating from 1.x to 2.x as well as New features in 2.x.

Getting Start

Develop on your local machine

Dependencies

  • node >= 4.3.1
  • Databases: only required one type
    • sqlite3 >= 3.0.2, we use sqlite3 by default
    • MySQL >= 0.5.0, include mysqld and mysql cli. I test on mysql@5.6.16.
    • MariaDB
    • PostgreSQL

Clone codes and run test

# clone from git
$ git clone https://github.com/cnpm/cnpmjs.org.git

# install dependencies
$ make install

# test
$ make test

# coverage
$ make test-cov

# update dependencies
$ make autod

# start server with development mode
$ make dev

Dockerized cnpmjs.org Installation Guide

Cnpmjs.org shipped with a simple but pragmatic Docker Compose configuration.With the configuration, you can set up a MySQL backed cnpmjs.org instance by executing just one command on Docker installed environment.

Preparation

Dockerized cnpmjs.org control command

Make sure your current working directory is the root of this GitHub repository.

Run dockerized cnpmjs.org
 $docker-compose up

This command will build a Docker image using the current code of repository. Then set up a dockerized MySQL instance with data initialized. After Docker container running, you can access your cnpmjs.org web portal at http://127.0.0.1:7002 and npm register at http://127.0.0.1:7001.

Run cnpmjs.org in the backend

$docker-compose up -d

Rebuild cnpmjs.org Docker image

$docker-compose build

Remove current dockerized cnpmjs.org instance

The current configuration set 2 named Docker Volume for your persistent data. If you haven't change the repository directory name, them will be "cnpmjsorg_cnpm-files-volume" & "cnpmjsorg_cnpm-db-volume".

Be Careful, the following commands will remove them.

$docker-compose rm 
$docker volume rm cnpmjsorg_cnpm-files-volume
$docker volume rm cnpmjsorg_cnpm-db-volume

You can get more information about your data volumes using the below commands:

$docker volume ls  // list all of your Docker volume
$docker volume inspect cnpmjsorg_cnpm-files-volume
$docker volume inspect cnpmjsorg_cnpm-db-volume

How to contribute

  • Clone the project
  • Checkout a new branch
  • Add new features or fix bugs in the new branch
  • Make a pull request and we will review it ASAP

Tips: make sure your code is following the node-style-guide.

Sponsors

  • 阿里云 (2016.2 - now)
  • UCloud云计算 (2015.3 - 2016.3)

License

MIT