Documentation

{{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}}

User Import and Synchronization

The most common way of managing accounts is by using an import and synchronization utility. These include LDAP Import, Azure Import, Database Import, and Google Workspace User Import.

These utilities provide a simple, safe, and secure way to create and update accounts in Hornbill and can be scheduled to run automatically using Windows Task Scheduler.

Azure User Import Utility

The connects to Hornbill and Azure in the cloud over HTTPS/SSL using a standard internet connection without the need to make any firewall configuration changes.

Tip

This utility employs the Azure Graph API to query the contents of Azure AD. If you would like to know more about this API and its capabilities, please refer to the relevant Microsoft documentation.

For more information on installing and configuration please see the Azure User Import Utility documentation.

LDAP User Import Utility

This utility is designed to run behind your corporate firewall to connect to your LDAP service.

The utility connects to Hornbill in the cloud over HTTPS/SSL using a standard internet connection without the need to make any firewall configuration changes.

Tip

The LDAP Utility can be used as a stand-alone alternative to or supplement user auto-provisioning. While auto-provisioning requires Single Sign On (SSO) configuring, the LDAP import utility is completely independent of any SSO configuration.

For more information on installing and configuration please see the LDAP User Import Utility documentation.

SQL User Import Utility

This utility is designed to run behind your corporate firewall and connect to your database.

The utility connects to Hornbill in the cloud over HTTPS/SSL using a standard internet connection without the need to make any firewall configuration changes.

For more information on installing and configuration please see the SQL User Import Utility documentation.

Google Workspace User Import Utility

This utility is designed to run behind your corporate firewall and securely connect to Google Workspace.

The utility connects to Hornbill in the cloud over HTTPS/SSL using a standard internet connection without the need to make any firewall configuration changes.

For more information on installing and configuring, please see the Google Workspace User Import Utility documentation.

In This Document