https://github.com/privatenumber/npm-registry-sync

A daemon to sync packages across npm registries
https://github.com/privatenumber/npm-registry-sync

artifactory daemon enterprise firewall npm registry sync vpn

Last synced: 2 months ago
JSON representation

A daemon to sync packages across npm registries

• Host: GitHub
• URL: https://github.com/privatenumber/npm-registry-sync
• Owner: privatenumber
• Created: 2022-07-22T19:33:55.000Z (over 2 years ago)
• Default Branch: develop
• Last Pushed: 2023-10-11T09:22:20.000Z (about 1 year ago)
• Last Synced: 2024-10-24T09:47:15.007Z (3 months ago)
• Topics: artifactory, daemon, enterprise, firewall, npm, registry, sync, vpn
• Language: TypeScript
• Homepage:
• Size: 89.8 KB
• Stars: 9
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# npm-registry-sync

A daemon to sync packages across npm registries.

## About

`npm-registry-sync` is a daemon (background process) that synchronizes packages across multiple npm registries.

It's useful in scenarios where there are multiple private npm registries (eg. Enterprise [Artifactory](https://www.jfrog.com/confluence/display/JFROG/npm+Registry)) with different packages.

For example, given two private npm registries _A_ & _B_, where _A_ is currently reachable but _B_ is not (eg. behind firewall), `npm-registry-sync` will download all versions of the specified packages from _A_. When _B_ is finally reachable, it will publish all versions of the specified package to registry _B_.

## Usage

1. Setup a directory with a configuration file:

	`npm-registry-sync.config.json`:

	```json5

	{

	    "registries": {

	        "registry-id-a": {

	            "name": "Registry name A",

	            "url": "https://registry-url-a/",

	            "npmrc": "~/npmrc/file", // (Optional)

	            "strictSSL": false, // (Optional)

	            // These packages will be downloaded and published to the other registries

	            "packages": [

	                "package-name-a",

	                "package-name-b",

	                "package-name-c",

	                // ....

	            ]

	        },

	        "registry-id-b": {

	            "url": "https://registry-url-b/",

	            // ...

	        },

	        // ...

	    },

	    // Registry polling interval in seconds

	    "pollingInterval": 60

	}

	```

	> **Tip:** Use [npmrc](https://www.npmjs.com/package/npmrc) to manage configurations for multiple npm registries.

	> 

	> You can then reference the appropriate configuration in `~/.npmrcs/`.

2. Make sure [npm is authenticated](https://docs.npmjs.com/cli/v8/commands/npm-whoami) to the registries:

	```sh

	npm whoami --registry 

	```

3. Start `npm-registry-sync`:

	```sh

	npx npm-registry-sync

	```

	Or run it in the background using [screen](https://linuxize.com/post/how-to-use-linux-screen/):

	```sh

	screen npx npm-registry-sync

	```

## Config schema

```ts

export type Config = {

    registries: Record

    // Frequency to poll the registries in seconds

    // Default: 60

    pollingInterval: number

}

```