Configuring Laserfiche to be Firewall Compatible.

August 4, 2014 | KB: 1000765
Agenda Manager 7, Laserfiche 7, Web Access 7, WebLink 7

Summary

If a firewall is placed between a Laserfiche Server and another Laserfiche product, then the default behavior of the Laserfiche Server will prevent it from communicating with the desired Laserfiche product. This article explains what can be done to allow this communication to take forth.

Resolution

The Firewall Compatibility Component (FCC) allows the Laserfiche Server 7 to communicate with Laserfiche client programs (version 7.x) across a firewall. This application is included on the installation CD for the Laserfiche Client/Server 7.1.1 and 7.1.2. In Laserfiche Client/Server 7.2, this application is directly integrated into the installation.

Laserfiche Firewall Compatibility Component includes an installation for the Laserfiche Server and another one for the client. The server version must be installed and configured on the computer hosting the Laserfiche Server. The client version must be installed and configured on each computer outside the firewall on which a Laserfiche product that needs to access the Laserfiche Server has been installed.

Note: Laserfiche products that are inside the firewall do not require the Firewall Compatibility Component, since they can already communicate with the Laserfiche Server.

To configure the server component of the Firewall Compatibility Component 7.1

  1. Install the server version of the Laserfiche Firewall Compatibility Component. If you are unsure as to where the installation can be found, please refer to the To locate the server version of the Laserfiche Firewall Compatibility Component procedure below.
  2. Use a text editor to open the configuration file called "lfremotingservice.exe.config." By default, this file can be found at: C:\Program Files\Laserfiche\Server Firewall Compatibility Component.
  3. Look for a line that looks like:

    channel ref="tcp" port="2040" displayName="Laserfiche Remoting Channel"

  4. Edit the port value and add the server machine's IP address to the line. The final result should look similar to the following:

    channel ref="tcp" port="xxxx" machineName="yyy.yyy.yyy.yyy" displayName="Laserfiche Remoting Channel"

    The term "xxxx" represents a port that must be opened on the firewall. Keep in mind that this port cannot be used by another protocol. The term "yyy.yyy.yyy.yyy" represents the IP address that client machines will use to connect to the Laserfiche Server.

    Note: Be aware that if a NAT firewall is involved, this IP address may not be the actual IP address of the computer hosting the Laserfiche Server.

    Important: The Firewall Compatibility Component configuration file is case-sensitive. If the wrong case is used when modifying the configuration file, then the Laserfiche FCC service will not function properly.

  5. Restart the Laserfiche Server and the Laserfiche Server Firewall Compatibility Component services.
    1. Click Start and then click Control Panel.
    2. Double-click Administrative Tools.
    3. Double-click Services.
    4. Scroll down and select Laserfiche Server Firewall Compatibility Component.
    5. From the Action menu, click Restart.
    6. Select Laserfiche Server 7.x.
    7. From the Action menu, click Restart.

To configure the server component of the Firewall Compatibility Component 7.2

  1. Use a text editor to open the configuration file called "LfFccService72.exe.config." By default, this file can be found at: C:\Program Files\Laserfiche\Server.
  2. Look for a line that looks like:

    channel ref="tcp" port="2040" displayName="Laserfiche FCC Channel"

  3. Edit the port value and add the server machine's IP address to the line. The final result should look similar to the following:

    channel ref="tcp" port="xxxx" machineName="yyy.yyy.yyy.yyy" displayName="Laserfiche FCC Channel"

    The term "xxxx" represents a port that must be opened on the firewall. Keep in mind that this port cannot be used by another protocol. The term "yyy.yyy.yyy.yyy" represents the IP address that client machines will use to connect to the Laserfiche Server.

    Note: Be aware that if a NAT firewall is involved, this IP address may not be the actual IP address of the computer hosting the Laserfiche Server.

    Important: The Firewall Compatibility Component configuration file is case-sensitive. If the wrong case is used when modifying the configuration file, then the Laserfiche FCC service will not function properly.

  4. Restart the Laserfiche Server and the Laserfiche Server Firewall Compatibility Component services.
    1. Click Start and then click Control Panel.
    2. Double-click Administrative Tools.
    3. Double-click Services.
    4. Scroll down and select Laserfiche FCC 7.2.
    5. From the Action menu, click Restart.
    6. Select Laserfiche Server 7.x.
    7. From the Action menu, click Restart.

Configure the firewall so that the following ports are open

  • You will need to open the port specified in the FCC configuration file.
  • You will need to open port 1888, if the Laserfiche Server needs to communicate across a firewall with any of the following products:
    • Laserfiche Quick Fields (version 7)
    • Laserfiche Scanning (version 7.0.x)
    • Snapshot (version 6, 7.0, or 7.0.1)
    • Laserfiche Client (version 6)
    • WebLink (version 6)
    • Web Access (version 6)
  • If the Laserfiche Server needs to communicate across a firewall with the DBMS, then you will need to open the port(s) used by the DBMS.

Reminder: After configuring the Laserfiche Server, you will need to configure each computer outside of the firewall that is hosting a Laserfiche product that needs to communicate with the Laserfiche Server. For more information, please refer to the Related Links section below.

To locate the server version of the Laserfiche Firewall Compatibility Component

Note: The following procedure is not necessary for Laserfiche 7.2. The server component of the Laserfiche Firewall Compatibility Component is automatically installed as part of the Laserfiche Server 7.2 installation. There is no need to locate and run a separate installation.

  1. Insert the Laserfiche Client/Server installation CD into your CD/DVD drive. The Laserfiche installation menu should appear. If it does not appear, then you should double-click Autorun.exe from the root folder of the installation CD.
  2. Select More Options and then choose Install Firewall Compatibility Component (FCC) 7.1.
  3. Select the Install: FCC (Server) option. The installation for the server version of the Laserfiche Firewall Compatibility Component will appear. Step through the installation wizard.

Note: If you cannot locate the Firewall Compatibility Component installation, please contact Laserfiche Technical Support.

Related Links

In addition to configuring the Laserfiche Server, you will need to configure each computer outside of the firewall that is hosting a Laserfiche product. Please refer to one of the following Laserfiche Knowledge Base articles for detailed configuration instructions:

1011184 Configuring Agenda Manager to be Firewall Compatible.

1011021 Configuring the Laserfiche Client to be Firewall Compatible.

1011182 Configuring Quick Fields to be Firewall Compatible.

1011186 Configuring WebLink to be Firewall Compatible.

1011185 Configuring Web Access to be Firewall Compatible.

More Information

Laserfiche Client 6, WebLink 6, and Web Access 6 do not need the Firewall Compatibility Component. A firewall will not prevent these products from connecting to the Laserfiche Server as long as port 1888 has been opened on the firewall.