optional rate limiter

Author: tobinbradley

README.md

@@ -49,6 +49,7 @@ This is the complete complete list of environmental variables that can be set.
 | CACHE_PRIVACY | No | private | [Cache response directive](https://github.com/fastify/fastify-caching) |
 | CACHE_EXPIRESIN | No | 3600 | [Max age in seconds](https://github.com/fastify/fastify-caching) |
 | CACHE_SERVERCACHE | No | undefined | Max age in seconds for [shared cache](https://github.com/fastify/fastify-caching) (i.e. CDN) |
+| RATE_MAX | No | undefined | Requests per minute rate limiter (limiter not used if RATE_LIMIT not set)  |
 
 
 ### Step 3: fire it up!

index.js

@@ -31,6 +31,14 @@ fastify.register(
 // CORS
 fastify.register(require('@fastify/cors'))
 
+// OPTIONAL RATE LIMITER
+if ("RATE_MAX" in process.env) {
+  fastify.register(import('@fastify/rate-limit'), {
+    max: process.env.RATE_MAX,
+    timeWindow: '1 minute'
+  })
+}
+
 // INITIALIZE SWAGGER
 fastify.register(require('@fastify/swagger'), {
   exposeRoute: true,

package-lock.json

@@ -14,6 +14,7 @@
     "@fastify/compress": "^6.1.0",
     "@fastify/cors": "^8.0.0",
     "@fastify/postgres": "^5.0.0",
+    "@fastify/rate-limit": "^7.0.0",
     "@fastify/swagger": "^7.4.0",
     "dotenv": "^16.0.1",
     "fastify": "^4.1.0",