1
1
# node-vault
2
2
3
- [ ![ Build Status] ( https://img.shields.io/github/checks-status/kr1sp1n /node-vault/master.svg?style=flat-square )] ( https://github.com/nodevault/node-vault/actions?query=branch%3Amaster )
3
+ [ ![ Build Status] ( https://img.shields.io/github/checks-status/nodevault /node-vault/master.svg?style=flat-square )] ( https://github.com/nodevault/node-vault/actions?query=branch%3Amaster )
4
4
[ ![ Coverage Status] ( https://img.shields.io/codecov/c/github/nodevault/node-vault/master.svg?style=flat-square )] ( https://app.codecov.io/gh/nodevault/node-vault/tree/master )
5
5
[ ![ Download Status] ( https://img.shields.io/npm/dm/node-vault.svg?style=flat-square )] ( https://www.npmjs.com/package/node-vault )
6
6
[ ![ test] ( https://img.shields.io/npm/v/node-vault?style=flat-square )] ( https://www.npmjs.com/package/node-vault )
@@ -11,20 +11,24 @@ A client for the HTTP API of HashiCorp's [Vault] written for Node.js.
11
11
12
12
13
13
## Install
14
- make sure to use node.js version >= 6
14
+ Prerequisites:
15
+ - NodeJS >= ` 16.0.0 `
15
16
16
- npm install node-vault
17
-
18
-
19
- ## Test
17
+ ``` bash
18
+ npm install -S node-vault
19
+ ```
20
20
21
- Run tests inside docker to do also nice integration testing:
21
+ > The year is 2023; If, for whatever reason, you need to use an older version of node.js (yet still ` >= 6.x ` ), use ` node-vault <= v0.10.0 `
22
+ >
23
+ > Please note that ` node-vault <= v0.10.0 ` contains multiple vulnerabilities ☠️
22
24
23
- docker-compose up --force-recreate test
24
25
25
- This will create containers for vault, postgres and running the tests inside
26
- docker.
26
+ ## Test
27
27
28
+ Run tests using docker-compose (includes vault, postgres and running the tests inside) with:
29
+ ``` bash
30
+ docker-compose up --force-recreate test
31
+ ```
28
32
29
33
## Usage
30
34
@@ -34,7 +38,7 @@ docker.
34
38
var options = {
35
39
apiVersion: ' v1' , // default
36
40
endpoint: ' http://127.0.0.1:8200' , // default
37
- token: ' 1234 ' // optional client token; can be fetched after valid initialization of the server
41
+ token: ' MY_TOKEN ' // optional client token; can be fetched after valid initialization of the server
38
42
};
39
43
40
44
// get new instance of the client
@@ -72,7 +76,7 @@ Instead of installing all the dependencies like vault itself, postgres and other
72
76
use [ docker] and [ docker-compose] to link and run multiple docker containers with all of its dependencies.
73
77
74
78
``` bash
75
- git clone
[email protected] :
kr1sp1n /node-vault.git
79
+ git clone
[email protected] :
nodevault /node-vault.git
76
80
cd node-vault
77
81
docker-compose up vault
78
82
```
@@ -116,11 +120,11 @@ const vault = require('node-vault')(options);
116
120
117
121
[ ![ Backers] ( https://opencollective.com/node-vault/tiers/backers.svg?avatarHeight=80&width=600 )] ( https://opencollective.com/node-vault/contribute )
118
122
119
- [ examples ] : https://github.com/kr1sp1n /node-vault/tree/master/example
120
- [ docker-compose.yml ] : https://github.com/kr1sp1n /node-vault/tree/master/docker-compose.yml
123
+ [ examples ] : https://github.com/nodevault /node-vault/tree/master/example
124
+ [ docker-compose.yml ] : https://github.com/nodevault /node-vault/tree/master/docker-compose.yml
121
125
[ Vault ] : https://vaultproject.io/
122
126
[ docker-compose ] : https://www.docker.com/docker-compose
123
127
[ docker ] : http://docs.docker.com/
124
128
[ docker toolbox ] : https://www.docker.com/toolbox
125
129
[ docco ] : http://jashkenas.github.io/docco
126
- [ feature list ] : https://github.com/kr1sp1n /node-vault/tree/master/features.md
130
+ [ feature list ] : https://github.com/nodevault /node-vault/tree/master/features.md
0 commit comments