Having Helpjuice Run On A Subdirectory Of Your Website (e.g. /help)

5b9ac3cf2f9a563777b37bc9a5571752

Written by Emil Hajric

Last published at: April 22nd, 2019

Having your knowledge base reside on a subdirectory of your website, rather than subdomain is better for SEO, and can make your knowledge base look more 'integrated' into your website. Luckily, the set-up to make this happen with Helpjuice takes only a few minutes if you are using NGINX or Apache for your server.

An example of this in action would be: https://x10hosting.com/support/ 


In order to set up Helpjuice to run on a subdirectory (subdir) on your site, you may copy the below code, instructions are as follows

  1. Determine if you are using Apache or Nginx
  2. Copy the appropriate code (if using Apache, use the Apache code, etc.)
  3. Make sure to replace all the yellow highlighted parts with your data. Red data is optional and only change if you want it elsewhere other than /help/
  4. Paste the code into your Server configuration file
  5. Restart your server 


If you are using Apache and want to run it on /help/: 

First make sure you have the two required modules enabled:

sudo a2enmod proxy
sudo a2enmod proxy_http


Restart Apache for your new modules to load and add the following configuration:

ProxyPass "/help"  "http://yourAccount.helpjuice.com/"
ProxyPassReverse "/help"  "http://yourAccount.helpjuice.com/"


If you are on NGINX and want to run it on /help/

upstream yourAccount-lb {
  server yourAccount.helpjuice.com fail_timeout=0;
}

server {
  listen 80;
  large_client_header_buffers 4 16k;

  server_name yourwebsite.com;

  location ~ ^/help/?((?<=/).*)?$ {
    proxy_set_header Host yourAccount.helpjuice.com;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_pass http://yourAccount-lb/$1$is_args$args;
    proxy_read_timeout 90;
    proxy_http_version 1.1;
  }
}