Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 2.85 KB

development.md

File metadata and controls

65 lines (44 loc) · 2.85 KB

Development Guide

Integrating with AWS Signature

Update the following files when enhancing nginx-s3-gateway to integrate with AWS signature whenever AWS releases a new version of signature or you have a new PR:

Extending the Gateway

Extending gateway configuration via container images

conf.d Directory

On the container image, all files with the extension .conf in the directory /etc/nginx/conf.d will be loaded into the configuration of the base http block within the main NGINX configuration.

This allows for extension of the configuration by adding additional configuration files into the container image extending the base gateway image.

Stub Files

On the container image there are three NGINX configuration stub files:

Each of these files can be overwritten in a container image that inherits from the S3 Gateway container image, so that additional NGINX configuration directives can be inserted into the gateway configuration.

Examples

In the examples/ directory, there are Dockerfile examples that show how to extend the base functionality of the NGINX S3 Gateway by adding additional modules.

Testing

Automated tests require docker, docker-compose, curl, md5sum (or md5 on MacOS), and mc (the minio cli tool) to be installed. To run all unit tests and integration tests, run the following command. If you invoke the test script with a plus parameter, you will need to add your NGINX repository keys to the plus/etc/ssl/nginx directory

$ ./test.sh <nginx type - 'oss', 'latest-njs-oss', 'unprivileged', 'plus', or 'latest-njs-plus'>