eBox is a web framework used to manage server application configuration. The modular design of eBox allows you to pick and choose which services you want to configure using eBox.


The different eBox modules are split into different packages, allowing you to only install those necessary. One way to view the available packages is to enter the following from a terminal:

apt-cache rdepends ebox | uniq

To install the ebox package, which contains the default modules, enter the following:

sudo apt-get install ebox

During the installation you will be asked to supply a password for the ebox user. After installing eBox the web interface can be accessed from: https://yourserver/ebox.


An important thing to remember when using eBox is that when configuring most modules there is a Change button that implements the new configuration. After clicking the Change button most, but not all, modules will then need to be Saved. To save the new configuration click on the Save changes link in the top right hand corner.


Once you make a change that requires a Save, the link will change from green to red.

eBox Modules

By default all eBox Modules are not enabled, and when a new module is installed it will not be automatically enabled.

To enable a disabled module click on the Module status link in the left hand menu. Then check which modules you would like to enable and click the Save link.

Default Modules

This section provides a quick summary of the default eBox modules.

  • System: contains options allowing configuration of general eBox items.

    • General: allows you to set the language, port number, and contains a change password form.

    • Disk Usage: displays a graph detailing information about disk usage.

    • Backup: is used to backup eBox configuration information, and the Full Backup option allows you to save all eBox information not included in the Configuration option such as log files.

    • Halt/Reboot: will shutdown the system or reboot it.

    • Bug Report: creates a file containing details helpful when reporting bugs to the eBox developers.

  • Logs: allows eBox logs to be queried depending on the purge time configured.

  • Events: this module has the ability to send alerts through rss, jabber, and log file.

    • Available Events:

      • Free Storage Space: will send alert if free disk space drops below a configured percentage, 10% by default.

      • Log Observer: unfortunately this event does not work with the eBox version shipped with Ubuntu 7.10.

      • RAID: will monitor the RAID system and send alerts if any issues arise.

      • Service: sends alerts if a service restarts multiple times in a short time period.

      • State: alerts on the state of eBox, either up or down.

    • Dispatchers:

      • Log: this dispatcher will send event messages to the eBox log file /var/log/ebox/ebox.log.

      • Jabber: before enabling this dispatcher you must first configure it by clicking on the Configure icon.

      • RSS: once this dispatcher is configured you can subscribe to the link in order to view event alerts.

Additional Modules

Here is a quick description of other available eBox modules:

  • Network: allows configuration of the server's network options through eBox.

  • Firewall: configures firewall options for the eBox host.

  • UsersandGroups: this module will manage users and groups contained in an OpenLDAP LDAP directory.

  • DHCP: provides an interface for configuring a DHCP server.

  • DNS: provides BIND9 DNS server configuration options.

  • Objects: allow configuration of eBox Network Objects, which allow you to assign a name to an IP address or group of IPs.

  • Services: displays configuration information for services that are available to the network.

  • Squid: configuration options for the Squid proxy server.

  • CA: configures a Certificate Authority for the server.

  • NTP: set Network Time Protocol options.

  • Printers: allows the configuration of printers.

  • Samba: configuration options for Samba.

  • OpenVPN: setup options for OpenVPN Virtual Private Network application.