Registry / storage / verdaccio-aws-s3-storage

verdaccio-aws-s3-storage

library12.1.1jsnpmunverified

AWS S3 storage provider for Verdaccio npm registry private proxy. Current stable version 12.1.1, ships TypeScript types. Requires Node >=24. Keys packages in S3 with configurable bucket and prefix. Different from generic filesystem storage, enabling cloud-native setups with durability and scaling. Automatically flushes packages to S3 on publish.

storage devops

npm install verdaccio-aws-s3-storage

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · VERDACCIO-AWS-S3-S

verdaccio-aws-s3-storage

storagejavascriptv12.1.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

AWSS3StoragePlugin

✓ import { AWSS3StoragePlugin } from 'verdaccio-aws-s3-storage'

✗ const AWSS3StoragePlugin = require('verdaccio-aws-s3-storage')

Plugin class for Verdaccio v5+ configuration. Package is ESM-only since v12.

Configures Verdaccio to use AWS S3 as backend storage with required credentials and bucket settings.

import { AWSS3StoragePlugin } from 'verdaccio-aws-s3-storage'; import { ConfigBuilder } from 'verdaccio'; const config = ConfigBuilder.build({ storage: false, plugins: [ { package: 'verdaccio-aws-s3-storage', options: { bucket: 'my-npm-registry', keyPrefix: 'packages/', region: 'us-east-1', accessKeyId: process.env.AWS_ACCESS_KEY_ID ?? '', secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY ?? '', }, }, ], }); console.log('Config ready for Verdaccio with S3 storage');

Debug

Known issues

breakingUpgraded to ESM-only in v12, breaking CommonJS imports

fix

Use import syntax or upgrade to Node >=24 with 'type': 'module'

affects: >=12.0.0

breakingDropped support for Node <24 in v12

fix

Upgrade Node.js to version 24 or higher

affects: >=12.0.0

deprecatedVerdaccio v4 configuration is not supported; requires Verdaccio v5+

fix

Update Verdaccio to v5 and use new plugin configuration

affects: >=12.0.0

gotchaAccess keys provided via options are passed in config file; ensure they are not committed to version control

fix

Use environment variables or IAM roles instead of hardcoded values

affects: all

gotchaBucket must already exist; plugin does not create S3 buckets automatically

fix

Create the S3 bucket manually before starting Verdaccio

affects: all

breakingRemoved support for AWS SDK v2 in v12; now requires @aws-sdk/client-s3 v3

fix

Install @aws-sdk/client-s3 and update your code accordingly

affects: >=12.0.0

Errors

Common errors & fixes

Error [ERR_REQUIRE_ESM]: Must use import to load ES Module

Using require() on v12+ which is ESM-only

fix

Use import { AWSS3StoragePlugin } from 'verdaccio-aws-s3-storage' or set 'type': 'module' in package.json

TypeError: verdaccio_aws_s3_storage_1.default is not a constructor

Misunderstanding default vs named export

fix

Change import to import { AWSS3StoragePlugin } from 'verdaccio-aws-s3-storage'

CredentialsError: Missing credentials in config

AWS credentials not provided via options or environment

fix

Set AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables or pass accessKeyId/secretAccessKey in plugin options

NoSuchBucket: The specified bucket does not exist

S3 bucket name is incorrect or bucket not created

fix

Verify bucket name and create the bucket in AWS S3 before running Verdaccio

Upgrade

Version history

12.1.1latest on npm

Audit

Dependencies

verdacciorequiredPlugin host; this package provides storage for Verdaccio

@aws-sdk/client-s3requiredAWS SDK for S3 interactions

Agent activity

31 hits · last 30 days

node

Resources

githubhttps://github.com/verdaccio/verdaccio-aws-s3-storage ↗

packageverdaccio-aws-s3-storage ↗

homepagehttps://verdaccio.org ↗