Site Tools


basic-network

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
basic-network [2024/02/20 19:13] – [WAN(x) Settings] -clarity, condense of WAN load weight hogwildbasic-network [2024/05/07 04:01] – [WAN(x) Settings] hogwild
Line 9: Line 9:
  \\  \\
  
-**Number of WAN ports**: This lets you select the number of WAN ports to be used on the device.+**Number of WAN ports**: lets you select the number of WAN ports to be used on the device.
  
 On routers with only one physical WAN interface, options with more WAN ports will be greyed out. You can select only “1 WAN” on such devices. On routers with only one physical WAN interface, options with more WAN ports will be greyed out. You can select only “1 WAN” on such devices.
Line 15: Line 15:
  \\  \\
  
-**Tune route cache**: This is intended for MultiWAN configurations with load balancing.+**Tune route cache**: is intended for MultiWAN configurations with load balancing.
  
 This setting is advised when two or more WANs have a weight larger than "0". Basically, it uses kernel tweaks to improve workload sharing. For more details, see the [[basic-network#network_notes_and_troubleshooting|Notes]] section below.  \\  \\ This setting is advised when two or more WANs have a weight larger than "0". Basically, it uses kernel tweaks to improve workload sharing. For more details, see the [[basic-network#network_notes_and_troubleshooting|Notes]] section below.  \\  \\
  
-**Check Connections Every: **This is an easy way for FreshTomato to automatically test WAN connection reliability. (Default: Disabled). Choosing any setting but [Disabled] will execute the Watchdog script. This sets how often the router pings to check it is still connected to the Internet.+**Check Connections Every: **is an easy way for FreshTomato to automatically test WAN connection reliability. (Default: Disabled). Choosing any setting but [Disabled] will execute the Watchdog script. This sets how often the router (regularly) pings to check it is still connected to the Internet.
  
 The Watchdog script uses ping or traceroute to test WAN connection status. The Watchdog script uses ping or traceroute to test WAN connection status.
Line 25: Line 25:
 Choosing a setting other than Disabled will make "Target 1" and "Target 2" fields appear. Choosing a setting other than Disabled will make "Target 1" and "Target 2" fields appear.
  
-  * Target 1 -** **Here, enter the address of the first host to ping regularly (Default: Google.com) +  * Target 1 -** **Here, enter the address of the first host to ping (Default: Google.com) 
-  * Target 2 - Here, enter the address of the second host to ping regularly (Default: Microsoft.com)\\   \\+  * Target 2 - Here, enter the address of the second host to ping (Default: Microsoft.com)\\   \\
  
  
Line 35: Line 35:
 Depending on the type selected, other settings specific to that type of connection will be shown or hidden. Depending on the type selected, other settings specific to that type of connection will be shown or hidden.
  
-**Type: **This sets the connection mode the WAN interface will use to connect to your ISP. (Default: DHCP).+ \\ 
 + 
 +**Type: **sets the connection mode the WAN interface will use to connect to your ISP. (Default: DHCP).
  
   * **DHCP - **Your ISP's DHCP server will dynamically assign a WAN IP lease to FreshTomato.    * **DHCP - **Your ISP's DHCP server will dynamically assign a WAN IP lease to FreshTomato. 
Line 42: Line 44:
   * **PPPoE - **The WAN port will respond to authentication requests from your ISP's PPPoE server.     * **PPPoE - **The WAN port will respond to authentication requests from your ISP's PPPoE server.  
     * This is most often used for DSL networks.     * This is most often used for DSL networks.
-    * This stores in FreshTomato the PPPoE username and password assigned by your ISP. +    * FreshTomato store the PPPoE username and password assigned by your ISP. 
-    * If authentication succeeds, the PPPoE server allows logon to the ISP network, and a DHCP server assigns you a WAN IP lease.+    * If authentication succeeds, the PPPoE server allows logon to the ISP network, \\ and a DHCP server assigns you a WAN IP lease.
     * Leave the //Service Name// field blank.     * Leave the //Service Name// field blank.
-    * Starting with release 2021.3, support for Baby Jumbo Frames (RFC 4638) was added in the [[advanced-misc|Miscellaneous]] menu. +    * Starting with release 2021.3, support for Baby Jumbo Frames (RFC 4638) was added \\ in the [[advanced-misc|Miscellaneous]] menu. 
-    * When using Baby Jumbo Frames, set MTU to 1500, consistent with the Baby Jumbo Frames change. (See [[https://wiki.freshtomato.org/doku.php/basic-network#network_notes_and_troubleshooting|Notes]]) \\  \\+    * When using Baby Jumbo Frames, set MTU to 1500, consistent with the Baby Jumbo \\ Frames change. (See [[https://wiki.freshtomato.org/doku.php/basic-network#network_notes_and_troubleshooting|Notes]]) \\  \\
  
-  * **Static - **This choice will configure your WAN port with a static IP. +  * **Static - **will configure your WAN port with a static IP. 
     * You must manually enter the following settings in FreshTomato, from your ISP:     * You must manually enter the following settings in FreshTomato, from your ISP:
       * Static IP address       * Static IP address
Line 54: Line 56:
       * Gateway address       * Gateway address
       * DNS server addresses       * DNS server addresses
-    * This mode is commonly used for business accounts, when the IP address shouldn't change. \\  \\+    * This mode is usually used for business accounts, when an IP address shouldn't change. \\  \\
  
-  * **PPTP - **This configures the WAN port to use Microsoft's PPTP (VPN) tunneling protocol to connect. +  * **PPTP - **configures the WAN port to use Microsoft's PPTP (VPN) protocol to connect. 
     * This section will require you to enter:      * This section will require you to enter: 
       * a username       * a username
Line 62: Line 64:
       * gateway server settings (given by your ISP). \\  \\       * gateway server settings (given by your ISP). \\  \\
  
-  * **L2TP - **Choosing this configures the WAN port to connect using Cisco's Layer Two Tunnelling Protocol. +  * **L2TP - **configures the WAN port to connect using Cisco's Layer Two Tunneling Protocol. 
-    * FreshTomato will require you enter the following, provided by your ISP:+    * FreshTomato requires you enter the following, provided by your ISP:
       * L2TP username       * L2TP username
       * Password       * Password
Line 70: Line 72:
       * Gateway setting \\  \\       * Gateway setting \\  \\
  
-  * **3G modem - **This setting will enable support for 3G GSM (cellular) USB modems.  +  * **3G modem - **enables support for 3G GSM (cellular) USB modems.  
-    * Ensure USB and 3G/4G/5G modem support are checked in [[nas-usb|USB Support]] for the modem to be detected. \\  \\+    * For modem detection, ensure USB and 3G/4G/5G modem support are enabled in [[nas-usb|USB Support]]. \\  \\
  
-  * **4G/LTE - **This enables support for fourth generation GSM (cellular/ LTE USB modems.  +  * **4G/LTE - **enables support for fourth generation cellular/LTE USB modems.  
-    * When choosing 4G, PIN code and APN fields appear. These must be filled with correct settings (see below).  +    * When using 4G, PIN code and APN fields appear. You must fill these with correct settings (see below).  
-    * Check USB and 3G/4G/5G modem support are enabled in the [[nas-usb|USB Support]] menu for the modem to be detected. \\  \\+    * For modem detection, check USB and 3G/4G/5G modem support are enabled in [[nas-usb|USB Support]]. \\  \\
  
-  * **Disabled - **This disables the physical WAN port on your router.  +  * **Disabled - **disables the physical WAN port on your router.  
-    * This effectively makes your FreshTomato device function only as a switch (if it has that function) and/or; +    * This effectively makes your device function only as a switch (if it has that function) and/or; 
-    * It may effectively make your device function as a WiFi access point (if it has that function). \\  \\+    * It may effectively make your device function as a WiFi A/P (if it has that function). \\  \\
  
-**Wireless Client Mode:  **This enables FreshTomato's Wireless Client mode.+**Wireless Client Mode:  **enables FreshTomato's Wireless Client mode.
  
-This mode lets the router act as a client to connect to another router/AP, similar to how a WiFi adapter would.  \\ (For details, see Wireless Mode tables below).+This mode lets the router act as a client to connect to another router/AP, similar to the way a WiFi adapter would.  \\ (For details, see Wireless Mode tables below).
  
   * Disabled - Wireless Client mode will be disabled.   * Disabled - Wireless Client mode will be disabled.
Line 95: Line 97:
  \\  \\
  
-**Load Balance Weight:   **This option is** **visible only when number of WANs > 1. It can be set between 0 and 256.\\+**Load Balance Weight:   **is** **visible only when number of WANs > 1. It can be set between 0 and 256.\\
  
-{{:pasted:20240219-103900.png}}\\+{{:pasted:20240219-103900.png}}\\  \\
  
-When configuring a router in a MultiWAN configuration, it's important to understand that the MultiWAN function performs load-sharing of the links. Load sharing is performed on a per-session basis to prevent issues with interactive traffic, such as real-time voice/video, or RDP. Setting the Load Balance Weight on each interface adjusts how that interface will participate in MultiWAN activities. The examples below provide more details.\\  \\ Load Balance Weight: 0\\ If "0" is used, FreshTomato will not actively route traffic, but the WAN connection with weight "0" will automatically be enabled if all other primary interfaces with weight greater than "1" fail. This is commonly used in "failover" scenarios. When an interface with weight "0" is us auto-enabled, it will be assigned a weight of 1.+When a router is configured in a MultiWAN configuration, the MultiWAN function performs load sharing of the links. Load sharing is performed on a per-session basis to prevent issues with interactive traffic, such as real-time voice/video, or RDP. This is because your links might have different speeds and per-packet load-sharing would generate Out-of-order packets. That could make interactive traffic pretty much unusable. Setting Load Balance Weight on each interface adjusts how the interface will participate in MultiWAN activities.
  
-Nowlet's assume we have 2x WANs:+Here are some examples:\\  \\ Load Balance Weight: 0  (Failover)\\ If 0 is usedFreshTomato won't actively route traffic if other WAN interfaces are functional. However, the WAN connection with weight "0" will be automatically enabled if there is a failure of all other WAN interfaces with a weight or 1 or more. This is commonly used in "failover" scenarios. When an interface with weight "0" it is automatically enabled, it will be assigned a weight of 1.
  
-WAN0="weight 0"+For example:
  
-WAN1="weight 1".+Let's assume we have 2 WANs, as follows:
  
-At some point, WAN1 fails. As soon as the failure is noticed, WAN0 will bring itself to life and begin routing packets. Later, WAN1 recovers its connectivity. As soon as FreshTomato recognizes this, (seconds to minutes), WAN0 will go back to an idle status while the traffic is re-routed through the resuscitated WAN1. This recovery, back to the originally active interface is also known as **preempting. **Preempting is FreshTomato's default (and fixed) behaviour.\\  \\ Load Balance Weight: 1\\ Any value higher than "0" causes an interface to actively route packets. A weight of "1" doesn't necessarily mean much by itself, as it needs to be compared with the load balance weights of other Interfaces to direct functionality. If WAN0="weight 0" and WAN1="weight 1", that means WAN1 is handling 100% of the traffic. \\  \\ Load Balance Weight: 5\\ An interface set with e.g. weight 5 would essentially handle 5 new sessions before any other interface is to be used.\\  \\ In a practical example let's say we have 3 WANs:\\  \\  WAN0 = weight 0\\  WAN1 = weight 1\\  WAN2 = weight 5\\  \\  In this scenario WAN0 is to be used only if both WAN1 and WAN2 are both in failed state (can't route packets). WAN1 will handle the very 1st LAN client new session going through the router, where WAN2 is to handle the 2nd,3d,4th,5th,6th. So what's happens to the 7th? It starts again from WAN1 with 1 session and WAN2 will take care of the next 5 new sessions so 8th,9th,10,11,12th.\\   \\+WAN0="weight 0"
  
-very important final point on MultiWAN load-sharing: **You can only affect traffic outbound**. This implicitly means that returning traffic will always aim the FT'WAN interface that originated the trafficAs the allocation of new session to a WAN is dynamic, you could control what traffic gets allocated to what Interface (a.k.a. sticky connection) via the [[advanced-pbr|MultiWAN routing]] configuration page.+WAN1="weight 1" 
 + 
 +At some point, WAN1 fails. As soon as this failure is noticed, WAN0 will activate (assigned with weight 1) and begin routing packets. Later, WAN1 recovers its connectivity. As soon as FreshTomato recognizes this, (within seconds or minutes), WAN0 will be set back to idle status while traffic is rerouted through the revived WAN1. This process of recovering back to the originally active interface is called //preempting//.** **FreshTomato uses Preempting as its default (and fixed) behavior.\\  \\ Load Balance Weight: 1\\ Any value higher than "0" causes an interface to actively route packets. Weights are relative, so a weight of "1" doesn't mean much. Each weight is compared to the Load Balance Weights of other Interfaces to direct functionality. One way of understanding this is to remember: "1=100% and 0=0%". Thus, if WAN0=“weight 0” and WAN1=“weight 1”, that would mean WAN1 is handling 100% of the traffic.​\\  \\ Load Balance Weight: 5\\ An interface set with, for example, weight 5, would essentially handle 5 new sessions before any other interface is to be used.\\  \\ For example, say we have 3 WANs, as follows:\\  \\  WAN0 = weight 0\\  WAN1 = weight 1\\  WAN2 = weight 5\\  \\ In this case, WAN0 will be used only if both WAN1 and WAN2 are both in a failed state, and are unable to route packets. WAN1 will handle the very first new LAN client session going through the router. WAN2 is set to handle the second, third, fourth, fifth and sixth sessions. The seventh new session starts again from WAN1, as it would be treated as a another first new LAN client session. WAN2 will then handle the next five new sessions, meaning the eighth, ninth, tenth eleventh and twelfth sessions.\\   \\ One final point about MultiWAN load sharing: **These settings only affect outbound traffic**. Return traffic will always try to return to the WAN interface from which it originated. Since the allocation of new session to a WAN is dynamic, you could control what traffic gets allocated to which Interface (a.k.a. "sticky connection") via the [[advanced-pbr|MultiWAN routing]] configuration page.
  
  \\  \\
  
-**Modem device: **Here, you specify the 3G modem's Linux device path/filename.+**Modem device: **Here, specify the 3G modem's Linux device path/filename.
  
-  * If you don't know what to choose, check the [[dongle_compatibility|3G/4G/5G Dongle compatibility]] page to see if your modem is listed+  * If you're unsure what to choose, see if your modem is listen in [[dongle_compatibility|3G/4G/5G Dongle compatibility]]. 
-  * To ensure your modem is detected, check [[nas-usb|USB Support]] is enabled in the [[nas-usb|USB Support]] menu. +  * For proper modem detection, check [[nas-usb|USB Support]] is enabled in the [[nas-usb|USB Support]] menu. 
-  * When 3G modem or 4G/LTE is set as the WAN type, other fields appear, prompting for more information.+  * When 3G modem or 4G/LTE is set as WAN type, other fields appear, requiring more information.
   * The Default device filename is the first serial device on the first USB port: (/dev/ttyUSB0).    * The Default device filename is the first serial device on the first USB port: (/dev/ttyUSB0). 
-  * The “tty” part of the device's filename represents a serial device. +    * The “tty” part of the device's filename represents a serial device. 
-  * The “USB0” part of the device's filename means the device is connected to the first USB port. +    * The “USB0” part of the device's filename means the device is connected to the first USB port. 
-  * Devices listed as "/ttyUSB" use the newer Serial→USB device driver framework. +    * Devices listed as "/ttyUSB" use the newer Serial→USB device driver framework. 
-    * This device type uses Linux's serial modem driver framework. +      * This device type uses Linux's serial modem driver framework. 
-  * If the interface lists: “/dev/ttyACM0" instead, “ACM” means device type is: “Abstract Control Model” +  * If you see: “/dev/ttyACM0" instead, “ACM” means device type is: “Abstract Control Model” 
-    * ACM modems let the modem hardware perform analog functions.+    * An ACM modem lets the modem hardware perform analog functions. 
 + 
 + \\
  
 To get device details, you could also log on to FreshTomato via Telnet/SSH and use the lsusb or dmesg commands . To get device details, you could also log on to FreshTomato via Telnet/SSH and use the lsusb or dmesg commands .
Line 130: Line 136:
  \\  \\
  
-**PIN Code: **This is the 3-digit PIN code for the SIM card associated with your cell account.+**PIN Code: **is the 3-digit PIN code for the SIM card associated with your cell account.
  
   * Leave this blank if your SIM card code was deactivated. \\  \\   * Leave this blank if your SIM card code was deactivated. \\  \\
  
-**Modem init string: **Here, enter the modem's default initialization string.+**Modem init string: **is where you enter the modem's default initialization string.
  
-  * This will come from your cell provider, or the modem manufacturer. (Default: *99#). \\  \\+  * This will come from your cellular provider, or modem manufacturer. (Default: *99#). \\  \\
  
-**APN: **The access point name (provided by your cell carrier).+**APN: **is the access point name (provided by your cell carrier).
  
   * This specifies a gateway to route data between your carrier and the Internet. (Default: internet). \\  \\   * This specifies a gateway to route data between your carrier and the Internet. (Default: internet). \\  \\
  
-**Username: **Here, enter the (carrier-provided) username to access your cell carrier's APN gateway.+**Username: **here, enter the (carrier-provided) username to access your cell carrier's APN gateway.
  
   * Some carriers don't require this info. \\  \\   * Some carriers don't require this info. \\  \\
  
-**Password: **Here, enter the (carrier-provided) password to authenticate to your cell carrier's APN gateway.+**Password: **here, enter the (carrier-provided) password to authenticate to your cell carrier's APN gateway.
  
   * Some carriers do not require this info. \\  \\   * Some carriers do not require this info. \\  \\
  
-**Network Type: **This menu appears when WAN type is set to 4G/LTE. (Default setting: 4G/3G/2G).+**Network Type: **appears when WAN type is set to 4G/LTE. (Default setting: 4G/3G/2G).
  
   * The default setting configures FreshTomato to start negotiating with a 4G connection. \\ If that fails, it falls back to negotiating a 3G connection, and failing that, a 2G connection. \\  \\   * The default setting configures FreshTomato to start negotiating with a 4G connection. \\ If that fails, it falls back to negotiating a 3G connection, and failing that, a 2G connection. \\  \\
Line 156: Line 162:
 **DNS Server: ** **DNS Server: **
  
-  * AUTO - FreshTomato uses DNS server addresses included in your Internet Provider's DHCP lease. +  * AUTO - FreshTomato uses DNS server addresses included in your ISP's DHCP lease. 
-  * Manual - Enables the DNS server function (dnsmasq). This makes "DNS 1" and "DNS 2" fields appear. +  * Manual - Enables the DNS server function (dnsmasq). The "DNS 1" and "DNS 2" fields appear. 
-    * DNS 1 - Enter the first DNS server address here (if DNS Server is set to Manual). +    * DNS 1 - Enter DNS server address here (if DNS Server is set to Manual). 
-    * DNS 2 - Enter the second DNS server address here (if DNS Server is set to Manual).+    * DNS 2 - Enter DNS server address here (if DNS Server is set to Manual).
  
- \\ Manually-set DNS servers are useful if your ISP'DNS servers are slow/unreliable. Also, some can provide content filtering. \\  \\+ \\ Manually-set DNS servers are useful if your ISP DNS servers are slow/unreliable. Some can provide content filtering. \\  \\
  
-**MTU:**  This sets the Maximum Transmission Unit, (maximum Ethernet frame size) for traffic between WAN and LAN.+**MTU:**  sets the Maximum Transmission Unit, (Ethernet frame size) for traffic between WAN and LAN.
  
-This is only for the WAN interface. It won't affect LAN traffic. However, different MTU sizes among devices can cause problems.+This is only for the WAN interface. It won't affect LAN traffic. Different MTU sizes among devices may cause problems.
  
-  * (Default: 1500) - This is typical for Ethernet devices, and is usually suitable. The Manual field value is greyed out and fixed. +  * (Default: 1500) - is typical for Ethernet devices, and typical. The Manual field value is greyed out/fixed. 
-  * Manual - Choosing this lets you to enter a custom number in the field beside it. Jumbo Frame sizes start at 2000 bytes. \\  \\+  * Manual - lets you to enter a custom value in the field beside it. Jumbo Frames start at 2000 bytes.\\  \\
  
-**Use DHCP:**  This function is rarely used, and you are advised to leave it disabled.+**Use DHCP:**  is rarely used. You are advised to leave it disabled.
  
   * On a few Internet providers, addressing is separated from PPPoE functionality. \\  \\   * On a few Internet providers, addressing is separated from PPPoE functionality. \\  \\
  
-**Single Line MLPPP**: This is outdated, and rarely used nowadays.+**Single Line MLPPP:** is outdated, and rarely used nowadays.
  
-Multilink PPP is a version of the PPP protocol that lets you bond two or more physical connections to increase apparent bandwidth. \\ Single Line MLPPP is similar, but lets you use one modem to bond the bandwidth of multiple PPPoE sessions. \\ A side effect of using this is that it bypassed some Internet Providers' bandwidth throttling. \\ \\  \\+Multilink PPP is a version of the PPP protocol that lets you bond two or more physical connections to increase apparent bandwidth. \\ Single Line MLPPP is similar, but lets you use one modem to bond the bandwidth of multiple PPPoE sessions. \\ A side effect of using this was that it bypassed some ISP'bandwidth throttling. \\ \\  \\
  
-**Route Modem IP: **This function lets you access a modem "behind a router" with a simple configuration change. (Default: Off)+**Route Modem IP: **lets you access a modem "behind a router" with a quick configuration change. (Default: Off)
  
   * When using a separate modem and router, usually you set the modem in bridge mode/PPPoE passthrough mode.   * When using a separate modem and router, usually you set the modem in bridge mode/PPPoE passthrough mode.
Line 405: Line 411:
     * This is usually only for advanced users. \\ \\     * This is usually only for advanced users. \\ \\
  
-**Shared Key:**  Here, enter the shared key to authenticate WiFi clients on the LAN. The field shows asterisks until you click your cursor in it. \\ \\ +**Shared Key:**  Here, enter the shared key to authenticate WiFi clients on the LAN. Asterisks are shown until you insert your cursor. \\ \\
- +
-**Group Key Renewal:**  This sets how often encryption keys are used between clients and the router/AP are rotated/changed. \\ This is a part of the WPA protocol. (Default: 3600 seconds = 1 hour).+
  
-Starting with release 2023.5 and newer the user can adjust rotation interval within the following limits: \\ +**Group Key Renewal:**  This sets how often encryption keys used between clients and the router are rotated/changed. \\ This is a part of the WPA protocol. (Default: 3600 seconds = 1 hour).
-1 sec up to 2592000 sec [for mips RT-N mips-RT-AC and all ARM routers] \\ +
-0 => disabled (not recommended)+
  
-Releases up to 2023.can adjust this value within the following limits: +Starting with release 2023.5, you can adjust the key rotation interval within the following limits:\\ From 1 sec to 2592000 sec   [for all ARM routers and MIPS RT-N / MIPS-RT-AC\\ 0 = disabled   (not recommended)
-60 sec up to 7200 sec [all routers]+
  
 +In releases up to 2023.4, you can set this within the following limits: 60 sec to 7200 sec [all routers]
  
  
basic-network.txt · Last modified: 2024/05/07 06:03 by hogwild