Skip to main content
Support

Restricting Your Docs to Logged In Users

HelpDocs makes it easy to restrict access to your docs to logged in users. This way, when a user visits your docs they'll be redirected to the regular login page instead.

Taylor
Updated by Taylor
2 min read

HelpDocs makes it easy to restrict access to your docs to logged in users. This way, when a user visits your docs (on your HelpDocs subdomain or custom domain) they'll be redirected to the regular login page instead.

This works great paired with the read-only role and Single Sign On
This option is enabled by default when you sign up and during the trial period. Only our team can turn it off during a trial, so contact support if you need your docs public sooner
  1. Log in to HelpDocs at <your-subdomain>.helpdocs.io/app
  2. Go to Settings > Sign-in & access
  3. Under Who can read your help center, choose Only people who sign in
  4. Hit Save changes

Now your frontend knowledge base will only be accessible to users that have logged in. Remember, you'll now need to invite users to your account, or set up Single Sign On, before they're able to view your docs.

Want them to go straight to your SSO or your own app instead of the login page? Fill in Send the sign-in page somewhere else under Sign-in page on the same screen. Your team can still use /login?hd_login=1.

You'll need to turn on HTTPS (Settings > Domains > Request HTTPS) before we can let you use this with a custom domain. Gotta be secure, y'all 🀠

Sending Signed-Out Readers Somewhere Else

If only some of your content is restricted, signed-out readers who hit it see a 404 page with a message to say so. To send them to your SSO or your own page instead:

  1. Head to Settings > Sign-in & access
  2. Under Sign-in page, find Signed-out readers on a restricted article
  3. Enter where they should go: a path like /login/oidc or /login/saml2, or a full URL starting with https://
  4. Hit Save changes

This covers restricted articles and restricted categories. We add the page they asked for to the address as forward, so your sign-in flow can bring them back to it. A signed-in reader who doesn't have access still sees the 404 page.

This setting doesn't accept /login itself: saving that leaves the redirect turned off.

What did you think of this doc?

Previous Accessing User Data in HelpDocs Next Anonymous Mode for Read-Only SSO Users

Get in touch