How to proxy web apps using nginx?

nginxproxy.md

Virtual Hosts on nginx (CSC309)

When hosting our web applications, we often have one public IP address (i.e., an IP address visible to the outside world) using which we want to host multiple web apps. For example, one may wants to host three different web apps respectively for example1.com, example2.com, and example1.com/images on the same machine using a single IP address.

How can we do that? Well, the good news is Internet browsers send the domain name inside HTTP requests and all we need to do is to parse the requested domain name and URL and then route the HTTP request to the actual web server.

Oh, do I really need to parse HTTP requests? You can if you really want to, but there are lots of tools and technologies that readily do this for you. In this tutorial, we walk you through how you can use nginx to proxy multiple web applications.

Install nginx

CDF @UofT

We have prepared pre-copmiled binaries for your. You need to download nginx.tar.gz and uncompress it:

$ wget http://www.cs.toronto.edu/~soheil/csc309/nginx.tar.gz && tar -xvzf nginx.tar.gz

• It creates an nginx directory for you. The config file is in nginx/conf/nginx.conf.
• We have provided a script named nginx in the directory. To run nginx, go to the nginx directory (cd nginx) and run ./nginx ....

Ubuntu

Install nginx using apt-get:

$ sudo apt-get install nginx

Notes:

• The part of the nginx's config file we need resides in /etc/nginx/sites-enabled/default.
• To edit the config file or run nginx, you need to use sudo.

Mac OS

Install homebrew, and then install nginx using brew:

$ brew install nginx

Notes:

• nginx's config file is in /usr/local/etc/nginx/nginx.conf.
• To edit the config file or run nginx, you need to use sudo: sudo nano /usr/local/etc/nginx/nginx.conf and sudo nginx ...

Configuration

Step 1 -- Booting Servers for Virtual Hosts

Write three different node applications running on different ports (say 8080, 8181, 8282) on your machine.

Step 2 -- Configure nginx's Port

To do so, you need to edit your nginx config file.

In the config file, find the server section:

server {
    listen       80;
    ...
    location / {
       ...
    }
    ...
}

If you're using CDF, make sure you change 80 to a vacant port number (ask for one from your instructor). If not, you can keep using 80 or change the port if you will.

Test nginx

1. Run ./nginx on CDF, or run sudo nginx on your local machine.
2. Open the browser and log on to localhost:$PORT (replace $PORT with the port number you configured for nginx).

Step 3 -- Configure /

Let say we want to configure nginx to route requests for /, /blog, and /mail, respectively onto localhost:8080, localhost:8181, and localhost:8282.

                  +--- host --------> node.js on localhost:8080
                  |
users --> nginx --|--- host/blog ---> node.js on localhost:8181
                  |
                  +--- host/mail ---> node.js on localhost:8282

To route /, you need to edit your nginx config file.

In the config file, find the server section:

server {
    listen       80;
    ...
    location / {
       ...
    }
    ...
}

This section is simply telling nginx how it should serve HTTP requests.

Now, change the location section to this snippet:

server {
    listen       ...;
    ...
    location / {
        proxy_pass http://127.0.0.1:8080;
    }
    ...
}

proxy_pass simply tells nginx to forward requests to / to the server listening on http://127.0.0.1:8080.

Step 4 -- Reload nginx's Configuration

To reload nginx's configuration run: nginx -s reload on your machine.

Referesh your browser. Do you see the output from your node.js application? If yes, you are all set. If no, there is a problem with your config.

Step 5 -- Add /blog and /mail

To redirect /mail and /blog, you simply need to add new entries the location section in the config file:

server {
    listen       ...;
    ...
    location / {
        proxy_pass http://127.0.0.1:8080;
    }
    
    location /blog {
        proxy_pass http://127.0.0.1:8181;
    }

    location /mail {
        proxy_pass http://127.0.0.1:8282;
    }
    ...
}

Step 6 -- Reload Your nginx Configuration

Run nginx -s reload on your machine.

Log onto localhost:$PORT/blog in your browser. Do you see the output from your second node.js application?

Then log onto localhost:$PORT/mail. Do you see the output from your third node.js application?

If yes & yes, you are all set. If no, there is a problem with your config.

Step 7 -- Rewriting Requests

Now as you might have noticed in Step 6, nginx sends the same HTTP request to your node.js web apps which results into a 404 error. Why? Because, your node.js web application serves requests from / not from /blog and /mail. But, nginx is sending requests to /blog and /mail.

To fix this issue, we need rewrite the URL so that it matches the URL you can serve on your node.js applications.

To correctly rewrite URLs change your config file to match the following snippet:

