Webmin Module Writers Help

Required Files

Every module has its own directory under the Webmin base directory, in which all the module's CGI programs and configuration files must be stored. For example, if the Webmin base was /usr/local/webmin-0.62, a module called foobar would be installed in /usr/local/webmin-0.62/foobar.

For a module to be displayed on the main Webmin menu, it must contain at least the following two files.

images/icon.gif

The icon displayed on the main menu for this module. The icon should be 48x48 pixels, and should use the same colour scheme as the other icons on the main menu.

module.info

This file contains information about the module and the operating systems it runs under. Each line of the file is in the format
name=value
Required names and their values are:

name: A short name for this module, such as FooAdmin.
desc: A longer description for the module, such as Foo Web Server. This is the text that will appear below the icon on the main menu.
op_support: A space-separated list of operating systems that this module supports. The module will only be displayed on the main menu if the OS Webmin is running on is in the list, or if there is no os_support line at all.
depends: A space-separated list of other modules upon which this module depends. If module A depends upon module B, then Webmin will prevent module B from being deleted while A is still installed. Similarly, Webmin will prevent A from being installed if B has not been.
The list can also contain a Webmin version (such as 0.75) that the module depends upon. In that case, installation of this module by an older version of Webmin will not be allowed. (Versions 0.70 and above)
category: This value determines which tab on the main Webmin page your module will be categorised under. Supported values are webmin, system, servers and hardware. If your module.info file has no category line, it will appear under the Others category. (Versions 0.77 and above)

Each icon on the main menu is a link to the module directory. Thus you must have an index.cgi or index.html file to be displayed when the user clicks on the icon.