Skip to content

Commit 47a54a9

Browse files
committed
docs: directory structure and file description
1 parent b684810 commit 47a54a9

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,34 @@ NGINX AWS Signature Library to authenticate AWS services such as S3 and Lambda v
88

99
![](./docs/img/nginx-aws-signature-flow.png)
1010

11+
## Directory Structure and File Descriptions
12+
13+
```
14+
nginx-aws-signature
15+
16+
├── core
17+
│ ├── awscredentials.js common lib to read and write AWS credentials
18+
│ ├── awssig2.js common lib to build AWS signature v2
19+
│ ├── awssig4.js common lib to build AWS signature v4
20+
│ │ :
21+
│ │ add new lib when AWS releases new signature ver.
22+
│ │ :
23+
│ └── utils.js common lib to be reused by all NJS codebase
24+
25+
├── tests
26+
│ ├── docker
27+
│ │ ├── build_text Docker environments for testing NJS codebases
28+
│ │ │ ├── nginx NGINX config files for testing NJS codebases
29+
│ │ │ └── ssl NGINX Plus license files when testing lib on NGINX Plus
30+
│ │ ├── Dockerfile.oss for testing AWS signaure lib on NGINX OSS
31+
│ │ ├── Dockerfile.plus for testing AWS signaure lib on NGINX Plus
32+
│ │ └── docker-compose.yml to build and run a container for testing AWS signaure lib
33+
│ ├── unit-test contains automated tests for validang that the lib works
34+
│ └── test.sh test launcher
35+
36+
└── Makefile automate to build/start/stop testing environment
37+
```
38+
1139
## How to Use
1240

1341
TBD

0 commit comments

Comments
 (0)