Shared Password Protection
Whether you're using your HelpDocs internally to train staff, or just because they're not ready for the limelight yet, there's a load of reasons you might want to password protect your HelpDocs.
HelpDocs makes it super simple to add a shared password that visitors will need to enter before they get to your docs.
- Log in to HelpDocs at
- Go to Settings > General
- Under Shared Password enter a password of your choice
- Hit Save
Now when people visit your site they'll need to enter a password before they can read any docs.
Using Team Passwords for Single Sign On
If you're looking to set up docs that only users logged into your app can view, the team password works great.
Dropping the Cookie
Just load HelpDocs in an iframe on your dashboard when people log in, including the team password in the query string. We have a special URL for you to use, where you can set a duration for users to stay logged in.
The basic URL structure is
Here's a snippet to get you started:
<iframe src="https://<your-helpdocs>.helpdocs.io/_hd/team_sso?hd_team=<your-team-password>" width="0" height="0" style="display: none"></iframe>
There's also a few parameters you can customize:
|Query Parameter||Description||Default Value|
|Your shared team password. If you want to log a user out, set this to an empty string (or just an incorrect password).|
|How long (in days) you'd like users with this cookie to be logged in for, without requiring a password.|
|The text you'd like included in the response from this route. You usually won't need to set this.|
|Where to redirect the user to after dropping a cookie. If you're using this route in an iframe, there's usually no need to set this.|
Redirecting Logged Out Users
When a user hasn't visited your site for a while they won't have a cookie set. You'll want to override the default HelpDocs team password login page with a redirect to your own app. Something like this in Settings > Code > Custom Scripts should work:
If you're a stickler for user experience, your developers can set up a redirect back to the correct HelpDocs article after login by extracting the
hd_url query param.