Openfire

Openfire is a real time collaboration (RTC) server licensed under the Open Source Apache License.

This project is funded by NLnet through these subgrants:

Options

services.openfire-server.autoUpdateState

When enabled, the state directory will be automatically updated to match the installed package version.

For manually doing this, please refer to the Openfire Upgrade Guide.

Type:
boolean
Default:
true
services.openfire-server.dataDir

Where to load readonly data from.

Type:
string
Default:
"${config.services.openfire.package}/opt"
services.openfire-server.enable

Whether to enable Openfire XMPP server.

Type:
boolean
Default:
false
services.openfire-server.openFirewall

Whether to open ports in the firewall for the server.

Type:
boolean
Default:
false
services.openfire-server.package

The openfire package to use.

Type:
package
Default:
pkgs.openfire
services.openfire-server.securePort

The port on which Openfire should listen for secure Admin Console access.

Type:
16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
9091
services.openfire-server.servicePort

The port on which Openfire should listen for insecure Admin Console access.

Type:
16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
9090
services.openfire-server.stateDir

Where to store runtime data (logs, plugins, ...).

If left at the default, this will be automatically created on server startup if it does not already exist. If changed, it is the admin's responsibility to make sure that the directory exists and is writeable by the openfire user.

Type:
string
Default:
"/var/lib/openfire"

Examples

  • { ... }:
{
  services.openfire-server.enable = true;
  services.openfire-server.openFirewall = true;
}