plugin-package-registry
v1.0.8
Published
Provides a package registry functionality for managing plugin and artifact distributions.
Maintainers
Readme
plugin-package-registry
Overview
Provides a package registry functionality for managing plugin and artifact distributions.
Features
- Local NPM Registry: Host and manage private NocoBase plugins without a third-party registry.
- Proxy Cache Registry: Configure a registry as
type=proxywith anupstreamUrl; cache misses are fetched from the upstream registry and stored locally before being served. - Version Control: Track versions, dependencies, and tarball artifacts for custom plugins.
- One-Click Install: Enables downloading and installing plugins directly from this registry into other NocoBase instances.
Usage
- Enable the plugin on your "hub" NocoBase instance.
- Go to Package Registry settings to view hosted packages.
- Use the API or CLI to publish new
.tgzplugin builds to this registry. - On client NocoBase instances, configure this URL as the source to install plugins.
Proxy cache
Create a packageRegistries record with:
name: local registry name, for exampleinternaltype:proxyformat:npmupstreamUrl: upstream npm registry URL, for examplehttps://registry.npmjs.org
Use the local registry URL as the npm registry source:
yarn nocobase pm add <package-name> --registry=https://<host>/api/package-registry/npm/internalOn a cache miss, metadata and tarballs are fetched from upstreamUrl, saved under storage/package-registry/npm/internal, and then served from the local registry.
