Differences

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

--- splashd [2023/06/21 01:36] – -condense hogwild
+++ splashd [2025/07/01 02:30] (current) – -condense, grammar hogwild
@@ Line 1: / Line 1: @@
 ====== Captive Portal ======
-The Captive Portal works in a similar way to a WiFi hotspot in a public place. Captive Portal presents WiFi users with a simple webpage, prompting them to agree to terms before being allowed to access the network. If the user clicks on "**OK, I agree!**", the gateway daemon changes firewall rules on the gateway so that traffic passes for that client (based on the IP/MAC address). This prevents users from accessing the Internet automatically without agreeing to certain Terms of Use.
+The Captive Portal works in a similar way to a WiFi hotspot in a public place. It presents WiFi users with a simple webpage, and prompts them to agree to terms before allowing them access to the network. If the user clicks on "**OK, I agree!**", the gateway daemon changes gateway firewall rules and traffic passes for that client (based on its IP/MAC address). This prevents users from accessing the Internet without agreeing to the Terms of Use.
+ \\
 The Captive Portal module is called "NoCatSplash". Older versions were named "NoCatAuth".
-Captive Portal is ideal for public/semi-public networks to remind end users of the legal responsibilities linked to Internet access. The requirements are simple. That means it can also be useful in when you simply want people to know whose network they are using. (Default: Disabled).
+Captive Portal is ideal for public/semi-public networks, to remind users of the legal responsibilities linked to Internet access. The requirements are simple. That means it can also be useful when you simply want people to know whose network they are using. (Default: Disabled).
- \\  [[https://wiki.freshtomato.org/lib/exe/detail.php?id=captive_portal&media=f81bc4e3e20ed262717281fd5a2e57b4.png|{{:f81bc4e3e20ed262717281fd5a2e57b4.png}}]]
+ \\
+**Enable function:** makes FreshTomato users see a Welcome banner when they try to access the Internet.
  \\
-**Captive Site Forwarding:** When active, the 'homepage' (see definition below) will appear until the user agrees to the terms in the Welcome Banner.
+**Interface:** lets you select a bridge interface on which Captive Portal will listen for connections.
-**Home page:** This is the URL that will appear after the user agrees to the Welcome Banner terms.
+ \\
-**Welcome html Path:** This is the path to the location of the Welcome banner .html page.
+**Gateway Name:** lets you specify the name of the gateway to appear in the Welcome banner.
-**Logged Timeout:** The time period (seconds) during which no Welcome banner appears when you access the device. (Default: 3600s).
+ \\ [[https://wiki.freshtomato.org/lib/exe/detail.php?id=captive_portal&media=f81bc4e3e20ed262717281fd5a2e57b4.png|{{:f81bc4e3e20ed262717281fd5a2e57b4.png?406}}]]
-**Idle Timeout:** The period, in seconds, before the client sees the splash screen again, and must agree to the terms again to regain network access.
+ \\
-**Max Missed ARP:** How many times a client can be missing from the ARP cache before the connection is closed. (Default: 5).
+**Captive Site Forwarding:** makes the "homepage" appear until the user agrees to the Welcome Banner terms.
-**Log Info Level:** How much detail will be included in log messages from this module.
+ \\
+**Home page:** the URL that will appear after the user agrees to the Welcome Banner terms.
+ \\
+**Welcome html Path:** the path to the location of the Welcome banner .html page.
+ \\
+**Logged Timeout:** the period (in seconds) during which no Welcome banner appears when you access the device. \\ (Default: 3600s).
+ \\
+**Idle Timeout:** the period, (seconds), before the client sees the splash screen again, and agrees to the terms again.
+ \\
+**Max Missed ARP:** how many times a client can be missing in the ARP cache before the connection is closed. \\ (Default: 5).
+ \\
+**Log Info Level:** specifies how much detail will be included in log messages from this module.
   * Level 0=Silent.
   * Level 10=Verbose.
-(Default: 2).
+ \\ (Default: 2).
-**Gateway Port:** This is the port to be used by the Captive Portal for page redirection. (Ports 1 to 65534). (Default: 5280).
+ \\
-**Excluded/Included ports to be redirected: **Here, enter the port numbers you wish to be:
+**Gateway Port:** the port the Captive Portal will use for page redirection. (Ports 1 to 65534).
-  * Included (defines port numbers the user is allowed to use after login) or;
+(Default: 5280).
-  * Excluded (defines port numbers the user //is not//  allowed to use after login \\ and which FreshTomato redirects away from the client).
-Leave blank spaces between port numbers when configuring them. For example: "25 110 4662 4672".
+ \\
-Using both Included and Excluded ports at the same time is not recommended. This can cause conflicts relating to which ports are allowed or not.
+**Excluded/Included ports to be redirected: **the port numbers you wish to be either:
-**URL excluded from the portal:**  URLs/links that can be accessed without the Welcome screen appearing. URLs entered must be separated by spaces.
+ \\
-**MAC address whitelist:**  Here, enter the MAC addresses of clients to be excluded from Portal functions. These devices will have no barriers to Internet access. MAC Addresses must be separated by spaces.
+  * Included - defines port numbers a user is allowed to use after login
+  * Excluded - defines port numbers a user //is not//  allowed to use after login) \\ and which FreshTomato redirects away from the client).
+ \\
+Separate port numbers with blank spaces when configuring them. Do not use Included //and// Excluded ports simultaneously. It can cause conflicts relating to whether ports are allowed or not.
+ \\
+**URL excluded from the portal:**  enter URLs/links that can be accessed without the Welcome screen appearing.  \\ Entries must be separated by spaces.
+ \\
+**MAC address whitelist:**  enter the MAC addresses of clients to exclude from Portal functions. \\ These devices will have no barriers to Internet access. Entries must be separated by spaces.
+ \\
-**Customized Splash File Path:**  Here you can upload your personal Welcome banner that will override the default one.
+**Customized Splash File Path:** lets you upload a personal Welcome banner to override the default one.
  \\
-**WARNING: If Login Time expires, you must return to the splash page to regain network access. **\\ **After you click "OK, I Agree!", nothing indicates when your usage period will expire. **\\ **You may lose Internet Access without warning.**
+**WARNING: If the Login Time expires, you must return to the splash page to regain network access. **\\ **After you click "OK, I Agree!", nothing indicates when your usage period will expire. **\\ **You may lose Internet Access without warning.**
  \\ [[https://wiki.freshtomato.org/lib/exe/detail.php?id=captive_portal&media=c89968d019cda7d23009f7f6051b8e89.png|{{:c89968d019cda7d23009f7f6051b8e89.png}}]]

FreshTomato Wiki

User Tools

Site Tools

Differences

Page Tools