Restrict Docs Site Access with Beacon

Beacon offers the option to use a private Docs site (where Site Visibility is toggled off), making the Docs site visible through Beacon only. You can install Beacon with a private Docs site anywhere you'd like—on your website, behind your own app, intranet, or otherwise secured site. With this option, you can control access to a private knowledge base, all with Beacon!

In this article

Connecting a Private Docs Site

1

Head over to Manage → Docs and click on the New Site button at the top of the page. Enter the name and subdomain for your new site and click Create Site. Note: The name for this Docs site will not be visible to your customers and the subdomain will not serve articles. These settings are only visible to Help Scout Administrators.

Click on Add a collection to create your first Collection and make sure it is set to Public for its Visibility.

Click on Site Settings, toggle Site Visibility to off and click Save at the bottom of the page. 

Note: A Private Collection is not the same as a Docs site with visibility turned off! Private Collections are only visible to logged in Help Scout users and will not be surfaced in Beacon. Check out Browse Private Collections and Articles for more on that feature!

2

Head over to Manage → Beacons and pick the Beacon you want to connect with your private Docs site (or create a new one). Click on Docs on the left sidebar menu, toggle Enable Docs to on, and select the site you just created. Set any other Docs settings you wish to apply.  

3

Grab the Beacon installation code from the Installation tab. Install that behind your own password protected app, intranet, or otherwise secured site. 

Common Questions

Can I apply custom styles / custom code to this Docs site?
Custom CSS and JavaScript are not supported for Docs served in Beacon. Check out the Beacon JavaScript API for details on ways you can customize your Beacon install!

I have a Docs site that has already been published that I'd like to serve only through Beacon, can that be done?
Sure thing! You can turn off Site Visibility for an already existing Docs site at any time. However, you should be aware that search engines may have indexed any Docs site that was previously public. Turning off Site Visibility means that the links into your Docs site will no longer work, but it will not remove any information or links from search engines themselves. 

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still stuck? How can we help? How can we help?