Verdaccio
About
Verdaccio is a lightweight open source private npm proxy registry.
- Questions? Ask in the Cloudron Forum - Verdaccio
- Verdaccio Website
- Verdaccio issue tracker
Custom configuration
Add custom verdaccio configuration using the File Manager:
- Add any custom configuration in
/app/data/config.yaml. - Restart the app
See config.yaml for reference.
Access control
See the Verdaccio docs on how to allow or restrict access to packages.
CLI authentication
The package use OIDC authentication and providing the raw username and password to the npm/yarn/pnpm CLI tools will not work.
Two methods are available to set up CLI authentication:
npx verdaccio-openid@latest --registry http://your-registry.com
You can then use the above credentials in npm adduser --registry https://your-registry.com/
- Login to the Web UI . Settings -> Configuration
Publishing packages
To publish a package:
npx verdaccio-openid@latest --registry http://your-registry.com
npm publish --registry https://your-registry.com
Verdaccio is a proxying package manager. Packages are checked against npmjs registry
before being published. For this reason, publishing packages that already exist on npmjs
will result in a EPUBLISHCONFLICT error. See GitHub issue 1203
for a workaround.
Installing packages
To set the custom registry globally:
npx verdaccio-openid@latest --registry http://your-registry.com
npm set registry https://your-registry.com
To set it on just the project:
npx verdaccio-openid@latest --registry http://your-registry.com
npm install my-package --registry https://your-registry.com