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

Subscription

Get a view of all your subscription information for Hornbill. This includes storage, mailboxes, users, and applications. Also available here is the ability to create a Passcode for Hornbill Support.

Your Usage

Usage

View your usage dashboard to see the following.

  • Database Usage (The amount of space used directly within the database)
  • Disk Usage (The amount of storage used by items such as images and emails)
  • Total Usage (Database Usage + Disk Usage)
  • Users
  • Basic Users
  • Shared Mailboxes
  • Instance Storage Usage Monthly / Daily

Application Subscriptions

View a list of all the applications that you have subscribed to.

  • Application
    Name of the application that is installed and available in Hornbill.
  • Version
    The version that is currently installed in Hornbill.
  • Install Date
    The date on which the application was originally installed.
  • Subscriptions
    The number of subscribers currently subscribed to the app. Subscriptions listed as Unlimited are apps that do not require additional subscriptions and are available to all platform subscribers.

Contacts

See the list of your key contacts that are registered with Hornbill

Support

Support Passcodes

Support Passcodes have been designed to allow Customers to grant temporary access to their Instance should this be needed for Support to investigate an open issue. A Passcode will be generated against a particular user, allowing the Support Team Member the ability to investigate behavior with the same access level as the user experiencing the issue.

Generating a Support Passcode to enable Hornbill Support to access your Instance

  1. Click on the Hornbill Configuration cog in the bottom left of the screen
  2. Select Hornbill Solution Center from the dropdown list
  3. Under the Subscription category select Your Usage
  4. Select the Support tab
  5. Click on the Generate Support Passcode button
  6. In the popup
    1. Select the User you wish the Passcode to be generated against
    2. Select the duration of the passcode (from 1 to 72 hours)
    3. Record a note of the purpose for generating the passcode
    4. Click the Generate button
  7. The Passcode will be displayed

Tip

  • Once this dialog is dismissed, you cannot retrieve this Passcode. Should you forget the current Passcode a new one will need to be generated.
  • Generating a new Passcode will automatically revoke the existing Passcode
  • If there is an active Passcode the Revoke current access code button will be active. Clicking this will revoke access for the current Passcode.
In This Document