npmpackage.info

Gathering detailed insights and metrics for nginx-upstream

Other packages similar to nginx-upstream

nginx-plus-dynamic-upstream

2.2.0

Allows to register/unregister app in Nginx+

nginx-upstream-http-fix

0.1.4

Nginx Config File Manager

upcache

2.8.2

nginx proxy cache key protocols implementations

weboverlay

1.0.2

Layered Hybrid Web Server: local files, upstream proxy and content transform

nginx-upstream

0.1.4

JavaScript

6.15 kB

2,993 1.3

Installations

npm install nginx-upstream

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

4.5.0

NPM Version

4.4.1 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 1 contributors

Languages

JavaScript

JavaScript (100%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

Volem

Download Statistics

Total Downloads

2,993

Last Day

Last Week

Last Month

Last Year

206

GitHub Statistics

6 Stars

63 Commits

4 Forks

4 Watching

1 Branches

1 Contributors

Bundle Size

19.37 kB

Minified

6.15 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

0.1.4

Package Id

nginx-upstream@0.1.4

Size

7.62 kB

NPM Version

4.4.1

Node Version

4.5.0

Total Downloads

Cumulative downloads

Total Downloads

2,993

Last day

Compared to previous day

Last week

-50%

Compared to previous week

Last month

Compared to previous month

Last year

-37%

206

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

bluebird debug eslint nginx-conf secure-callback typescript

Dev Dependencies

eslint istanbul mocha

Versions

nginx-upstream

Currently it is on release v0.1.3 and maintains primary functionality over nginx config file. Usage is pretty simple, you can use it with require to get our main class and use its instance with below constructor parameters.

1npm install nginx-upstream --save

1var NginxManager = require('nginx-upstream');
2var nginxManager = new NginxManager('<path>/nginx.conf', 50);

First of all, let's take a look at the type definition of the package starting from constructor.

1class NginxUpstream {
2    constructor(nginxConfigFilePath: string, fileSyncTime?: number);

As expected our class initializes with the nginx config file path as first parameter. Second parameter is the timeout for waiting changes on config file. Default is 50ms and it is generally ok for nowadays disks.

Nginx requires upstream block for load balancing operations. You can add new backend to your upstream block by addBackend method. Below is the definition of it;

1addBackend(host: string, callback: (err: any) => void);

addBackend method requires the host definition together with the port where the backend application server exits. This host definition can be either like ip:port or like fqdn:port. ie. 123.45.67.89:80 or www.example.com:81

Here port definition is always required even if your backend server is a web server and by default hosts over 80 port, you need to mention this to your Nginx server and our method also requires this port information to set nginx configuration file correctly.

Second parameter is callback, where you need to provide to understand if the configuration set successfully or not. Usage example;

1nginxManager.addBackend('mybackendserver.io:8081', function(err){
2  if(err){
3    console.log(err);
4    return;
5  } else {
6    // Do something after backend server added.
7  }
8});

Another method is of nginx-upstream is toggleBackend, which is for enabling or disabling your backend server. This is realy useful when you want to make maintenance on one of your backend server or something is wrong with it and you want it to be disabled temporarily. Even if you want to remove your backend server than it is wise to disable it first and than remove it.

Below is the definition and usage of toggleBackend;

1// Definition
2toggleBackend(host: string, callback: (err: any, status: boolean) => void);
3
4// Usage
5nginxManager.toggleBackend('localhost:81', function(err, status){
6  if(err){
7    console.log(err);
8    return;
9  } else if(status)
10    // Do something if status enabled.
11  } else {
12    // Do something else if status disabled.
13  }
14});

It is like add backend and it requires the host name together with its port. When you toggle your backend host "localhost:81" of this configuration.

1# Upstream Servers
2upstream nginxconf {
3    server localhost:81;
4    server localhost:82;
5}

the nginx configuration file would be like below;

1# Upstream Servers
2upstream nginxconf {
3    server localhost:81 down;   # Disabled backend
4    server localhost:82;
5}

Ofcourse we have another method for removing the backend server from the nginx configuration file. It goes like below for the same upstream block;

1// Definition
2removeBackend(host: string, callback: (err: any) => void);
3// Usage
4nginxManager.removeBackend('localhost:81', function(err){
5  if(err){
6    console.log(err);
7    return;
8  } else
9    // Do something after backend server removed.
10});

After calling the removeBackend method, upstream block would be;

1# Upstream Servers
2upstream nginxconf {
3    server localhost:82;
4}

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

License

Determines if the project has defined a license.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.3

/10

Last Scanned on 2025-02-03

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More