How to install Helpjuice?

Installing Helpjuice is easy. It takes just a few minutes to connect Helpjuice with your website. There are two possible ways to achieve this.

There are two ways of installing Helpjuice:

Embed Helpjuice Via Our Javascript Embed Code

Please note: If you'd like to use Helpjuice, behind an "authenticated wall" (i.e.: make sure people have to be logged in to view your knowledge base, the Javascript Embed Option is great, as it allows you to turn off access to your knowledge base, unless people visit it via the javascript embed)

You can use Helpjuice as a widget on your website. All you would need to do is copy-paste this code below anywhere on your website.

Best practice when using iframe code is to put it inside div with some class, so you can position it easier on your website. Embed code is below.

<div id="helpjuice_js_widget_content">
 <img src='https://helpjuice.com/images/cube-theme/loading.gif' class="helpjuice-loading-spinner" />
</div>
<script>
 var helpjuice_account_url = "https://YOUR_SUBDOMAIN.helpjuice.com";
</script>
<script src="https://s3.amazonaws.com/assets.helpjuice.com/helpjuice.min.js"></script>


Helpjuice Javascript Embed for 1-page apps (hash based)

The following only applies for 1-page, hash based, apps.

In case you are using a single page application, such as Ember or Angular, it's important to define a variable, where your knowledge base hash is living on.

 
The Helpjuice_preset_hash This would be the "base" of your helpjuice URL prefix, where Helpjuice is loaded.

For example, if Hj is running on #settings/help, you would type settings/help as the helpjuice_preset_hash value. 

<div id="helpjuice_js_widget_content">
 <img src='https://helpjuice.com/images/cube-theme/loading.gif' class="helpjuice-loading-spinner" />
</div>
<script>
 var helpjuice_account_url = "https://YOUR_SUBDOMAIN.helpjuice.com";
 var helpjuice_preset_hash = ""; 
</script>
<script src="https://s3.amazonaws.com/assets.helpjuice.com/helpjuice.min.js"></script>




Use Helpjuice via "standalone" Subdomain/CNAME-alias

In case authenticating your users in order to view your knowledge base isn't a huge factor, and you'd like to have more control over the look & feel of your knowledge base, the CNAME/Subdomain route is the ideal approach. Another benefit of this approach is SEO – if you have CNAME set up, Google will index your knowledge base, and pass page authority to the domain.

With this approach, your knowledge base is a stand-alone knowledge base, to where you point your customers to. It can be set up to use a CNAME (e.g.: help.yourcompany.com), or you can just use your default Helpjuice subdomain (e.g.: mycompany.helpjuice.com).

Please keep in mind, while you do have more control over this design, it can be time consuming to design your knowledge base. For that, please don't hesitate to contact Helpjuice, as we're more than willing to help with design, completely free of charge.

Once you've customized, and #LINKED{SET UP Your CNAME} and all you have to do is point your users to the url of your knowledge base.

1) Create a CNAME record in your DNS settings

Under your DNS settings, of your DNS provider, make sure to create a new record for what you'd like your new Helpjuice Knowledge Base URL to reside on.

For example, if we wanted to add help.example.com to point to Helpjuice, we'd go to the DNS settings of example.com and add the following:

Name / Host / Alias => help
Value / Answer / Destination => yourSUBDOMAIN.helpjuice.com


 Your domain register can take up this request up to 72 hours before you will be able to access you KB using help.example.com.

2) Configure Helpjuice to use your new CNAME

Open your Settings menu, which can be found at top right corner of your Helpjuice dashboard and than under CNAME aliasenter your desired subdomain.



In step #1, we used help.example.com for our Name/Host Alias, so let's go ahead and plug that in.

3) That's it! You did it.

Sit back, relax, and pat yourself on the back. You did a great job. Have Helpjuice send you free cookies, you deserve it.

Was this article helpful?

Can't find what you're looking for?

Contact Support