Create a new hotspot

Required configuration items

Additional configuration items

To create a new hotspot:


  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. You can also use existing access points for the hotspot. Access Points that are assigned to a hotspot or to a bridge used by a hotspot cannot be used for any other purpose.

    If more than one access point is being used by the hotspot, you must create a bridge that includes the access points.

    1. Click Configuration > Network > WiFi > Access points.

    2. For Add WiFi access point:, type a name for the access point and click .

    3. For Radio, select the appropriate Wi-Fi radio.
    4. For SSID, type the SSID. Up to 32 characters are allowed.

      This will be the SSID used by clients to connect to the hotspot. If you are creating multiple access points, each access point must have the same SSID.

    5. For Encryption, select Open (Unencrypted).

      Hotspot access points must use open (unencrypted) communication. See Hotspot security for more information.

    6. Add additional access points by following the above instructions.

  4. Note Hotspot bridges must also be part of an interface with a configured IP address.

    1. Click Network > Bridges.
    2. For Add Bridge:, type a name for the bridge and click .
    3. Add devices to the bridge:
      1. Click to expand Devices.
      2. For Add device, click .
      3. Select the Device.
      4. Repeat to add additional devices.
    4. Create an interface for the bridge:
      1. Click Configuration > Network > Interfaces.
      2. For Add Interface, create a new interface and click .
      3. For Device, select the bridge created above.
      4. Click to expand IPv4.
      5. For Address, enter an IP address and subnet mask for the LAN. This IP address must be unique from all other interfaces.

        Note This IP address is not the IP address of the hotspot. The hotspot IP address is configured during hotspot configuration.

  5. Click Network > Hotspots.
  6. For Add Hotspot, enter a name for the hotspot and click .

    The new hotspot configuration appears.

  7. Hotspots are enabled by default when they are created. To disable, toggle off Enable hotspot.
  8. For Zone, leave at the default setting of hotspot. The hotspot firewall zone provides the necessary firewall rules for hotspot functionality.
  9. For Device, select an access point, and Ethernet port, or a bridge.
  10. For Authentication Mode, select one of the following:
    • Click-through: Requires each user to accept the terms and conditions.
    • Local shared password: Requires each user to enter a password. This password is validated locally on the TX64 device, and the password is the same for all users.

      See Configure the hotspot to use local shared password authentication for information about configuring hotspot for local shared password authentication.

    • RADIUS shared password: Requires each user to enter a password. This password is validated by an external RADIUS server, and the password is the same for all users.

      See Configure the hotspot to use RADIUS shared password authentication for information about configuring hotspot for RADIUS shared password authentication.

    • RADIUS users: Requires each user to enter username and password credentials that are established on an external RADIUS server. The credentials are validated by the RADIUS server.

      See Configure the hotspot to use RADIUS users authentication for information about configuring hotspot for RADIUS users authentication.

    • HotspotSystem: Requires each user to be authenticated by HotspotSystem, a cloud hotspot service that supports various free and paid authentication methods, including social media account, SMS, voucher, and PayPal.

      See Configure the hotspot to use HotspotSystem authentication for information about configuring hotspot for HotspotSystem authentication.

  11. For Login page source, select either:
    • Local: Uses an HTML page for authentication that is stored locally on the TX64 device's filesystem, in the /etc/config/hotspot directory. Note that the hotspot directory is not visible until hotspot has been enabled for the first time.
    • Remote: Uses an HTML page for authentication that is served by a remote web server.

    This parameter is not available if HotspotSystem is selected for the Authentication mode.

  12. (Optional) If Local is selected for Login page source, for Login page, type the name of the local HTML file used for authentication. This parameter is not available if HotspotSystem is selected for the Authentication mode.

    Normally, this field should be left blank, and the device will use the default authentication HTML page. See Hotspot authentication modes for information about the default authentication HTML page used for each authentication mode.

    If you upload a custom HTML file that uses a filename other than the default filename, type the custom filename here. See Upload custom hotspot HTML pages for more information about creating and uploading custom HTML files.

  13. (Optional) For Authentication port, type the port number that the hotspot authentication server will used. The default is 3990.
  14. (Optional) For Server port, type the port number of the hotspot server. The default is 4990.
  15. If Remote is selected for Login page source, click to expand Remote web server.
    1. For FQDN, type the IP address or fully-qualified domain name or the remote web server that will be used for client authentication.
    2. (Optional) For Secret, type the shared secret that the remote server and the hotspot. Used with cloud-based hotspot providers.

    3. Note The hotspot DHCP server is automatically enabled and cannot be disabled.

      1. Click to expand DHCP server.

      2. For Lease time, type the amount of time that a client DHCP lease is valid. The default is 10 minutes.

        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 Lease time to ten minutes, enter 10m or 600s.

      3. For Lease range start, type the lowest IP address in the range to assign to hotspot clients. The value entered here represents the low order byte of the IP address, and is combined with the subnet of the hotspot's static IP address. The default is 100.
      4. For Lease range end, type the highest IP address in the range to assign to hotspot clients. The value entered here represents the low order byte of the IP address, and when DHCP addresses are assigned to client, this number is combined with the subnet of the hotspot's static IP address. The default is 250.
  16. Click to expand Walled garden.

    Walled garden settings define the "white list" of domains and subnets that unauthenticated clients are able to access. If external servers are used for client authentication, such as a RADIUS server or HotspotSystem, they should be included in the walled garden settings. If Remote has been selected for Login page source, the domain for the web server that is being use to serve the remote HTML files must be included in the white list defined in these fields.

    • To add domains that can be accessed by the client prior to authentication:
      1. Click to expand Allowed domains.
      2. Click to add a domain.
      3. For Domain, type the hostname of the allowed domain.
      4. Repeat to add additional domains.
    • To add subnets that can be accessed by the client prior to authentication:
      1. Click to expand Allowed subnets.
      2. Click to add a subnet.
      3. For Subnet, type an IPv4 address and optional subnet mask, using the format IPv4_address[/netmask], or the keyword any.
      4. Repeat to add additional subnets.
  17. (Optional) For Maximum download speed, type the maximum download speed in kilobytes per second (Kbps).

    Note Setting the Maximum download speed to 0 means that the bandwidth is unlimited. This can have an adverse effect on performance.

  18. (Optional) For Maximum upload speed, type the maximum upload speed in kilobytes per second (Kbps).

    Note Setting the Maximum upload speed to 0 means that the bandwidth is unlimited. This can have an adverse effect on performance.

  19. (Optional) Click Debug to enable verbose logging to the system log.
  20. 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 TX64 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. You can also use existing access points for the hotspot. Access Points that are assigned to a hotspot or to a bridge used by a hotspot cannot be used for any other purpose.

    If more than one access point is being used by the hotspot, you must create a bridge that includes the access points.

    1. Create a new access point:
      (config)> add network wifi ap new_hotspot_AP1
