{"id":13789097,"url":"https://github.com/nginxinc/nginx-s3-gateway","last_synced_at":"2025-03-31T00:07:55.101Z","repository":{"id":39788749,"uuid":"296727267","full_name":"nginxinc/nginx-s3-gateway","owner":"nginxinc","description":"NGINX S3 Gateway","archived":false,"fork":false,"pushed_at":"2025-03-17T12:30:52.000Z","size":1536,"stargazers_count":577,"open_issues_count":44,"forks_count":140,"subscribers_count":17,"default_branch":"main","last_synced_at":"2025-03-23T23:14:21.484Z","etag":null,"topics":["docker","gateway","nginx","s3"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nginxinc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":"SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-09-18T20:50:37.000Z","updated_at":"2025-03-23T14:50:25.000Z","dependencies_parsed_at":"2023-10-03T08:09:51.809Z","dependency_job_id":"b248a04d-ea97-4701-bd6c-28136a2bbf4e","html_url":"https://github.com/nginxinc/nginx-s3-gateway","commit_stats":{"total_commits":345,"total_committers":40,"mean_commits":8.625,"dds":0.5246376811594202,"last_synced_commit":"33138ced761913b9f9a7867fc09f00e2142e4f44"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nginxinc%2Fnginx-s3-gateway","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nginxinc%2Fnginx-s3-gateway/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nginxinc%2Fnginx-s3-gateway/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nginxinc%2Fnginx-s3-gateway/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nginxinc","download_url":"https://codeload.github.com/nginxinc/nginx-s3-gateway/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246395595,"owners_count":20770243,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","gateway","nginx","s3"],"created_at":"2024-08-03T21:00:58.512Z","updated_at":"2025-03-31T00:07:55.085Z","avatar_url":"https://github.com/nginxinc.png","language":"JavaScript","funding_links":[],"categories":["Njs Projects"],"sub_categories":["Lua Modules"],"readme":"[![NGINX S3 Gateway CI/CD](https://github.com/nginxinc/nginx-s3-gateway/actions/workflows/s3-gateway.yml/badge.svg)](https://github.com/nginxinc/nginx-s3-gateway/actions/workflows/s3-gateway.yml)\n[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/nginxinc/nginx-s3-gateway/badge)](https://securityscorecards.dev/viewer/?uri=github.com/nginxinc/nginx-s3-gateway)\n[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)\n[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](/SUPPORT.md)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](/CODE_OF_CONDUCT.md)\n\n# NGINX S3 Gateway\n\n## Introduction\n\nThis project provides a working configuration of NGINX configured to act as\nan authenticating and caching gateway for to AWS S3 or another S3 compatible\nservice. This allows you to proxy a private S3 bucket without requiring users\nto authenticate to it. Within the proxy layer, additional functionality can be\nconfigured such as:\n\n * Listing the contents of a S3 bucket\n * Providing an authentication gateway using an alternative authentication\n   system to S3\n * Caching frequently accessed S3 objects for lower latency delivery and\n   protection against S3 outages\n * For internal/micro services that can't authenticate against the S3 API\n   (e.g. don't have libraries available) the gateway can provide a means\n   to accessing S3 objects without authentication\n * Compressing objects ([gzip](examples/gzip-compression), [brotli](examples/brotli-compression)) from gateway to end user\n * Protecting S3 bucket from arbitrary public access and traversal\n * Rate limiting S3 objects\n * Protecting a S3 bucket with a [WAF](examples/modsecurity)\n * Serving static assets from a S3 bucket alongside a dynamic application\n   endpoints all in a single RESTful directory structure\n\nAll such functionality can be enabled within a standard NGINX configuration\nbecause this project is nothing other than NGINX with additional configuration\nthat allows for proxying S3. It can be used as-is if the predefined\nconfiguration is sufficient, or it can serve as a base example for a more\ncustomized configuration.\n\nIf the predefined configuration does not meet your needs, it is best to borrow\nfrom the patterns in this project and build your own configuration. For example,\nif you want to enable SSL/TLS and compression in your NGINX S3 gateway\nconfiguration, you will need to look at other documentation because this\nproject does not enable those features of NGINX.\n\n## Usage\n\nThis project can be run as a stand-alone container or as a Systemd service.\nBoth modes use the same NGINX configuration and are functionally equal in terms\nfeatures. However, in the case of running as a Systemd service, other services\ncan be configured that additional functionality such as [certbot](https://certbot.eff.org/)\nfor [Let's Encrypt](https://letsencrypt.org/) support.\n\n## Getting Started\n\nRefer to the [Getting Started Guide](docs/getting_started.md) for how to build\nand run the gateway.\n\n## Directory Structure and File Descriptions\n\n```\ncommon/                          contains files used by both NGINX OSS and Plus configurations\n  etc/nginx/include/\n    awscredentials.js            common library to read and write credentials\n    awssig2.js                   common library to build AWS signature 2\n    awssig4.js                   common library to build AWS signature 4 and get a session token\n    s3gateway.js                 common library to integrate the s3 storage from NGINX OSS and Plus\n    utils.js                     common library to be reused by all of NJS codebases\ndeployments/                     contains files used for deployment technologies such as\n                                 CloudFormation\ndocs/                            contains documentation about the project\nexamples/                        contains additional `Dockerfile` examples that extend the base\n                                 configuration\njsdoc                            JSDoc configuration files\noss/                             contains files used solely in NGINX OSS configurations\nplus/                            contains files used solely in NGINX Plus configurations\ntest/                            contains automated tests for validang that the examples work\nDockerfile.oss                   Dockerfile that configures NGINX OSS to act as a S3 gateway\nDockerfile.plus                  Dockerfile that builds a NGINX Plus instance that is configured\n                                 equivelently to NGINX OSS - instance is configured to act as a\n                                 S3 gateway with NGINX Plus additional features enabled\nDockerfile.buildkit.plus         Dockerfile with the same configuration as Dockerfile.plus, but\n                                 with support for hiding secrets using Docker's Buildkit\nDockerfile.latest-njs            Dockerfile that inherits from the last build of the gateway and\n                                 then builds and installs the latest version of njs from source\nDockerfile.unprivileged          Dockerfiles that inherits from the last build of the gateway and\n                                 makes the necessary modifications to allow running the container\n                                 as a non root, unprivileged user.\npackage.json                     Node.js package file used only for generating JSDoc\nsettings.example                 Docker env file example\nstandalone_ubuntu_oss_install.sh install script that will install the gateway as a Systemd service\ntest.sh                          test launcher\n```\n\n## Development\n\nRefer to the [Development Guide](docs/development.md) for more information about\nextending or testing the gateway.\n\n## Contributing\n\nPlease see the [contributing guide](/CONTRIBUTING.md) for guidelines on how to best contribute to this project.\n\n## License\n\n[Apache License, Version 2.0](/LICENSE)\n\n\u0026copy; [F5, Inc.](https://www.f5.com/) 2020 - 2024\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnginxinc%2Fnginx-s3-gateway","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnginxinc%2Fnginx-s3-gateway","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnginxinc%2Fnginx-s3-gateway/lists"}