Nginx server

Nginx is an open-source web server.
To know more, visit the Nginx documentation

To set up a subfolder/subdirectory

1. Add the following location blocks in your Nginx configuration file (/etc/nginx/default).

location /docs {
    proxy_pass https://example.document360.io/docs;
    proxy_set_header Host example.document360.io;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header "requested-by" "proxy";
}

2. Restart the Nginx web server

For example, If you are using Nginx on Linux, then use the command
$ sudo systemctl restart nginx

To setup on other than '/docs' path

You can also set up your knowledge base on subdirectory paths other than /docs.

For example, /help, /support, etc.

When setting up other paths, add the languages associated with each version.

A few more lines need to be added to achieve this. Restart the server once done.

location /help {
    proxy_pass https://example.document360.io/docs;
    proxy_set_header Host example.document360.io;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header "requested-by" "proxy";

    sub_filter "v1/docs/" "v1/help/";
    sub_filter "docs/he/" "/help/he";
    sub_filter "/docs/" "/help/";
    sub_filter_once off;
}

2. Restart the Nginx web server

For example, If you are using Nginx on Linux, then use the command
$ sudo systemctl restart nginx

To enable version(s) dropdown

If you want to enable the version dropdown navigation for your project when you host in a custom subdirectory and path, add the following codes for each of the versions available in your project.

location /v2/help {
    proxy_pass https://example.document360.io/v2/docs;
    proxy_set_header Host example.document360.io;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header "requested-by" "proxy";

    sub_filter "v2/docs/" "v2/help/";
    sub_filter "docs/he/" "/help/he";
    sub_filter "/docs/" "/help/";
    sub_filter_once off;
}
-----------------------------------------------------
location /v1/help {
    proxy_pass https://example.document360.io/v1/docs;
    proxy_set_header Host example.document360.io;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header "requested-by" "proxy";

    sub_filter "v1/docs/" "v1/help/";
    sub_filter "docs/he/" "/help/he";
    sub_filter "/docs/" "/help/";
    sub_filter_once off;
}
-----------------------------------------------------
location = /v2/docs {
    return 301 /v2/help;
}
-----------------------------------------------------
location = /v1/docs {
    return 301 /v1/help;
}

2. Restart the Nginx web server

For example, If you are using Nginx on Linux, then use the command
$ sudo systemctl restart nginx

Helpful Links:

Here are few external links which may help you in understanding the Nginx server location blocks in detail:

• NGINX Docs: Configuring NGINX and NGINX Plus as a Web Server
  
  
• DigitalOcean: Understanding Nginx Server and Location Block Selection Algorithms

Sitemap generation

location /sitemap.xml.en {
proxy_pass https://example.document360.io/sitemap.xml.en;
proxy_set_header Host example.document360.io;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header "requested-by" "proxy";

Home page hosted on a subfolder

To host your project's home page on a custom subdirectory/subfolder path, add the following codes for each of the home page versions available in your project.

location =/v1 {
proxy_pass https://example.document360.io/;
proxy_set_header Host example.document360.io;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header "requested-by" "proxy";
}
location =/v2 {
proxy_pass https://example.document360.io/;
proxy_set_header Host example.document360.io;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header "requested-by" "proxy";
}
location /v1/en {
  return 301 /v1;
}
location /v2/en {
  return 301 /v2;
}

2. Restart the Nginx web server

For example, If you are using Nginx on Linux, then use the command
$ sudo systemctl restart nginx

What happens next?

Once you have successfully configured the web server, your knowledge base site is now live on your custom subfolder/subdirectory. However, the existing URL for your project will serve the requests.

For example, example.document360.io and example.com/docs (if /docs is your folder path) will point to the knowledge base site.

This may cause duplicate content in search engines (Google, Bing, etc.). To prevent this - a redirect from Document360 project sub-domain to your custom-domain will be required.