(config network wifi ap new_hotspot_AP1)>

      New access points are enabled by default.

    2. Set the Wi-Fi radio for the new access point:
      1. Show available radios:
        (config network wifi ap new_hotspot_AP1)> radio ?

Radio: The Wi-Fi radio to run this access point on.
Format:
  wifi1
  wifi2
Current value:

(config network wifi ap new_hotspot_AP1)>
      2. Set the appropriate radio:
        (config network wifi ap new_hotspot_AP1)> radio wifi1
(config network wifi ap new_hotspot_AP1)>
    3. Set the SSID:
      (config network wifi ap new_hotspot_AP1)> ssid my_SSID
(config network wifi ap new_hotspot_AP1)>

      This will be the SSID used by clients to connect to the hotspot. If you are creating multiple access points, each access point must have the same SSID. Up to 32 characters are allowed.

    4. Set the encryption to open:
      (config network wifi ap new_hotspot_AP1)> encryption type none
(config network wifi ap new_hotspot_AP1)>

      Hotspot access points must use open (unencrypted) communication. See Hotspot security for more information.

    5. Type ... to return to the config prompt:
      (config network wifi ap new_hotspot_AP1)> ...
(config)>
    6. Add additional access points by following the above instructions.

  4. Note Hotspot bridges must also be part of an interface with a configured IP address.

    1. Create a bridge:
      (config)> add network bridge new_hotspot_bridge
(config network bridge new_hotspot_bridge)>
      1. Determine available devices:
        (config network bridge new_hotspot_bridge)> .. .. interface lan1 device ?
	
Device: The network device used by this network interface.
Format:
  /network/device/eth1
  /network/device/eth2
  /network/device/eth3
  /network/device/eth4
  /network/device/loopback
  /network/bridge/hotspot_bridge
  /network/bridge/lan1
  /network/wireless/ap/digi_ap1
  /network/wireless/ap/digi_ap2
  /network/wireless/ap/digi_hotspot_ap1
  /network/wireless/ap/digi_hotspot_ap2

Default value: /network/bridge/lan1
Current value: /network/bridge/lan1

