Configure captive portals

Captive portals are commonly used on public-access networks to require users to login or accept terms and conditions before accessing the internet.

To configure captive portals:


  1. Log into Digi Remote Manager, or log into the local Web UI as a user with full Admin access rights.
  2. Access the device configuration:

    1. Locate your device as described in Use Digi Remote Manager to view and manage your device.
    2. Click the Device ID.
    3. Click Settings.
    4. Click to expand Config.

    1. On the menu, click System. Under Configuration, click Device Configuration.

      The Configuration window is displayed.

  3. Click Firewall > Captive portals.
  4. For Add captive portal:, enter a name for the portal and click .

    The captive portal configuration window is displayed.

    The captive portal is enabled by default. To disable, toggle off Enable.

  5. For Interface, select the network interface for the portal.

    Traffic received on this interface's network device will not be forwarded unless the client has been granted access.

  6. For Session timeout, type the amount of time that a user session remains valid. After the session times out, the user will be required to log in again.

    Allowed values are any number of weeks, days, hours, minutes, or seconds, and take the format number{w|d|h|m|s}.

    For example, to set Session timeout to ten minutes, enter 10m or 600s.

  7. For Portal HTTP access, configure whether the portal can be accessed over an insecure connection.
    • Allow: Allows access to the portal page over an insecure connection (HTTP port 80).
    • Redirect to HTTPS: Automatically redirects the request to a secure connection (HTTPS port 443).
    • Disallow: Does not allow access over an insecure connection (HTTP port 80).

    Note This setting does not affect access to HTTP port 80 after the client has been granted access to the portal.

  8. For Authorization, select the method that will be used to authorize the user:
    • None: Users are not required to enter any information to access the portal.
    • User login: Users are required to authenticate with an account on this device. Users must be part of a user group that allows access to this portal.
    • Collect user information: Users are required to complete a form to continue. The form fields may be customize.
  9. (Optional) For Title, enter the title of the portal page that the user will see when accessing the portal.
  10. (Optional) For Message, enter a message that will appear on the portal page.
  11. (Optional) For Terms and Conditions, enter the terms and conditions that ill appear on the portal page. Users will be required to agree to the terms and conditions before being granted access to the portal.
  12. (Optional) For Redirect to URL, enter the URL to which the user will be directed when granted access to the portal. If left blank, the user will be directed to the domain of the URL in the original access request.
  13. Click Apply to save the configuration and apply the change.
  1. Select the device in Remote Manager and click Actions > Open Console, or log into the TX54 local command line as a user with full Admin access rights.

    Depending on your device configuration, you may be presented with an Access selection menu. Type admin to access the Admin CLI.

  2. At the command line, type config to enter configuration mode:

    > config
(config)>

  3. To create an active portal called portal1:
    (config)> add firewall portal portal1
(config firewall portal portal1)>

    Captive portals are enabled by default. To disable the portal:

    (config firewall portal portal1)> enable false
(config firewall portal portal1)>

  4. Set the network interface for the portal. Traffic received on this interface's network device will not be forwarded unless the client has been granted access.

    1. (config firewal portal portal1)> interface ?

Interface: The network interface to run the portal on. Traffic received on this interface's network device will not be forwarded unless the client has been granted access.
Format:
  /network/interface/setupip
  /network/interface/setuplinklocalip
  /network/interface/lan1
  /network/interface/lan_hotspot
  /network/interface/loopback
  /network/interface/wan1
  /network/interface/wwan1
  /network/interface/wwan2
Current value:

(config firewal portal portal1)> interface
    2. Set the interface. For example:
      (config firewal portal portal1)> interface /network/interface/wan1
(config firewal portal portal1)>

  5. Set the amount of time that a user session remains valid. After the session times out, the user will be required to log in again.
    (config firewall portal portal1)> timeout value
(config firewall portal portal1)>

    where value is any number of weeks, days, hours, minutes, or seconds, and takes the format number{w|d|h|m|s}.

    For example, to set Session timeout to ten minutes, enter either 10m or 600s:

    (config firewall portal portal1)> timeout 600s
(config firewall portal portal1)>

  6. Configure whether the portal can be accessed over an insecure connection.
    (config firewall portal portal1)> http value
(config firewall portal portal1)>

    where value is one of:

    • allow: Allows access to the portal page over an insecure connection (HTTP port 80).
    • redirect: Automatically redirects the request to a secure connection (HTTPS port 443).
    • disallow: Does not allow access over an insecure connection (HTTP port 80).

    Note This setting does not affect access to HTTP port 80 after the client has been granted access to the portal.

  7. Set the method that will be used to authorize the user:
    (config firewall portal portal1)> auth value
(config firewall portal portal1)>

    where value is one of:

    • none: Users are not required to enter any information to access the portal.
    • login: Users are required to authenticate with an account on this device. Users must be part of a user group that allows access to this portal.
    • info: Users are required to complete a form to continue. The form fields may be customize.
  8. (Optional) Set the title of the portal page that the user will see when accessing the portal:
    (config firewall portal portal1)> title "Corporate portal"
(config firewall portal portal1)>
  9. (Optional) Set a message that will appear on the portal page:
    (config firewall portal portal1)> message "Welcome to the corporate web portal"
(config firewall portal portal1)>
  10. (Optional) Set the terms and conditions that ill appear on the portal page. Users will be required to agree to the terms and conditions before being granted access to the portal.
    (config firewall portal portal1)> terms "Accept the terms and conditions of this portal"
(config firewall portal portal1)>
  11. (Optional) Set the URL to which the user will be directed when granted access to the portal. If left blank, the user will be directed to the domain of the URL in the original access request.
    (config firewall portal portal1)> url https://myportal.com
(config firewall portal portal1)>
  12. Save the configuration and apply the change.
    (config)> save
Configuration saved.
>
  13. Type exit to exit the Admin CLI.

    Depending on your device configuration, you may be presented with an Access selection menu. Type quit to disconnect from the device.