verdaccio / verdaccio-aws-s3-storage

📦 Amazon Web Services S3 storage plugin

Deprecated repository

This repository has been moved to a monorepo you can find in verdaccio/monorepo. This package is located in plugins/aws-s3-storage folder

---

verdaccio-aws-s3-storage

📦 AWS S3 storage plugin for verdaccio

Based on verdaccio-s3-storage built in Typescript + other features.

🚧 Alpha testing

See it in action in our Docker + LocalStack + Verdaccio 4 + S3 Plugin example.

Requirements

• AWS Account
• Verdaccio server (4.0) (for 3.x use verdaccio-s3-storage instead)

npm install -g verdaccio

This plugin is not supported in the version 2.x

Usage

npm install verdaccio-aws-s3-storage

This will pull AWS credentials from your environment.

In your verdaccio config, configure

store:
  aws-s3-storage:
    bucket: your-s3-bucket
    keyPrefix: some-prefix # optional, has the effect of nesting all files in a subdirectory
    region: us-west-2 # optional, will use aws s3's default behavior if not specified
    endpoint: https://{service}.{region}.amazonaws.com # optional, will use aws s3's default behavior if not specified
    s3ForcePathStyle: false # optional, will use path style URLs for S3 objects
    accessKeyId: your-access-key-id # optional, aws accessKeyId for private S3 bucket
    secretAccessKey: your-secret-access-key # optional, aws secretAccessKey for private S3 bucket