--- canonical: "https://safekit.eviden.com/products/high-availability-software-for-application-clustering/linux-load-balancing-failover/safekit-quick-installation-guide-for-a-new-linux-application-with-network-load-balancing-and-failover/" llms_index: "https://safekit.eviden.com/llms.txt" llms_section: "Quick Installation Guides" topics: "Linux Network Load Balancing & Failover: Install the SafeKit farm.safe Module, Step-by-Step Guide: Building a Software-Only Load Balanced Cluster with farm.safe, SafeKit High Availability Limitations, High Availability Quick Installation Guide for Linux, Overview of the SafeKit / Linux solution, Installation of the SafeKit / Linux solution (farm.safe), Step by step configuration of the SafeKit / Linux solution, 🔍 SafeKit High Availability Navigation Hub" --- # Linux Network Load Balancing & Failover: Install the SafeKit farm.safe Module ## Step-by-Step Guide: Building a Software-Only Load Balanced Cluster with farm.safe [🧑 Contact us](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/contact-us-for-safekit/) [🎁 SafeKit free trial](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/safekit-free-trial/) [🏅 Free certification](https://training.my.evidian.com/mod/page/view.php?id=712) [💰 Perpetual license cost](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/get-a-quote-safekit-en/) ## SafeKit High Availability Limitations ### Why a replication of a few Tera-bytes? Resynchronization time after a failure ([step 3](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/file-replication-byte-level-with-failover-mirror-cluster/#mirrorcluster)) * 1 Gb/s network ≈ 3 Hours for 1 Tera-bytes. * 10 Gb/s network ≈ 1 Hour for 1 Tera-bytes or less depending on disk write performances. #### Alternative * For a large volume of data, use [external shared storage](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/san-vs-nas-shared-storage-for-a-failover-cluster/). * More expensive, more complex. ### Why a replication < 1,000,000 files? * Resynchronization time performance after a failure ([step 3](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/file-replication-byte-level-with-failover-mirror-cluster/#mirrorcluster)). * Time to check each file between both nodes. #### Alternative * Put the many files to replicate in a virtual hard disk / virtual machine. * Only the files representing the virtual hard disk / virtual machine will be replicated and resynchronized in this case. ### Why a failover ≤ 32 replicated VMs? * Each VM runs in an independent mirror module. * Maximum of 32 mirror modules running on the same cluster. #### Alternative * Use an external shared storage and another VM clustering solution. * More expensive, more complex. ### Why a LAN/VLAN network between remote sites? * Automatic failover of the [virtual IP address](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/how-a-virtual-ip-address-works/) with 2 nodes in the same subnet. * Good bandwidth for resynchronization ([step 3](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/file-replication-byte-level-with-failover-mirror-cluster/#mirrorcluster)) and good latency for [synchronous replication](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/synchronous-replication-vs-asynchronous-replication/) (typically a round-trip of less than 2ms). #### Alternative * Use a [load balancer for the virtual IP address](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/how-a-virtual-ip-address-works/) if the 2 nodes are in 2 subnets (supported by SafeKit, especially in the cloud). * Use backup solutions with asynchronous replication for high latency network. ## High Availability Quick Installation Guide for Linux This guide explains how to set up a **farm cluster** for Linux using SafeKit, ensuring network load balancing and automatic failover. You can use the SafeKit AI 🤖 for assistance at any time. ### 1. Overview * **Architecture:** Implements a scalable, multi-node load-balanced farm with a virtual IP address. * **High Availability:** Features automatic health monitoring and seamless failover to **ensure service continuity**. ### 2. Installation * **Software:** Install the SafeKit engine on all servers. * **Module:** Download the pre-configured `farm.safe` application module. ### 3. Configuration * **Web Console:** Configure the Linux farm cluster. * **Monitoring:** Start monitoring and protecting the Linux application. ## Overview of the SafeKit / Linux solution The solution is described here: **[SafeKit: All-in-One Linux Load Balancing & High Availability Software](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/linux-load-balancing-failover/)**. ## Installation of the SafeKit / Linux solution (farm.safe) ### Prerequisites * You need the application that you want to put in a farm installed on 2 nodes or more (virtual machines or physical servers). ### Package installation on Linux * Install the free version of SafeKit on 2 Linux nodes. Note: the free trial includes all SafeKit features. At the end of the trial, you can activate permanent license keys without uninstalling the package. * After the download of safekit\_xx.bin package, execute it to extract the rpm and the safekitinstall script and then execute the **safekitinstall** script * Answer **yes** to firewall automatic configuration * Set the password for the web console and the default user **admin**. **Set the same password on all nodes.** [Download SafeKit (Linux) >](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/safekit-free-trial/) Note: the generic **farm.safe** module that you are going to configure is delivered inside the package. ## Step by step configuration of the SafeKit / Linux solution ### Prerequisites * Linux application installed on 2 nodes (or more). * Virtual IP load balancing requires nodes on the same LAN or extended LAN (L2) — routed L3 networks not supported (except with [cloud load balancers](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/safekit-user-guide-82/#Cloud)). ### 1. Launch the SafeKit console * Launch the web console in a browser on one cluster node by connecting to `http://localhost:9010`. * Enter `admin` as user name and the password defined during installation. You can also run the console in a browser on a workstation external to the cluster. ![Warning](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%2025%2025'%3E%3C/svg%3E)![Warning](https://safekit.eviden.com/wp-content/uploads/2022/07/warning-small.png) The configuration of SafeKit is done on both nodes from a single browser. ![Note](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%2025%2025'%3E%3C/svg%3E)![Note](https://safekit.eviden.com/wp-content/uploads/2022/07/note.png) To secure the web console, see [11. Securing the SafeKit web service](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/safekit-user-guide-82/#https) in the User's Guide. [![Start the SafeKit web console to configure the Linux cluster](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%20647%20479'%3E%3C/svg%3E "View full size")![Start the SafeKit web console to configure the Linux cluster](https://safekit.eviden.com/wp-content/uploads/2024/03/01-login-large.png "View full size")](/wp-content/uploads/2024/03/01-login-large.png) ### 2. Configure node addresses * Enter the node IP addresses, press the `Tab key` to check connectivity and fill node names. If either node1 or node2 has a red color, check connectivity of the browser to both nodes and check firewall on both nodes for [troubleshooting](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/safekit-user-guide-82/#Troubleshooting). * Then, click on `Save and apply` to save the configuration. * Check the `Success` ✅ message on both nodes. * If the configuration `Failure` ❌ occurs on one node, open the ▼ accordion for that node and review the messages. Note that you can use the SafeKit AI 🤖 for assistance. ![Note](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%2025%2025'%3E%3C/svg%3E)![Note](https://safekit.eviden.com/wp-content/uploads/2022/07/note.png) If you want, you can add a new `LAN and nodes` ( first ➕) to create a second heartbeat and a dedicated replication network. ![Note](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%2025%2025'%3E%3C/svg%3E)![Note](https://safekit.eviden.com/wp-content/uploads/2022/07/note.png) If you click on `Advanced configuration`, the `cluster.xml` file is displayed. This file is automatically populated by the console and deployed on the nodes. [![Enter the nodes of the Linux cluster](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%20757%20690'%3E%3C/svg%3E "View full size")![Enter the nodes of the Linux cluster](https://safekit.eviden.com/wp-content/uploads/2024/03/02-cluster-edit.png "View full size")](/wp-content/uploads/2024/03/02-cluster-edit.png) ### 3. Select a module * In `New module`, click on the `farm.safe` module. ![Note](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%2025%2025'%3E%3C/svg%3E)![Note](https://safekit.eviden.com/wp-content/uploads/2022/07/note.png) In the blue banner at the top, 🛜 `node1` represents the console connection node. This node relays requests to `node2` when required. ![Note](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%2025%2025'%3E%3C/svg%3E)![Note](https://safekit.eviden.com/wp-content/uploads/2022/07/note.png) The console looks for `xxx.safe` in the `Application_Modules/generic/` directory on the connection node (`node1`) if you placed a module there during installation. [![Choose the module for Linux](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%20755%20686'%3E%3C/svg%3E "View full size")![Choose the module for Linux](https://safekit.eviden.com/wp-content/uploads/2024/03/04-module-new.png "View full size")](/wp-content/uploads/2024/03/04-module-new.png) ### 4. Configure the module * In `Module startup at boot`, choose an automatic start of the module at boot without delay. * In `Macros` / `SERVICES`, enter the service names of your application, in the startup order, separated by commas. * In `Heartbeat networks`, you should have a single heartbeat network except if you have added a LAN at step 2. * In `Virtual IP addresses`, enter a virtual IP address. A virtual IP address is a standard IP address in the same IP network (same subnet) as the IP addresses of both nodes. Application clients must be configured with the virtual IP address (or the DNS name associated with the virtual IP address). * In `Load balancing rules`, set the service port to load balance (ex.: TCP 9010 in the example). * In `Load balancing rules`, set the load balancing rule, `Source address` or `Source port`: + with the source IP address of the client, the same client will be connected to the same node in the farm on multiple TCP sessions and retrieve its context on the node. + with the source TCP port of the client, the same client will be connected to different nodes in the farm on multiple TCP sessions (without retrieving a context). * In `Checkers`, you will be able to configure checkers if needed, such as process monitoring, custom checkers, TCP, ping, or split-brain checkers. For example, if a process name is displayed in `Monitored processes/services`, it will be monitored with a restart action in case of failure. Configuring a wrong process name will cause the module to stop right after its start. ![Note](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%2025%2025'%3E%3C/svg%3E)![Note](https://safekit.eviden.com/wp-content/uploads/2022/07/note.png) If you click on `Advanced configuration`, the `userconfig.xml` file is displayed. This file is automatically populated by the console and deployed on the nodes with the restart scripts. ![Note](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%2025%2025'%3E%3C/svg%3E)![Note](https://safekit.eviden.com/wp-content/uploads/2022/07/note.png) In a cloud deployment, you do not need to configure a virtual IP address and load balancing rules in SafeKit. The virtual IP and load balancing rules are managed at the [cloud load balancer level](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/safekit-user-guide-82/#Cloud). ![Note](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%2025%2025'%3E%3C/svg%3E)![Note](https://safekit.eviden.com/wp-content/uploads/2022/07/note.png) When you apply the SafeKit configuration, the `startup type` of services is automatically set to `Manual` in Windows services. This ensures that services do not start automatically when the system boots, but are instead started only when the module itself is started (the same applies on Linux). [![Enter the Linux farm module settings](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%20800%20729'%3E%3C/svg%3E "View full size")![Enter the Linux farm module settings](https://safekit.eviden.com/wp-content/uploads/2025/05/36-module-farm-config-edit-1.jpg "View full size")](/wp-content/uploads/2025/05/36-module-farm-config-edit-1.jpg) ### 5. Edit scripts (optional) * This step is optional and can be skipped in most cases, as the restart scripts are already pre-configured to restart services defined in the previous step. * So, click directly on `Next step`. * `start_both.ps1` starts all services in the order specified in the `SERVICES` list, while `stop_both.ps1` stops all services in the reverse order. * Additionally, `start_both.ps1` checks the startup of each service and stops the module if any service fails to start correctly. [![Enter the Linux module settings](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%201106%20473'%3E%3C/svg%3E "View full size")![Enter the Linux module settings](https://safekit.eviden.com/wp-content/uploads/2025/05/35-module-iis-edit-script-1.png "View full size")](/wp-content/uploads/2025/05/35-module-iis-edit-script-1.png) ### 6. Communication encryption (optional) * Keep encryption of communication between nodes. [![Communication encryption of the Linux module](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%201106%20373'%3E%3C/svg%3E "View full size")![Communication encryption of the Linux module](https://safekit.eviden.com/wp-content/uploads/2025/05/07-module-encryption-1.png "View full size")](/wp-content/uploads/2025/05/07-module-encryption-1.png) ### 7. Save and apply * `Save and apply` the configuration and scripts on both nodes. [![Save and apply the Linux module configuration](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%201106%20410'%3E%3C/svg%3E "View full size")![Save and apply the Linux module configuration](https://safekit.eviden.com/wp-content/uploads/2025/05/08-module-save-1.png "View full size")](/wp-content/uploads/2025/05/08-module-save-1.png) ### 8. Verify successful configuration * Check the `Success` ✅ message on both nodes and click on `Monitor modules`. * If the configuration `Failure` ❌ occurs on one node, open the ▼ accordion for that node and review the messages. Note that you can use the SafeKit AI 🤖 for assistance. [![Check the Linux module configuration success](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%201111%20434'%3E%3C/svg%3E "View full size")![Check the Linux module configuration success](https://safekit.eviden.com/wp-content/uploads/2025/05/09-module-save-check-1.png "View full size")](/wp-content/uploads/2025/05/09-module-save-check-1.png) ### 9. Start the farm cluster on node 1 and node 2 * ⋯ `Start` the farm cluster as shown in the image. [![Start the Linux cluster on both nodes](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%20431%20408'%3E%3C/svg%3E "View full size")![Start the Linux cluster on both nodes](https://safekit.eviden.com/wp-content/uploads/2024/03/11-monitoring-farm-stop-stop-start.png "View full size")](/wp-content/uploads/2024/03/11-monitoring-farm-stop-stop-start.png) ### 10. Wait for the transition to UP (green) / UP (green) Node 1 and node 2 should reach the UP (green) state, which means that the `start_both` script has been executed on node 1 and node 2. ![Warning](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%2025%2025'%3E%3C/svg%3E)![Warning](https://safekit.eviden.com/wp-content/uploads/2022/07/warning-small.png) If UP (green) is not reached or if the application is not started, analyze why with the [module log 🖼️](/wp-content/uploads/2024/03/37-module-log-farm-script.png) of node 1 or node 2. * Click the 🔍 **log** icon of `node1` or `node2` to open the module log and look for error messages such as a checker detecting an error and stopping the module. * Click on `start_both` in the log: output messages of the script are displayed on the right and errors can be detected such as a service incorrectly started. * Use the SafeKit AI 🤖 for assistance with log messages. ![Note](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%2025%2025'%3E%3C/svg%3E)![Note](https://safekit.eviden.com/wp-content/uploads/2022/07/note.png) Note that you have a 🕒 **[timeline 🖼️](https://safekit.eviden.com/wp-content/uploads/2026/05/safekit-console-timeline.png)** that can be helpful to understand what happens in the cluster. [![The Linux cluster is started](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%20456%20407'%3E%3C/svg%3E "View full size")![The Linux cluster is started](https://safekit.eviden.com/wp-content/uploads/2024/03/15-monitoring-up-up.png "View full size")](/wp-content/uploads/2024/03/15-monitoring-up-up.png) ### 11. Testing SafeKit brings a built-in test in the product: * + Configure a rule for TCP port 9010 with a load balancing on source TCP port. + Connect an external workstation outside the farm nodes. + Start a browser on http://virtual-ip:9010/safekit/mosaic.html. You should see a mosaic of colors depending on nodes answering to HTTP requests. * Stop one UP (green) node by scrolling down its contextual menu and clicking Stop. * Check that there is no more TCP connections on the stopped node and on the virtual IP address. ![Note](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%2025%2025'%3E%3C/svg%3E)![Note](https://safekit.eviden.com/wp-content/uploads/2022/07/note.png) Find more details, along with videos, in the [SafeKit Online Training](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/safekit-on-line-training/). [![Test the virtual IP address of Linux with the mosaic](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%20325%20113'%3E%3C/svg%3E "View full size")![Test the virtual IP address of Linux with the mosaic](https://safekit.eviden.com/wp-content/uploads/2024/03/appli-19.png "View full size")](https://safekit.eviden.com/wp-content/uploads/2024/03/appli-19.png) ### 12. Support * For getting support, take 2 SafeKit `Snapshots` (2 .zip files), one for each node. ![Note](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%2025%2025'%3E%3C/svg%3E)![Note](https://safekit.eviden.com/wp-content/uploads/2022/07/note.png) [More information on the support here](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/safekit-support/). [![Take the Linux snaphots for support](data:image/svg+xml,%3Csvg%20xmlns='http://www.w3.org/2000/svg'%20viewBox='0%200%20607%20443'%3E%3C/svg%3E "View full size")![Take the Linux snaphots for support](https://safekit.eviden.com/wp-content/uploads/2024/03/32-snapshots-farm.png "View full size")](/wp-content/uploads/2024/03/32-snapshots-farm.png) ## 🔍 SafeKit High Availability Navigation Hub Explore SafeKit: Features, technical videos, documentation, and free trial | Resource Type | Description | Direct Link | | --- | --- | --- | | **Key Features** | Why Choose SafeKit for Simple and Cost-Effective High Availability? | [See Why Choose SafeKit for High Availability](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/#why-choose-safekit-for-ha "Discover SafeKit features for simple and cost-effective high availability") | | **Use Cases** | Explore How SafeKit Ensures the High Availability of Critical Infrastructure | [See All Use Cases (OEM Software, Edge Servers, SCADA, and more)](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/#safekit-use-cases "Explore SafeKit high availability use cases") | | **Deployment Model** | All-in-One SANless HA: Shared-Nothing Software Clustering | [See SafeKit All-in-One SANless HA](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/#all-in-one-sanless-ha "Learn about all-in-one SANless high availability with shared-nothing software clustering") | | **HA Strategies** | SafeKit: Infrastructure (VM) vs. Application-Level High Availability | [See SafeKit HA & Redundancy: VM vs. Application Level](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/#safekit-ha-redundancy-choices "Compare VM-level redundancy with SafeKit application-level high availability strategies") | | **Technical Specifications** | Technical Limitations for SafeKit Clustering | [See SafeKit High Availability Limitations](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/#safekit-ha-limitations "Technical requirements and limitations for SafeKit application clustering") | | **Proof of Concept** | SafeKit: High Availability Configuration & Failover Demos | [See SafeKit Failover Tutorials](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/#safekit-failover-tutorials "Step-by-step videos on SafeKit high availability, from installation to automated failover") | | **Architecture** | How the SafeKit Mirror Cluster works (Real-Time Replication & Failover) | [See SafeKit Mirror Cluster: Real-Time Replication & Failover](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/#safekit-mirror-cluster "See technical architecture and failover mechanism of SafeKit Mirror Cluster") | | **Architecture** | How the SafeKit Farm Cluster works (Network Load Balancing & Failover) | [See SafeKit Farm Cluster: Network Load Balancing & Failover](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/#safekit-farm-cluster "Technical overview of SafeKit Farm Cluster architecture with network load balancing") | | **Competitive Advantages** | Comparison: SafeKit vs. Traditional High Availability (HA) Clusters | [See SafeKit vs. Traditional HA Cluster Comparison](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/#safekit-ha-comparison "Detailed comparison of SafeKit software vs traditional hardware-based HA clusters") | | **Technical Resources** | SafeKit High Availability: Documentation, Downloads & Trial | [See SafeKit HA Free Trial & Technical Documentation](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/#safekit-ha-technical-resources "Access SafeKit free trial, technical documentation, and high availability white papers") | | **Pre-configured Solutions** | SafeKit Application Module Library: Ready-to-Use HA Solutions | [See SafeKit High Availability Application Modules](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/#safekit-ha-application-modules "Browse the library of pre-configured SafeKit modules for automated application failover") | [🧑 Contact us](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/contact-us-for-safekit/) [🎁 SafeKit free trial](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/safekit-free-trial/) [🏅 Free certification](https://training.my.evidian.com/mod/page/view.php?id=712) [💰 Perpetual license cost](https://safekit.eviden.com/products/high-availability-software-for-application-clustering/get-a-quote-safekit-en/)