Skip to content
/ knoxy Public

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

Notifications You must be signed in to change notification settings

rouanw/knoxy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

knoxy

A drop-in replacement for (some of) 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.

Why?

knox is a useful library, but is not currently actively maintained. This means it has a security vulnerability 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.

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:

{
  "key": "MyAWSKey",
  "secret": "SoSecret!",
  "bucket": "a-bucket",
  "region": "eu-west-1"
}

License

MIT

About

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

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published