A Private knowledge base is restricted to authorized users only. Content is accessible only to readers or users with an account, and a login is required to view any articles.
Common use cases
- Internal IT support knowledge base
- HR policies and procedures
- Company-wide documentation
- Internal API documentation
- Proprietary software manuals
Behaviour
- All content is hidden from public view. Readers must sign in with their credentials to view any articles.
- Login is required for all readers. No part of the knowledge base is publicly accessible, except articles you share through a share link.
- Reader access controls, reader groups, and block inheritance settings apply and allow you to further restrict which readers can see which content.
- JWT authentication is supported in Private mode.
- Login sessions expire after more than 15 minutes of inactivity as a security measure. Refreshing the page re-establishes the session.
If you create a share link for an article, anyone with the link can preview that article in read-only mode without logging in. To stop all sharing, an Owner or Admin can turn off the Share link setting for the project. This revokes all active links, and the knowledge base is then accessible only to signed-in readers and users. For more information, see Share articles via private link.
How to set your project to Private access
- Navigate to Settings () > Users & permissions in the left navigation bar in the knowledge base portal.
- In the left navigation pane, navigate to Reader access.
- Select Private.
- In the Update reader access confirmation dialog, enter your project's subdomain.
- Click Yes to confirm.
When switching from Mixed to Private, you might want to reconsider the previously assigned access permissions.
FAQ
Why do I see a session expired error when viewing content on a private knowledge base site?
If your knowledge base site is set to Private, your login session may expire after more than 15 minutes of inactivity. This is a standard security measure to prevent unauthorized access to private content. A simple workaround is to refresh the page, which re-establishes your session and restores access.