rendfinity-node
v1.0.2
Published
Node Express Middleware for Rendfinity Rendering Service
Downloads
1
Readme
Rendfinity-Node
Rendfinity-node is a middleware for Express.js that redirects incoming requests to the Rendfinity Sever based on certain conditions.
Installation:
To install this middleware, use npm:
npm install rendfinity-node
Or use yarn:
yarn add rendfinity-node
Usage:
- Require the middleware in your Express application:
const express = require('express');
const rendfinityNode = require('rendfinity-node');
const app = express();
- Set up the logger middleware with a custom token and lists of approved and blocked URLs:
const customToken = 'CUSTOM_TOKEN';
const approvedUrls = ['/home', '/about', '/contact']; // Add approved URLs here
const blockedUrls = ['/admin', '/secret']; // Add blocked URLs here
app.use(rendfinityNode(customToken, approvedUrls, blockedUrls));
- Define your routes and other middleware as needed:
app.get('/', (req, res) => {
res.send('Hello, World!');
});
- Start your server:
const PORT = 3000;
app.listen(PORT, () => {
console.log('Server is running on port ' + PORT);
});
Configuration:
rendfinityNode(token, approvedUrls, blockedUrls)
token: Optional. A custom token string that will be included in the log message. Default value is 'DEFAULT_TOKEN'.
approvedUrls: Optional. An array of strings containing the approved URLs. Requests with URLs matching any of the approved URLs will be qualified for logging.
blockedUrls: Optional. An array of strings containing the blocked URLs. Requests with URLs matching any of the blocked URLs will be skipped from logging, even if they don't match common resource extensions.
Reverse Proxies
If you are serving your NodeJS application via a reverse proxy like Nginx, but not serving it from the base route of your domain (ie, https://example.com/) and instead are serving it from a different location (ie, https://example.com/site/), it is necessary to include 3 additional headers in your Nginx configuration for that location:
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Forwarded-Host $host;
proxy_set_header X-Forwarded-URI $request_uri;
Example:
const express = require('express');
const loggerMiddleware = require('express-logger-middleware');
const app = express();
const customToken = 'SECRET_TOKEN';
const approvedUrls = ['/home', '/about', '/contact'];
const blockedUrls = ['/admin', '/secret'];
app.use(loggerMiddleware(customToken, approvedUrls, blockedUrls));
app.get('/', (req, res) => {
res.send('Hello, World!');
});
const PORT = 3000;
app.listen(PORT, () => {
console.log('Server is running on port ' + PORT);
});
License:
This project is licensed under the MIT License - see the LICENSE file for details.