Skip to content

Commit

Permalink
Fix typo in README, clarify aws-s3-storage configuration (#701)
Browse files Browse the repository at this point in the history
Primarily a fix the invalid capitalisation of the `accessKeyID` configuration key.

Tidied up related documentation.
  • Loading branch information
barrywoolgar authored Feb 17, 2024
1 parent 72c7eab commit 64996bd
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions plugins/aws-s3-storage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ is under control of Verdaccio community and constantly upated.
* AWS Account (in case you are using the cloud)
* Verdaccio server (4.0) (for 3.x use `verdaccio-s3-storage` instead)

```
```bash
npm install -g verdaccio
```

## Usage

```
```bash
npm install verdaccio-aws-s3-storage
```

Expand Down Expand Up @@ -66,22 +66,27 @@ The configured values can either be the actual value or the name of an environme
- `keyPrefix`
- `region`
- `endpoint`
- `accessKeyID`
- `accessKeyId`
- `secretAccessKey`
- `sessionToken`

``` yaml
> If an environment variable is not set then it is assumed the value is the literal value given. For example, if `S3_BUCKET` is not set, then this will use a bucket named exactly "S3_BUCKET".

```yaml
store:
aws-s3-storage:
bucket: S3_BUCKET # If an environment variable named S3_BUCKET is set, it will use that value. Otherwise assumes the bucket is named 'S3_BUCKET'
keyPrefix: S3_KEY_PREFIX # If an environment variable named S3_KEY_PREFIX is set, it will use that value. Otherwise assumes the bucket is named 'S3_KEY_PREFIX'
endpoint: S3_ENDPOINT # If an environment variable named S3_ENDPOINT is set, it will use that value. Otherwise assumes the bucket is named 'S3_ENDPOINT'
...
bucket: S3_BUCKET
keyPrefix: S3_KEY_PREFIX
region: S3_REGION
endpoint: S3_ENDPOINT
accessKeyId: S3_ACCESS_KEY_ID
secretAccessKey: S3_SECRET_ACCESS_KEY
sessionToken: S3_SESSION_TOKEN
```

store properties can be defined for packages. The storage location corresponds to the folder in s3 bucket.
Additional properties can be defined for packages. The `storage` location corresponds to the folder in the S3 bucket.

```
```yaml
packages:
'@scope/*':
access: all
Expand Down

0 comments on commit 64996bd

Please sign in to comment.