KeyHelp Toolbox

Introduction

The KeyHelp Toolbox provides the server administrator with a utility program that can be used to control a collection of KeyHelp functions from the command line. In addition, features are available that are not ~~available~~provided through the KeyHelp web interface.

This tool is designed for interactive operation. If, on the other hand, you want to control KeyHelp functions in a non-interactive way (e.g. within scripts), you can use the Command Line Utility, for example.

Execution & Operation

To launch the toolbox, first connect to your server. Then call the following command from the command line.

keyhelp-toolbox

After a KeyHelp update it can take up to an hour until this command is executable again.
In this case, try again later.

You are now in the main menu of the Toolbox.

To get to the desired feature, type the highlighted number or letter in front of the corresponding menu item and press the Enter key.

Features

Various features are available via the toolbox, which are explained in more detail below.

Rewrite user configuration files

With this function you can trigger a rewrite of all configuration files related to users created in KeyHelp.
In detail, the user-specific configurations of the web server (Apache), the DNS server (Bind) and the PHP Process Manager (PHP-FPM) are rewritten and applied.

Disable maintenance mode

The KeyHelp user interface can be used to put the web interface into a maintenance mode. From now on, only users with predefined IPs are allowed to call KeyHelp. However, if the user's IP changes, there is a risk of being locked out of the user interface.
You can use this function to disable the maintenance mode and ~~thus~~therefore regain access to the web interface.

Disable login restrictions for administrator accounts

The KeyHelp interface allows you to restrict access to administrator accounts to specific IPs and IP ranges. However, if the user's IP changes, there is a risk of being locked out of the user interface.
Using this feature, you can remove the login restriction for administrator accounts and ~~thus~~therefore allow administrators to access the web interface again.

Disable two factor authentication

If the login for user accounts is protected via two-factor authentication, a login without the second factor for this user account is no longer possible from now on. If the second factor is lost, it will no longer be possible to log in to the user interface.
With the help of this function, two-factor authentication can be deactivated for any user account, ~~thus~~therefore allowing access to the web interface again.

Clear template cache

If you are working on a custom theme for KeyHelp, it may be necessary to clear the template cache regularly, otherwise the changes made to the theme files may not be displayed correctly and outdated content may be delivered from cache.

Start maintenance tasks

At regular intervals KeyHelp performs maintenance tasks to ensure the optimal operation of your server. Normally these tasks are triggered automatically by KeyHelp as soon as they are needed.
However, you can also use this function to trigger all available maintenance tasks yourself.

Show system info

This function presents at a glance the most important information about your server, as well as version numbers of the software installed on it.