Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?

What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Two-factor authentication

Hornbill supports two-factor authentication (2FA) for both user and guest accounts.

2FA can either be enabled for all accounts, or on an account-by-account basis.

Before you begin

  • Hornbill must have an email domain set up for outbound routing
  • Users must have a valid email address on their account
  • 2FA is only applicable to the web apps. It is not available on the native mobile apps.
  • When using SSO, Hornbill 2FA is not used. Instead, 2FA should be set up using your identity provider if the option is available.

How Two-Factor Authentication Works

With Two-factor Authentication (2fa) enabled, when a user (guest) logs in to Hornbill, they will be prompted to enter a 6-digit authentication code.

The user retrieves this code from an email sent to their account’s email address, and uses it to complete the log in process.

2FA Code

Settings

2FA Timeouts are set in Advanced System Settings.

Tip

To access any of the settings described in this document, open Configuration and search by part or all of the setting name

Name Description Default
security.guest.2fa.timeout The number of seconds a 2FA challenge token remains valid (in seconds) 300
security.user.2fa.timeout The number of seconds a 2FA challenge token remains valid (in seconds) 300

2FA mode optional

When either the user or guest mode settings are set to optional the option to enable 2FA on an individual user account is available.

  • Disabled
    2FAis not enabled.
  • Email
    2FA is enabled. Authentication codes are sent to the users by email.

How to enable 2FA on a user account

  1. Using the Configuration search, type the name of the user to be changed to 2FA.
  2. In the list of results, select the user name.
  3. On the Details tab of the user account, locate the Security Settings section.
  4. Under Two-Factor Authentication select `Email’.
  5. Save Changes.

How to enable 2FA on a guest account

  1. Using the Configuration search, type Guest.
  2. In the list of results, click on Guest Accounts.
  3. In the list of guest accounts, select the account to be changed to 2FA.
  4. Click on the Two-Factor Authentication icon in the toolbar.
  5. Select Email.
  6. Select Save.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document