https://github.com/rouanw/knoxy

A drop-in replacement for (some of) knox that proxies the AWS node client.
https://github.com/rouanw/knoxy

aws knox s3

Last synced: 4 days ago
JSON representation

A drop-in replacement for (some of) knox that proxies the AWS node client.

• Host: GitHub
• URL: https://github.com/rouanw/knoxy
• Owner: rouanw
• Created: 2018-12-14T13:09:52.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-04-09T22:23:28.000Z (over 2 years ago)
• Last Synced: 2023-03-28T21:20:29.785Z (over 1 year ago)
• Topics: aws, knox, s3
• Language: JavaScript
• Homepage:
• Size: 43 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# knoxy

> A drop-in replacement for (some of) [knox](https://github.com/Automattic/knox) that proxies the AWS node client.

## Usage

`npm install knoxy`

Replace `const knox = require('knox');` with `const knox = require('knoxy');`.

Then take a look at the [knox docs](https://github.com/Automattic/knox).

## Why?

`knox` is a useful library, but is not currently [actively maintained](https://github.com/Automattic/knox/issues/308). This means it has a [security vulnerability](https://github.com/Automattic/knox/pull/321) and some other issues.

If you're starting a new project that needs to do things with Amazon S3, I recommend you use the [official AWS node client](https://www.npmjs.com/package/aws-sdk).

If you've got an existing codebase that relies on `knox`, though, this library may be useful. Please note that I've only implemented those bits of `knox` I need (4 methods in total), but feel free to open a PR with what you need.

## Contributing

PRs welcome. To run the tests, you need to create a `.auth.json` file in the root of the project that looks something like:

```json

{

  "key": "MyAWSKey",

  "secret": "SoSecret!",

  "bucket": "a-bucket",

  "region": "eu-west-1"

}

```

## License

MIT