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

Login Screen

The Login Screen option within Configuration allows you to customize the look of the login page for the main web app.

Settings

Splash Image

Allows you to customize the splash image that is displayed on the left hand side of the page. The image will automatically be adjusted to fit the screen, the recommended size of this image is 1700px x 1280px

About Details

Enable this setting will add a About Us box which will be displayed in the login form

  • Title
    Sets the title of the about us box
  • Text
    Sets display text to welcome the user

Footer

Enable this setting to display a footer to the login form

  • Background color
    The footer background color
  • Text Color
    The footer text color
  • Link Color
    The color of links on the footer
  • Social Information
    This section allows you to specify your social media accounts Twitter, LinkedIn, YouTube, and Facebook. Only the account ID is needed. We’ll take care of the links. These are displayed with the appropriate social media logo. Any logo that you do not want to display, leave the account name blank. If you would like to completely remove this section, deselect the checkbox next to the Social Information title.
  • Contact Information
    Add the contact details to let you users know who to contact if they have questions about the page. Any field that you do not want to display, leave blank. If you would like to completely remove this section, deselect the checkbox next to the Contact Information title.

SSO Options

  • Default Identity Provider
    If you have multiple identity providers, this allows you to select which is selected by default when a user first visits (note: when a user changes this, the change is remembered for them)

Tip

This option is only visible when there is more than one active SSO Profile configured.

In This Document