(config network bridge new_hotspot_bridge)>
      2. Add the appropriate device. For example, to add the Digi AP (Wi-Fi1) Wi-Fi access point:
        (config network bridge new_hotspot_bridge)> add device end /network/wireless/ap/digi_ap1
(config)>
    3. Type ... to return to the config prompt:
      (config network bridge new_hotspot_bridge)> ...
(config)>
    4. Create an interface for the bridge:
      (config)> add network interface hotspot_bridge_interface
(config network interface hotspot_bridge_interface)>
    5. Add the new bridge to the interface:
      (config network interface hotspot_bridge_interface)> device /network/bridge/new_hotspot_bridge
(config network interface hotspot_bridge_interface)>
    6. Set an IP address for the interface.

      Note This IP address is not the IP address of the hotspot. The hotspot IP address is configured during hotspot configuration.

      (config network interface hotspot_bridge_interface)> ipv4 address ip_address/netmask
(config network interface hotspot_bridge_interface)>
    7. Type ... to return to the config prompt:
      (config network interface hotspot_bridge_interface)> ...
(config)>
  5. Create a new hotspot:
    (config)> add network hotspot new_hotspot
(config network hotspot new_hotspot)>

    New hotspots are enabled by default.

    • To disable:
      (config network hotspot new_hotspot)> enable false
(config network hotspot new_hotspot)>
    • To enable, it it has been disabled:
      (config network hotspot new_hotspot)> enable true
(config network hotspot new_hotspot)>
    1. Determine available devices:
      (config network bridge new_hotspot_bridge)> .. .. interface lan1 device ?
	
Device: The network device used by this network interface.
Format:
  /network/device/eth1
  /network/device/eth2
  /network/device/eth3
  /network/device/eth4
  /network/device/loopback
  /network/bridge/hotspot_bridge
  /network/bridge/lan1
  /network/wireless/ap/digi_ap1
  /network/wireless/ap/digi_ap2
  /network/wireless/ap/digi_hotspot_ap1
  /network/wireless/ap/digi_hotspot_ap2

Default value: /network/bridge/lan1
Current value: /network/bridge/lan1

(config network bridge new_hotspot_bridge)>
    2. Add the appropriate device. For example, to add the Digi AP (Wi-Fi1) Wi-Fi access point:
      (config network bridge new_hotspot_bridge)> add device end /network/wireless/ap/digi_ap1
(config)>
  7. Set an access point, and Ethernet port, or a bridge for the hotspot's device:
    1. Determine available devices:
      (config network hotspot new_hotspot)> device ?

Device: Device to use for this hotspot interface.
Format:
  /network/device/eth1
  /network/device/eth2
  /network/device/eth3
  /network/device/eth4
  /network/device/loopback
  /network/bridge/hotspot_bridge
  /network/bridge/lan1
  /network/bridge/new_hotspot_bridge
  /network/wifi/ap/digi_ap1
  /network/wifi/ap/digi_ap2
  /network/wifi/ap/digi_hotspot_ap1
  /network/wifi/ap/digi_hotspot_ap2
  /network/wifi/ap/new_hotspot_ap1
  /network/wifi/ap/new_hotspot_ap2
Current value:

(config network hotspot new_hotspot)>
    2. Add the device:
      (config network hotspot new_hotspot)> device /network/bridge/new_hotspot_bridge
(config network hotspot new_hotspot)>
  8. Set the authentication mode:
    (config network hotspot new_hotspot)> auth value
(config network hotspot new_hotspot)>

    where value is one of:

    • click_through: Requires each user to accept the terms and conditions.
    • local_shared_password: Requires each user to enter a password. This password is validated locally on the TX64 device, and the password is the same for all users.

      See Configure the hotspot to use local shared password authentication for information about configuring hotspot for local shared password authentication.

    • radius_shared_password: Requires each user to enter a password. This password is validated by an external RADIUS server, and the password is the same for all users.

      See Configure the hotspot to use RADIUS shared password authentication for information about configuring hotspot for RADIUS shared password authentication.

    • radius_user: Requires each user to enter username and password credentials that are established on an external RADIUS server. The credentials are validated by the RADIUS server.

      See Configure the hotspot to use RADIUS users authentication for information about configuring hotspot for RADIUS users authentication.

    • hotspotsystem: Requires each user to be authenticated by HotspotSystem, a cloud hotspot service that supports various free and paid authentication methods, including social media account, SMS, voucher, and PayPal.

      See Configure the hotspot to use HotspotSystem authentication for information about configuring hotspot for HotspotSystem authentication.

  9. Set the login page source. (This option is not available if auth is set to hotspotsystem.)
    (config network hotspot new_hotspot)> login value
