Documentation Library

Search for information on Hornbill Documentation.


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

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 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 over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title ||}}


  1. {{book.title}}

{{group.title ||}}


  1. {{book.title}}


Linux User Management

Linux Management

Manage Linux users with simple/automated actions in Hornbill

Package Details

  • Vendor: Linux
  • Target Platform: Linux
  • Package Type: Server and Workstation Management

Why use this

Direct control of Linux users

Empower service desk analysts and IT ops teams with direct control over Linux users—without having to leave Hornbill.


  • Empower Hornbill users with direct control over Linux users
  • Control Linux users with automated processes
  • Reduce service desk and IT ops team workloads

How to get it

  • You can try out ITOM for free (not for production use, limited runs) by installing the ITOM application from the Hornbill App Store.
  • If you would like to explore ITOM and consider subscribing, please contact your account manager here.


  • Install the Hornbill Site Integration Server inside your firewall (if you don’t already have it)


When creating jobs for operations contained within this package, they need to be run on the target machine as a user who has the correct privileges within your environment. To create and securely store keys:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button, then select Username + Password;
  • Give the KeySafe Key a Title (this is the name/identifier for the account as you will see it when creating an IT Automation Job, or adding an IT Automation node to a Workflow);
  • Optionally add a Description;
  • Populate the Username field with the username for the account being used on the target machine;
  • Populate the Password field with the password for the above account;
  • Select Create Key to save.

Once you have created your KeySafe Key, you can then use it to populate the Credentials > Admin or Run As inputs when creating IT Automation Jobs from this package.


Accounts used when executing jobs against operations contained within this package must adhere to the following requirements:

  • The target machine must have a local admin user that will be used for running the operations;
  • SSH Remote Login must be enabled for the user above user
  • Configuration for the user must be added to the sudoers file on the target machine, to allow the above user to sudo without a password (example: someadminuser ALL = (ALL) NOPASSWD:ALL).

Package Automations

Create User Creates a Linux user account using the adduser command
Delete User Delate a Linux user account and optionally the user home folder and files. This operation uses the userdel command
Lock User Lock a users account using the usermod command
Modify User Modify user account details using the usermod command
Unlock User Unlock a users account using the usermod command
User Details Retrieve a user details from the passwd file

See also

In This Document