Skip to main content

Hosting a single page app with Nginx without 404 errors

 If you write a single-page app where the routing is handled on its own, it works perfectly on your local host with the dev server.

For an instance, if there is a route in your app for login such as "/login", if you try this in the localhost it will work without any issues. 

Single page app routing

If you host this with an Nginx server as a static web app, using the direct route in the URL will end up with 404.


Nginx 404
There is an easy fix for this updating the Nginx configurations. 
Nginx default static site configuration is located in "/etc/nginx/conf.d/default.conf". This may differ based on your installation and OS. However, the configurations are pretty much the same.

You can add the following line to the configuration 

try_files $uri $uri/ /index.html?q=$uri&$args;

This makes the Nginx look for files in the file path, and if found then serve it. Or else, route the request to the index.html. 

In our example, it will look for a file called login in the static directory, since we don't have such a file it will route the request to the index.html, then handle the routing after that is up to the single page app.

This allows the single-page app to load its actual static files such as images, CSS, and js. If there are no such files, it will route the request to the index.html.


location / {
    root /usr/share/nginx/html;
    try_files $uri $uri/ /index.html?q=$uri&$args;
    index index.html index.htm; }


Edit the configuration as above and reload the Nginx configuration as below.

sudo service nginx reload

Once this is done, the single-page app's routing should work even if you type in the URL and hit enter.

nginx static single-page routing



This solution is based on the Front Controller Pattern configuration for Nginx.

Comments

  1. Thank you! Such a quick solution. I thought I'd spend a while trying to figure out the fix.

    ReplyDelete

Post a Comment

Popular posts from this blog

VLC skins

It's been a while from my first blog post, so today I thought to make a blog post about skins in VLC player. I think you all are familiar with VLC player if not, here's the link for the website www.videolan.org/vlc/index.htm l In brief, VLC player is a free and opensource player that can play almost all the types of media formats. Even though it is a such a nice player, it looks kind of old and rusty, like the windows classic look. But you can make it prettier by just adding some new skins to it.  You can download skins for the player from here http://www.videolan.org/vlc/skins.php Then place the downloaded skin file (.vlt file) in the " skin " folder in the installation directory.           eg:- in windows:    C:\Program Files\VideoLAN\VLC\skins           or in linux systems:  ~/.local/share/vlc/skins Then, open the VLC player and go to the preferences. ...

How to set terminal title in Ubuntu 18.04 LTS

In older Ubuntu versions, you could have just right-clicked on the Ubuntu Terminal window's title bar and set any title you would like. But unfortunately after Ubuntu 18.04 LTS this feature is gone. I used to love this feature because I'm multiple tabs in the single terminal window kind of a guy. I usually like to work in multiple named terminal tabs like below. By default, in newer Ubuntu version, it is showing just the current directory. Let's see how we can do this. Ubuntu prompt In ubuntu's Bash, there's an environment variable $PS1 which is responsible for the details that the command line prompts. You'll be able to echo this and see what's inside it. If I echo it it will print something like this. echo $PS1 \[\e]0;\u@\h: \w\a\]${debian_chroot:+($debian_chroot)}\[\033[01;32m\]\u@\h\[\033[00m\]:\[\033[01;34m\]\w\[\033[00m\]\$ If you really want to understand what this means, you can refer this page .  Updating the termina...

Java, how to create a list with a single element

 I wanted to create a Java List with a single element. Yet, I wanted to add more elements later. So, I was looking for a couple of ways to do this. So far there are multiple elegant ways to create a list with a single element with a one-liner. Not so much for a modifiable list though. Here's what I gathered so far. Followings are a few ways of creating a list with strictly a single entry. Can't add more elements. 1. Collections.singletonList() This returns an immutable list that cannot be modified or add more elements. // An immutable list containing only the specified object. List<String> oneEntryList = Collections. singletonList ( "one" ) ; oneEntryList.add( "two" ) ; // throws UnsupportedOperationException 2.  Arrays.asList() This returns a fixed-size list consisting of the number of elements provided as arguments. The number of elements provided would be an array hence the size is fixed to the length of the array. // Returns a fixed-size list List...