KnowledgeOwl

Require login to view files/images

The access settings for your knowledge base (Security and access > Access & SSO) determine the general security requirements for readers to access your knowledge base.

The files you upload to your knowledge base—PDFs, Excel sheets, screenshots, Word documents, etc.—do not automatically use this same security.

By default, even if your knowledge base requires login, the files you've uploaded don't require login. This is by design so that you can give readers the link to specific documents and they can easily download the file by clicking on that link or URL without having to log in to your knowledge base.

However, you can adjust your security settings so that readers have to be logged in to access files and images stored within your knowledge base.  If you make this change, the URLs you'll see will change slightly to a different Cloudfront URL.

With authentication required, if you share a hyperlink directly to a file stored in KnowledgeOwl, anyone accessing that link will be prompted to log in to the knowledge base using the default authentication method before they'll be able to view the file.

Considerations

Before you turn on this login feature, be aware of these limitations:

  • This setting is only available for private knowledge bases. If Who can read this knowledge base? is set to Public, choose one of the private options and save first. (A knowledge base where SAML, OpenID Connect, or Salesforce SSO is set to Required also counts as private.)
  • When this image/file security setting is turned on in the parent or source category's knowledge base, shared content categories can't properly display images and files.
  • When this image/file security setting is enabled, you'll no longer see your knowledge base's logo when you're viewing the KnowledgeOwl app dashboard (/app/switch-project). Logos are only hidden from the app switch-project view; they're still shown everywhere else!

Turn on image/file security

To require that someone must log into your knowledge base before accessing files:

  1. Go to Security and access > Access & SSO.
  2. In the Images and files section, select Require login…:
    The Images and files section of the Access & SSO page with the Require login buttonSelect Require login in the Images and files section
  3. The Require login for images and files? modal opens, asking you if you're sure you want to do this.
  4. Select Cancel to keep files unauthenticated; select Convert to secure links to continue with requiring login to view files. The process starts right away and can take a bit to complete, so we recommend only selecting Convert to secure links when you're not during peak usage hours.
  5. A progress message appears while files are migrated. Once the migration is complete, the section displays Your image and file links are updated. and Only logged-in readers can open images and files. There's nothing to save.

Once the migration finishes, we will programmatically update the URL for most of your files referenced in your knowledge base's theme, within articles, and within article thumbnails/banners and category icons. If you're using URL redirect categories or articles pointing to files stored in KnowledgeOwl, you may need to manually update those URLs.

Turn off image/file security

To let anyone with a link open your images and files again:

  1. Go to Security and access > Access & SSO.
  2. In the Images and files section, select Use public links…. The Make images and files public? modal opens.
  3. Select Convert to public links. The process starts right away and can take a while.

Logo loading issues
If you notice any issues with your knowledge base logo not loading after you require authentication, please contact us and let us know you're having issues. We can move your logo file to unrestricted storage so it will load faster.