Main¶
This page contains all the System settings, divided in four parts: In the first one, Portal, it is possible to define default values for the portal appearance; in the second one, Global Settings allows to specify some option used by the various parts of the Hotspot; in the third one, Accounts, common options for the account are defined; and in the fourth, the Character set for generated passwords used in Quick Ticket are chosen.
Warning
Some change in the settings in the Portal and Global Settings will cause all connect users to be forcibly logged off. Those settings are marked with a red asterisk in the GUI.
Portal¶
The first box encompasses the following option that can be customised:
- Landing page
This option allows to choose one of three modalities to use the Hotspot’s captive portal. Depending on the choice, different options appear:
Login portal. When choosing this option, the Endian UTM Appliance's portal will be shown.
Your website with full JavaScript API integration. This option is intended for expert use only and allow to integrate the hotspot’s login dialog within a website.
Your website with SurfNow button. If this option is selected, it will be possible to allow users to access the hotspot directly from within a website, by simply clicking on a button, whose code can be copied from the textfield underneath.
How to integrate the JavaScript API into a website.
The JavaScript API make available a few functions that can directly be called from within the website. To achieve this result, it is necessary to include in the web page the following Javascript files, to be copied from the Endian UTM Appliance:
/home/httpd/html/include/portal_api.js
/home/httpd/html/include/portal_chilli.js
/home/httpd/html/include/portal.js
/home/httpd/html/include/portal_login.js
Then, it suffices to copy and paste one of the following functions and, in the case of the last one, to supply an URL:
window.parent.hotspotAPI.showLoginPage()Opens the Hotspot’s integrated login dialog.window.parent.hotspotAPI.connectWithCredentials(username, password)Directly performs the login without opening the integrated login dialog. The Start Browsing dialog appears.window.parent.hotspotAPI.changeStartBrowsingUrl(URL)By supplying a custom URL, this will be opened upon clicking on the button.
- Login portal background URL
The URL used as the background for the Hotspot login portal. This option is only available if Login portal has been chosen as Landing page.
- Your website URL
The custom URL to be shown at the user’s login. Available only if Your website with SurfNow button has been chosen as Landing page.
- Show login form
Choose from a drop-down menu when the Hotspot login form is displayed:
immediately. The login form is immediately displayed over the background homepage.
manually. The background homepage appears and can be browsed without registration. The user can access the registration page at any time from the navigation bar on top of the screen. To access other sites requires either to register or log in, although sites listed in Allowed sites (see below) can always be accessed.
after x seconds will display the login form after a user-specified period of seconds over the background homepage and the user is notified of impending registration time on the navigation bar.
- Website after successful login
The URL of a web page that will be shown to the user after a successful login.
- Use mini portal for mobile devices
Tick the checkbox to enable two additional portal types: One without Javascripts and one tailored for mobile devices. The user can choose between all three of them when accessing the Hotspot’s portal.
- Allowed Sites
A list of sites or IP addresses accessible even without being authenticated. One site per line is allowed, in the form of either a domain name (e.g., www.endian.com), or a string in the format
protocol:IP[/mask]:port(e.g., tcp:192.168.20.0/24:443).Note
If a web site incorporate widgets, javascripts, CSS, or other components from sites outside this list, it might not be displayed correctly. Hence, make sure to put in the list all the IPs or URLs where these additional components are stored.
Global Settings¶
- Hotspot name
A name given to identify the hotspot.
- Items per page
The pagination value, i.e., the maximum number of items of a list or table per page that are displayed.
- Currency
The currency used in all the calculations of payments in the Hotspot.
Note
Some currency is not supported by PayPal, therefore it can not be used for SmartConnect tickets.
- Popular Countries
Popular countries are listed first in the list of Countries presented to the users when they register, to reduce the time needed for the registration.
- Enable AnyIP
This option enables the AnyIP feature, which should assist clients not using DHCP and allow them to access the Hotspot even with a static IP that does not fall within the Hotspot’s IP subnet (i.e., the BLUE zone).
- Bandwidth limiting
The default upload and download limits per user in Kilobyte/s. If these fields are left empty, then no limit is applied.
Note
Remember that one kilobyte corresponds to 8 kilobits, so make sure to enter appropriate values in the fields.
- DHCP dynamic range
When this option is enabled by ticking the checkbox, dynamic IP addresses are assigned to the devices connected to the hotspot.
- Dynamic IP range
This option appears when the previous one is active and allows to specify a custom range of IP addresses within the BLUE zone to be dynamically assigned to the hotspot’s client.
Accounts¶
Anonymous login for hotspot users.
It is possible to allow anonymous login, without user authentication, but requiring all the users and accept the Terms of Service. To do so, it is first necessary to create a ticket of type post-paid, then to disable the option Require user authentication and enable Require users to accept the ‘Terms of Service’ on login. If the post-paid ticket has been created with a given validity, after that period the user will again be required to accept the Terms of Service.
- Require user authentication
Tick the checkbox to require clients accessing the Hotspot to have a valid, registered account. If this option is not enabled, the next one appears.
- Ticket rate to be used for surfing without authentication
Choose from the drop-down menu the rate assigned to client who do not authenticate.
- Require users to accept the ‘Terms of Service’ on login
When this option is selected, the user is asked to accept the Terms of Service right before the login.
- Default language
The language used by default for the new users.
New in version 5.0.
- Password recovery
Allow a user that has lost or forgotten her credentials to be able to reset them. Three options can be chosen:
Disabled: No password recovery is allowed.
Using SmartConnect settings: The credentials are sent using the same means used in SmartConnect™.
Using custom settings: Personalised settings can be defined (see the box below).
- Timeout for idle users
The time of inactivity after which users will be forcibly logged out (default is 15 minutes), so that the ticket’s validity is not wasted to much.
- Default account lifetime (days)
The number of days an account is valid (default is 365 days). After that number of days have passed, the user automatically becomes inactive.
- Allow deletion of used accounts
This options allows the deletion of accounts that have already used parts of their tickets. If selected, the next option appears.
- Avoid deleting users who bought tickets with SmartConnect
This checkbox appears when the previous option has been selected. By default it is enabled, suggesting that users who already bought tickets by credit card with SmartConnect not be deleted from the system.
- Delete disabled accounts on a daily basis
Enable the automatic, daily deletion of disabled account.
- Delete expired accounts on a daily basis
Enable the automatic, daily deletion of disabled account.
- Allow multiple simultaneous logins
Tick the checkbox to allow a user to connect at the same time from different devices.
Warning
This option will break the accounting for pre-paid tickets, making it almost useless. It is strongly suggested to use only post-paid tickets if simultaneous logins are allowed.
Character set for Generated Passwords¶
This part of the main settings allows to define the default values for the automatically generated passwords.
Hint
By default, passwords will be 6 character long and composed only by digits.
The following values for the passwords can be customised:
- Length
How many characters the password is long.
- Uppercase letters
Tick the checkbox if the passwords should include uppercase letters.
- Lowercase letters
Tick the checkbox if the passwords should include lowercase letters.
- Numbers
Tick the checkbox if the passwords should include numbers
- Special characters
Tick the checkbox if the passwords should include uppercase letters
Password recovery custom settings.
When choosing to allow password recovery with custom setting, several configuration options appear, that are needed for a successful recovery process. The first one is the modalities by which recovery is done:
- Password recovery is done
There are three choices for this option: via SMS, via e-mail, or both. Depending on the choice, different options appear, to configure how to send the SMS or the e-mail. Note that all options appear if both e-mail and SMS password recovery are enabled.
For the SMS recovery mode, there is only one additional option:
- Allowed country codes for password recovery
It is possible to allow the sending of SMS only to those cell phones that belong to the selected countries. To add a new country code, start writing the country’s name or code in the Multiselect box above the countries’ list until the country’s name appears in the box underneath, select it, and finally click on the + on the right of the country’s name. Allowed countries appear in the right-hand side box and can be disallowed by clicking on the - on their right.
For the e-mail recovery mode, two options are available.
- Mail server
The SMTP server used to send the recovery email. It is possible to choose among three option from the drop-down menu.
System SMTP server. To be able to choose this option, the must be activated.
Custom SMTP server. In this case, the name of the mail server can be specified in the textbox.
- Sender email address
A custom e-mail address that will be used as the custom sender of the recovery e-mail.
An additional option is also available for both recovery modes:
- Limit password recovery to
The interval of time that must pass before trying to recover the password another time. Only one out of four options can be selected from the drop-down menu: once every 10 minutes, once every 30 minutes, once every hour, and once every day.
button to open a pop-up window
called Image Properties. Here, in the Image Info tab, there are
two alternatives to insert an image:
Social Networks¶
The Hotspot can be configured to support and use the most important social networks. Two different functionalities have been implemented: The first one is called Social Login and allows users to log into the Hotspot by using their social network accounts (i.e. Google or Facebook), while the second feature, called Social Enabler allows to use the Hotspot for marketing purposes by requiring users to share information about the hotspot manager’s business on various social networks.
Social Login¶
The Social Login allows users that have an account on a social network to access the Endian Hotspot without having to create a new user account. In this case the authentication of the user is done remotely, against the social network, while locally a new user is created, whose username is the respective e-mail address. This user does does not need a password, will receive a ticket at the first login, and will be managed like regular users. Therefore, it will be possible to see the user’s balance, information, and connections, and modify the tickets or data associated with the account.
The following options are available for the Social Login:
Choose from the drop-down menu the ticket to associate to users that access the hotspot using the Social Login. This is necessary as users will not have the possibility to choose a ticket when using the Social Login functionality.
Tick the checkbox to allow users to access the hotspot using their Facebook credentials.
Tick the checkbox to allow users to access the hotspot using their Google credentials.
Tick the checkbox to allow users to access the hotspot using their Twitter credentials.
Tick the checkbox to allow users to access the hotspot using their Instagram credentials.
For each enabled Social Login, on the authentication page opened by the clients, a button will appear that can be clicked to access the hotspot.
Social Enabler¶
The Social Enabler gives the possibility to enable guest access to the hotspot only after a user carries out one social activity in a supported social networks.
The following options are available for the Social Locker:
By ticking this checkbox, the Social Enabler will be activated. Users will need to perform one of the available social activities to be able to connect to the Internet. Please refer to the social activities below.
This is enabled by default and will give users the possibility to close the lockscreen and directly access the Internet through the hotspot.
Warning
Disabling this option might infringe the policies of various social networks and Endian cannot be held responsible if these networks therefore decide to block accounts.
Choose from the drop-down menu whether the lockscreen should automatically disappear after a certain amount of time -30 seconds, 1 or 2 minutes. By default the screen will not be unlocked automatically.
Choose from the drop-down menu one of the available themes for the social buttons.
Tick the checkbox to show the social buttons and the number of times they have already been clicked.
In this multiple select field it is possible to define which social activities will be made available to unlock the lockscreen. They can be enabled by dragging the activity from the left to the right column. Available options are: Facebook Like, Facebook Share, Google +1, Google Share, LinkedIn Share, Twitter Follow, Twitter Tweet, and YouTube Subscribe.
Note
When using LinkedIn Share, Twitter Follow and Twitter Tweet users might be able to access the hotspot even if they close the window without sharing.
In this section it is possible to insert configuration parameters that are required for every single social network. They are grouped by social network.
The App ID is required when enabling the Facebook Share option and can be entered here.
The URL that users will like once they click the respective button.
The URL that users will share once they click the respective button.
The URL for which users will add +1 on Google+ once they click the respective button.
This is the URL that users will share on Google+ once they click the respective button.
This is the URL that will be tweeted once a user clicks on the Twitter Tweet button.
This is the additional text message that will be tweeted once a user clicks on the Twitter Tweet button.
This field allows to define a Twitter username to be specified as the original source of the tweet. A name added here will appear in the message as via @username. Keep in mind that only the username is required here, so do not add the @ sign in front (i.e., username, not @username).
Paste the entire URL of the twitter profile that users should follow after clicking the respective button here.
This is the URL that users will share on LinkedIn once they click the respective button.
Specify the ID of the YouTube channel that users need to subscribe to after clicking the respective button.
Note
The channel ID can be found in the URL of the channel, since it is the string that directly follows the URL https://www.youtube.com/channel/ in the location bar and looks similar to UC3UU4klSmn2dg8qApAO8Otw.
To be able to subscribe to a YouTube channel a Google Client ID is required and must be entered here.
See also
In the knowledge base, the following tutorials are available:
How to create a google client ID
How to create a facebook ID