Configuration Editor

Newcomers should read the Configuration overview

Check this page for usage of all parameters which can be set within this file.

Some parameters are brought by some extensions/plugins and therefore are not mentionned in this reference guide.

Online editor

This tool is available to the iTop administrators. It is a shortcut to edit the configuration file <itop-root>/conf/production/config-itop. This tool also secures the process in that the changes will not be saved if any syntax error is found.

It is highly recommended to keep a copy of the configuration file prior to doing any change.

Do NOT edit the lower part of the file. This part starts with the comment:

Data model
modules to be loaded

.

Some changes made in the configuration may cause iTop to be inoperant. In such a case, right after the change is submitted, you would get an error, and it would not be possible to access this GUI to rollback your changes. The settings that are the most sensitive are the credentials to the MySQL server.

The editor is accessible from the “Admin tools / Configuration” menu:

The editor is a plain text input:

Click on Apply to save your settings.

Click on Reset to go back to the initial state when the page has been loaded (last time is was loaded).

If a syntax error is found, the file will not be saved and the editor will help you in finding where the typo resides:

Use the current line indicator (Editing line:…) to navigate to the line on which the issue has been reported.

Sometimes, the typo resides one line above the incriminated line.

Upon saving, and if no syntax error is encountered, then a green banner is shown:

Note that the new configuration takes effect when a page gets loaded again. So in order to see the effect of the modified configuration you have to navigate to another page in iTop.

Sidebar

Configuration Editor

Online editor