nodejs-redirect

Simple redirect service

Option 1 - Install from npm and run the redirection service

First, install nodejs-redirect using npm or yarn

npm install --global nodejs-redirect
# or using yarn 
yarn global add nodejs-redirect

Run nodejs-redirect and set your environment variables:

REDIRECTION_URL=https://google.com nodejs-redirect

Option 2 - Install from source as an application

First, clone the project from github and install the node modules:

git clone https://github.com/sharvit/nodejs-redirect.git
cd nodejs-redirect
yarn

Run npm start and set your environment variables:

REDIRECTION_URL=https://google.com npm start

Available environment variables

Variable	Description	Default Value
REDIRECTION_URL	URl to redirect requests	https://google.com
CHAIN_REQUEST_URL	Will chain the request path to the redirect url.	false
PORT	Port to run the service	3000

Option 3 - Use as a library

import { RedirectServer } from 'nodejs-redirect';
 
const to = 'https://google.com';
const chain = true;
const port = 3000;
 
// create the redirection server
const server = new RedirectServer(to, chain);
 
// start listening
server.listen(port);
 
// Render some console log output
console.log('Redirection server listening on port: ' + port);
console.log('Redirecting all requests to: ' + to);
console.log('Chaining requests url is: ' + (chain ? 'on' : 'off'));

Option 4 - Use as an express middleware

import express from 'express';
import { createRedirectMiddleware } from 'nodejs-redirect'
 
const to = 'https://google.com';
const chain = true;
const port = 3000;
 
// create an express server
const server = express();
 
// create the redirection middleware
const redirectionMiddleware = createRedirectMiddleware({ to, chain });
 
// setup the redirection middleware on all requests
server.get('*', redirectionMiddleware);
 
// start listening
server.listen(port);
 
// Render some console log output
console.log('Redirection server listening on port: ' + port);
console.log('Redirecting all requests to: ' + to);
console.log('Chaining requests url is: ' + (chain ? 'on' : 'off'));

License

MIT © Avi Sharvit