server {
    listen       ...;
    ...
    location / {
        proxy_pass http://127.0.0.1:8080;
    }
    
    location /blog {
        rewrite ^/blog(.*) /$1 break;
        proxy_pass http://127.0.0.1:8181;
    }

    location /mail {
        rewrite ^/mail(.*) /$1 break;
        proxy_pass http://127.0.0.1:8282;
    }
    ...
}

This rewrite commands are simple regular expressions that transform strings like /blogWHAT_EVER and /mailWHAT_EVER to /WHAT_EVER in the HTTP requests.

Step 8 -- Reload and Test.

All set?

Exercise 1

Configure your nginx to redirect URLs from /google to http://www.google.com

Step 9 (optional) -- Redirecting Based on Host Name

Let say you want to host example1.com, example2.com, and example3.com on your machine, respectively to localhost:8080, localhost:8181, and localhost:8282.

Note: Since you don't have access to a DNS server, you should add domain name entries to your /etc/hosts (you can't do this on CDF machines):

...
127.0.0.1 example1.com example2.com example3.com
...

To proxy eaxmple1.com we can't use the location part of the default server. Instead we need to add another server section with a server_name set to our virtual host (e.g., example1.com, ...), and then a simple location section that tells nginx how to proxy the requests:

server {
    listen       80;
    server_name  example1.com;

    location / {
        proxy_pass http://127.0.0.1:8080;
    }
}

server {
    listen       80;
    server_name  example2.com;

    location / {
        proxy_pass http://127.0.0.1:8181;
    }
}

server {
    listen       80;
    server_name  example3.com;

    location / {
        proxy_pass http://127.0.0.1:8282;
    }
}

Simple, ha?!

Thank you!

Not sure if it was mentioned but your above server configuration example only works if you want to have /blog and /mail ALSO as part of the URLs in localhost:8181 and localhost:8282 because after proxy_pass you have no URI given and then the whole request matching location will be just APPENDED. I took some time to figure this out.

If instead localhost:8181/ or localhost:8282/ should be the base URLs, you need to add trailing slashes to both proxy_pass directives which effectively add a URI and THEN also add trailing slashes to the location directives (only changing the first but not second place lets you end up with double slashes).

So, for me, this makes much more sense:

server {
    listen       ...;
    ...
    location / {
        proxy_pass http://127.0.0.1:8080/;
    }
    
    location /blog/ {
        proxy_pass http://127.0.0.1:8181/;
    }

    location /mail/ {
        proxy_pass http://127.0.0.1:8282/;
    }
    ...
}

See also http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_pass which talks about the difference between stating a URI after proxy_pass and not stating one (URI means stating anything AFTER the port)

Hello there,
I have a very similar setup to your example but I do not get the same results.

For reference, my application is serving on port 3000 and my configuration file is the following (located in /etc/nginx/sites-enabled)

 server {
      server_name example.com;
      client_max_body_size 100M;

      ssl on;
      ssl_certificate /home/domain-certs/example.crt;
      ssl_certificate_key /home/domain-certs/example.key;

      location / {
              proxy_pass https://127.0.0.1:3000/;
      }

  listen 80;
}

If I go to https://example.com I do not get the result (but err_connection_refused). Yet if I add the port to the uri https://example.com:3000 I get served the correct results. What am I doing wrong here? For reference I also added 127.0.0.1 example.com at /etc/hosts.

Thank you.

very helpful.

thanks u dude

does anyone know how can i have a location forward what ever port i put on the client's url?

something like:

server {
 ...
      location /game {
              proxy_pass https://127.0.0.1:$PORT/;
      }
}

Dear Team ,

I need a support Multiple 80 port URL request to redirect to local machine different multiple ports .

I will enter https://example.com1 and https://exampke.com2

Kindly help to redirect config in nginx Ubuntu ??

Dear Team ,

I need a support Multiple 80 port URL request to redirect to local machine different multiple ports .

I will enter https://example.com1 and https://exampke.com2

Kindly help to redirect config in nginx Ubuntu ??

The server_name variable can take multiple values separated by space eg. www.example.com www.example2.com and the same server will handle them both.

Thank You lot its working

Dear Team,
How to redirect URL to another server IP address in nginx .

Hello, I need to have a configuration where,
https://domain.com/api/a
https://domain.com/api/a/b
https://domain.com/api/a/b/x
https://domain.com/api/a/b/x/...

Any suggestions?

@soheilhy can you help on the same?https://stackoverflow.com/q/75460041/21219202

Thanks a lot

Hi @railsfactory-suriya in my case my angular app deployed on www.test.com/ui so in location tag we need to add location /ui it's correct or wrong can you confirm Me regarding this one?