CODEWITHSUNDEEP
google-app-enginenginxdocusaurus
user2136644
user2136644

Reputation: 31

Hosting Docusaurus v2 using Nginx

I'm attempting to use nginx as the reverse proxy to host Docusaurus v2 on Google AppEngine. GooglAppEngine has HTTPS turned on. And Nginx listens on port 8080. Hence by default all requests are over HTTPS and the connections managed by Google AppEngine.

However, I'm having an issue when users perform the following actions :

The user is getting directed to port 8080 and not the https site of docusaurus.

Without refreshing the page, the user is able to successfully navigate the site. It's when the user hits a refresh button that they get the redirect. Looking at the header information, I see the response pointing them to port 8080 but I'm not sure why that is happening.

Wondering if anyone has successfully been able to set up Docusaurus v2 with nginx ?

My config for nginx is as follow :

events {
    worker_connections 768;
}

http {
    sendfile on;
    tcp_nopush on;
    tcp_nodelay on;
    keepalive_timeout 65;
    types_hash_max_size 2048;
    include /etc/nginx/mime.types;
    default_type application/octet-stream;

    # Logs will appear on the Google Developer's Console when logged to this
    # directory.
    access_log /var/log/app_engine/app.log;
    error_log /var/log/app_engine/app.log;

    gzip on;
    gzip_disable "msie6";

    server {
        # Google App Engine expects the runtime to serve HTTP traffic from
        # port 8080.
        listen 8080;
        root /usr/share/nginx/www;
        index index.html index.htm;
        location / {
        if ($http_x_forwarded_proto = "http") {
        return 301 https://$server_name$request_uri;
            }
        }
        


    }

Upvotes: 3

Views: 4882

Answers (3)

Chu-Siang Lai
Chu-Siang Lai

Reputation: 2728

Thanks @user3504169, it's working for me in port forwarding case.

I run the Docusaurus with npm and 3001 port, then use Nginx to port forwarding it.

server {
    listen 80 default_server;
    listen [::]:80 default_server;
    root /var/www/html;
    server_name _;
    location / {
        try_files $uri $uri/ =404;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $host;
        proxy_pass http://localhost:3001;
        port_in_redirect off;
    }
}

My ENV.

user@ubuntu2204:~$ nginx -V
nginx version: nginx/1.18.0 (Ubuntu)
built with OpenSSL 3.0.2 15 Mar 2022

Upvotes: 0

angordeyev
angordeyev

Reputation: 869

To solve "go to documentations (any page)" and "refresh the page" problems you can use:

location / {
    ...
    try_files $uri /index.html;
    ...
}

Upvotes: 0

user3504169
user3504169

Reputation: 51

This is probably due to the docusaurus website linking to directories without trailing slash /, causing a redirect which is setup to include the port by default.

Looking into the docusaurus build directory you will see that your pages are defined as folders containing index.html files. Without the / the server needs to redirect you to {page}/index.html.

Try to call the URL with / and no port, which should be successful:

https://{host}/docs/{page}/

Therefore fixing the problem, you could try to change the redirect rules to not include the port with the port_in_redirect parameter:

server {
    listen 8080;
    port_in_redirect off;
    
    # More configuration
    ...
}

See the documentation for more details.

Upvotes: 5

Related Questions