Ports used

Ports work like numbered doors on a server: every service (a website, email, a print server) communicates through a particular port number. For Docuflair to work correctly, the ports listed here have to be open in the firewall — otherwise devices or browsers cannot reach the server.

To run Docuflair, various ports are opened on the Docuflair server during installation.

During installation, Docuflair attempts to set up firewall rules for the required ports automatically. Note that manual configuration of the firewall rules may be necessary, particularly when running on Windows Server 2016, 2019 and 2022, because the operating system may prevent the rules from being set up automatically.

If the Docuflair application does not appear on a multifunction printer after registration, or the web interface for administering Docuflair cannot be opened from a computer over the network, then rules are very probably missing in the Windows firewall.

List of the TCP ports needed

By default, Docuflair needs the following TCP ports to run:

TCP port	Description	Note
9050	Web services of the first Docuflair instance for communicating with printers.	Required in connection with multifunction printers and document scanners
9051	The web page for administering the first Docuflair instance	Required for administration over the network.
9032	FTP service of the first Docuflair instance, for multifunction printers that need FTP to transfer scan jobs	Optional, required for Lexmark devices for example
9033	Web service (http) of the first Docuflair instance for releasing print documents on Xerox multifunction printers (works around a problem in the Xerox 78xx firmware)	Not strictly required
9034	Web service (https) of the first Docuflair instance for authentication on Xerox devices	Required only for authentication on Xerox devices

In the Windows firewall, allow at least the port numbers in bold for inbound connections.

If you install further instances of Docuflair, you have to open additional ports, each with a port number exactly 100 higher. For the second instance, that gives the following ports:

TCP port	Description	Note
9150	Web services of the second Docuflair instance for communicating with printers.	Required in connection with multifunction printers and document scanners
9151	The web page for administering the second Docuflair instance	Required for administration over the network.
9132	FTP service of the second Docuflair instance, for multifunction printers that need FTP to transfer scan jobs	Optional, required for Lexmark devices for example
9133	Web service (http) of the second Docuflair instance for releasing print documents on Xerox multifunction printers (works around a problem in the Xerox 78xx firmware)	Not strictly required
9134	Web service (https) of the second Docuflair instance for authentication on Xerox devices	Required only for authentication on Xerox devices

For the third instance, the port numbers are:

TCP port	Description	Note
9250	Web services of the third Docuflair instance for communicating with printers.	Required in connection with multifunction printers and document scanners
9251	The web page for administering the third Docuflair instance	Required for administration over the network.
9232	FTP service of the third Docuflair instance, for multifunction printers that need FTP to transfer scan jobs	Optional, required for Lexmark devices for example
9233	Web service (http) of the third Docuflair instance for releasing print documents on Xerox multifunction printers (works around a problem in the Xerox 78xx firmware)	Not strictly required
9234	Web service (https) of the third Docuflair instance for authentication on Xerox devices	Required only for authentication on Xerox devices

When a new Docuflair instance is installed, the installer checks which port numbers are already in use and selects the next free range for the newly installed instance.

Reading the configuration of a Docuflair instance

To check which port numbers a Docuflair instance uses, open the file Settings.xml in the instance’s main directory, x:\Docuflair\instances\.

<?xml version="1.0"?>
<InstanceConfig xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<version>1</version>
<instanceName>default</instanceName>
<language>de</language>
<logLevel>0</logLevel>
<savePrintFiles>0</savePrintFiles>
<logDatabase>0</logDatabase>
<databaseConnection>d:\Docuflair\instances\default\data\database.sqlite</databaseConnection>
<databaseProvider/>
<customer/>
<instanceFolder/>
<backupFolder/>
<repositoryFolder/>
<cloudJobsFolder/>
<adminPort>9031</adminPort>
<ftpPort>9032</ftpPort>
<printerPort>9030</printerPort>
<xsaPort>9034</xsaPort>
<adminSSL>false</adminSSL>
<printerSSL>false</printerSSL>
<xsaSSL>true</xsaSSL>
</InstanceConfig>

Name	Description
printerPort	Web services for communicating with printers
adminPort	The web page for administration
ftpPort	FTP service for multifunction printers that need FTP to transfer scan jobs
cloudPrintPort	Web service (http) for releasing print documents on Xerox multifunction printers (works around a problem in the Xerox 78xx firmware)
xsaPort	Web service for authentication on Xerox devices

Reconfiguring the TCP ports

In certain situations it may be necessary to specify alternative ports for using Docuflair on the network. To reconfigure the TCP ports, carry out the following steps:

De-register every multifunction printer that is set up (only if printerPort is to be changed)
Stop the Docuflair instance
Adjust the file Settings.xml according to the table above
Reconfigure Internet Information Server (with the Internet Information Services (IIS) Manager) or IIS Express (x:\Docuflair\instances\\www\ApplicationHost.config) by switching to the new values entered in Settings.xml
Start the Docuflair instance
Re-register every multifunction printer (only if printerPort was changed).