Hosting HelpDocs at a Subfolder of Your Site

Updated 8 days ago ​by Jake Peters

By default HelpDocs comes with a subdomain (e.g. support.helpdocs.io) and a custom domain (e.g. help.domain.com). They're great for SEO by default (Google's pretty good at working out which content's yours now!) and for most customers there's no need to change things.

There's some cases, though, that it's desirable to integrate your docs more into your site. If you need to, it's possible to host your HelpDocs at a subfolder of your own domain, and there's a couple ways to do that.

Embedding with an iframe 

You can easily add an iframe to your HelpDocs subdomain from anywhere on your site. This is a little tricky to make look awesome, but we have some customers that've done this super successfully.

<iframe src="https://support.helpdocs.io" height="500" width="1000"></iframe>

You can even update URLs in the address bar when people click links. You'd need to write a little custom Javascript inside your HelpDocs and on the page where you're embedding it. Then use something like easyXDM to send messages between the two. You'll want to do that on page loads at either end.

Advanced: Using a reverse proxy

You can also reverse proxy your docs through something like nginx. You'll need set up a listen block to rewrite the URL of your subfolder to your HelpDocs subdomain, like this:

location /help {
    proxy_pass https://support.helpdocs.io;
}

Then in the HelpDocs dashboard, include the subfolder in Settings > General > Custom Domain. So that'll look something like myapp.com/help

We'll take care of rewriting all the internal links our side.

We can't help you with the specifics of embedding or reverse-proxying your site, but if need anything different on the platform to make your implementation easier we're always happy to take feedback!

How did we do?