(config network hotspot new_hotspot)>

    where value is either:

    • local: Uses an HTML page for authentication that is stored locally on the TX64 device's filesystem, in the /etc/config/hotspot directory. Note that the hotspot directory is not visible until hotspot has been enabled for the first time.
    • remote: Uses an HTML page for authentication that is served by a remote web server.

  10. (Optional) If local is selected for login, set the name of the local HTML file used for authentication. (This option is not available if auth is set to hotspotsystem.)
    (config network hotspot new_hotspot)> local_page HTML_filename
(config network hotspot new_hotspot)>

    Normally, this parameter should be left blank, and the device will use the default authentication HTML page. See Hotspot authentication modes for information about the default authentication HTML page used for each authentication mode.

    If you upload a custom HTML file that uses a filename other than the default filename, type the custom filename here. See Upload custom hotspot HTML pages for more information about creating and uploading custom HTML files.

  11. (Optional) Set the port number that the hotspot authentication server will used.
    (config network hotspot new_hotspot)> auth_port port
(config network hotspot new_hotspot)>

    The default is 3990.

  12. (Optional) Set the port number of the hotspot server. 
    (config network hotspot new_hotspot)> server_port port
(config network hotspot new_hotspot)>

    The default is 4990.

  13. If remote is selected for login:
    1. Set the IP address or fully-qualified domain name or the remote web server that will be used for client authentication:
      (config network hotspot new_hotspot)> remote url address
(config network hotspot new_hotspot)>
    2. (Optional) Set the shared secret that the remote server and the hotspot. Used with cloud-based hotspot providers.
      (config network hotspot new_hotspot)> remote secret secret
(config network hotspot new_hotspot)>

  14. Note The hotspot DHCP server is automatically enabled and cannot be disabled.

    1. Set the amount of time that a client DHCP lease is valid:
      (config network hotspot new_hotspot)> ipv4 address dhcp_server lease_time value
(config network hotspot new_hotspot)>

      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 lease_time to ten minutes, enter either 10m or 600s:

      (config network hotspot new_hotspot)> ipv4 dhcp_server lease_time 600s
(config network hotspot new_hotspot)>

      The default is 10 minutes.

    2. Set the lowest IP address in the range to assign to hotspot clients. This value represents the low order byte of the IP address, and is combined with the subnet of the hotspot's static IP address. 
      (config network hotspot new_hotspot)> ipv4 address dhcp_server lease_start value
(config network hotspot new_hotspot)>

      where value is any integer between 1 and 254. The default is 100.

    3. Set the highest IP address in the range to assign to hotspot clients. This value represents the low order byte of the IP address, and is combined with the subnet of the hotspot's static IP address. 
      (config network hotspot new_hotspot)> ipv4 address dhcp_server lease_end value
(config network hotspot new_hotspot)>

      where value is any integer between 1 and 254. The default is 250.

  15. Set walled garden settings.

    Walled garden settings define the "white list" of domains and subnets that unauthenticated clients are able to access. If external servers are used for client authentication, such as a RADIUS server or HotspotSystem, they should be included in the walled garden settings.

    • Add domains that can be accessed by the client prior to authentication:
      (config network hotspot new_hotspot)> add walled_garden domains end domain_name
(config network hotspot new_hotspot)>

      Repeat to add additional domains.

    • Add IP addresses and subnets that can be accessed by the client prior to authentication:
      (config network hotspot new_hotspot)> add walled_garden subnets end value
(config network hotspot new_hotspot)>

      where value is an IPv4 address and optional subnet mask, using the format IPv4_address[/netmask], or the keyword any.

      Repeat to add additional IP addresses or subnets.

  16. (Optional) Change the default maximum download speed:
    (config network hotspot new_hotspot)> bandwidth_max_down value
(config network hotspot new_hotspot)>

    where value is an integer between 1 and 100000 and represents the maximum download speed in Kbps.

    Note Setting the maximum download speed to 0 means that the bandwidth is unlimited. This can have an adverse effect on performance.

  17. (Optional) Change the default maximum upload speed:
    (config network hotspot new_hotspot)> bandwidth_max_up value
(config network hotspot new_hotspot)>

    where value is an integer between 1 and 100000 and represents the maximum upload speed in Kbps.

    Note Setting the maximum upload speed to 0 means that the bandwidth is unlimited. This can have an adverse effect on performance.

  18. (Optional) Enable verbose logging to the system log:
    (config network hotspot new_hotspot)> debug true
(config network hotspot new_hotspot)>
  19. Save the configuration and apply the change.
    (config)> save
Configuration saved.
>
  20. 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.