Endian banner

Settings

This section sorts out all the available options to configure the Hotspot in five main groups: Main, SmartConnect™, Social Networks, API, and Language.

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:

Homepage / Landing page

This option allows you to choose how to use the Hotspot’s captive portal. Depending on your choice here different options will appear:

  • Login portal - when choosing this the Endian UTM Appliance‘s portal will be shown. You will be able to define which website you would like to use as a background for the portal and when you want the login form to show up through the following options:

    • Login portal background URL - The URL used as the background for the Hotspot login portal.

    • Show login form - Choose from a drop-down menu how the Hotspot login form is displayed:

      • immediately will display the login form immediately over the background homepage.
      • manually will display the background homepage with a top navigation bar allowing the user to access the registration page at any time, with the home site being browsable without any user registration: This proves useful to promote an own Web site or to provide some information. Access to all other sites will still require registration, 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 (user is notified of impending registration time on the navigation bar).
  • Your website with SurfNow button - when choosing this option the website you enter will be directly shown to the user when logging into your network. The only thing you need to do is place the SurfNow button on your homepage so that users can see it and log into the Hotspot. The only available option is:

    • Your website URL - The URL of your website.
  • Your website with full JavaScript integration - this option is intended for expert use only. However, it will let you integrate the Hotspot deeply with your website. Directly from your website you will be able to let users log into the Hotspot and open URLs of your choice directly after the login. The only available option is:

    • Your website URL - The URL of your website.

How to integrate the SurfNow button or the JavaScript API into your website

Both the SurfNow button and the JavaScript API are great ways of directly integrating the Hotspot with your website. Here is how the can be done:

  • For the SurfNow button simply add something like this snippet to the code of your website:

    <button onclick="window.open('http://hotspot.endian.com','_self')">
    Surf Now
    </button>
    
  • To integrate the JavaScript API a deeper knowledge is required. The API gives you access to the following functions that you can directly call from within your website:

    • 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): Changes the URL that will be open when clicking the Start Browsing button to the specified URL.
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
This option governs which types of portal are served by the Hotspot. Besides the standard portal there are two more available: One without Javascripts and one tailored for mobile devices. When this option is checked, all the three types of portal are served, whereas if it not, then only the standard portal is offered to the users.
Allowed Sites
The sites or IP addresses accessible even without being authenticated, i.e., those sites that can be visited by anyone. One site per line is allowed, in the form of either a normal domain name or a string of the format protocol:IP[/mask]:port, e.g. www.endian.com or tcp:192.168.20.0/24:443. Take into account that if the pages incorporate some widgets, javascripts, or other components from sites outside this list, they could not be loaded correctly.

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, in order to reduce the time needed for the whole registration process.
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 (BLUE zone) IP subnet.
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 IPs 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

Require user authentication
Tick the checkbox if you want that clients accessing the Hotspot need a valid, registered account.
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.
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 via the same means used in SmartConnect™
  • Using custom settings: Personalised settings can be defined (see the box below).

Note

It is possible to allow anonymous login (i.e., without user authentication), but requiring all the users to agree with and accept the Terms of Service. To do so, it is first necessary to create a ticket of type post-paid, then to disable 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.

Timeout for idle users
The time of inactivity after which a user logged out (default is 15 minutes, i.e., after 15 minutes of inactivity a user is automatically logged out), so that the user does not waste too much of the ticket’s validity.
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 deletion of disabled user accounts on a daily basis.

Character set for Generated Passwords

The second part of the main settings allows the choice of the default values for the passwords that are automatically generated, for example when creating bulk of tickets. The following values for the passwords can be customised: The length, whether to use uppercase and lowercase letters, numbers, or additional special characters. By default, passwords will be 6 character long and composed only by digits.

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.

  1. System SMTP server. To be able to choose this option, the Menubar ‣ Proxy ‣ SMTP must be activated.
  2. 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.

SmartConnect

On this page it is possible to configure the SmartConnect™ (self-service) and SmartLogin functionalities of the Hotspot. The SmartConnect™ system fully supports paid self-service ticket creation or the use of free tickets with no customer payment, while SmartLogin offers to the user the possibility to avoid the need of re-authenticate to the Hotspot closing and opening the browser. When not yet enabled, the first time this page is open, there is only one option available:

SmartConnect

Enable SmartConnect
The SmartConnect™ feature is activated only if this checkbox is ticked.

As soon as SmartConnect™ is enabled, additional options will show up, to allow more control over this functionality:

Self-Service user registration

This drop-down menu allows to select the modality to notify the user of the successful account registration. Three mutually exclusive (i.e., only one can be selected at a time) options are available: via SMS, via E-mail, and no notification at all (disabled). Depending on the choice, additional options become available.

  • Disabled: no additional options available. No new user can be created via SmartConnect™, though existing SmartConnect™ users are allowed to navigate and buy tickets.

  • SMS. The activation of this option requires the availability of SMS bundles, used to send the confirmation to the user, that can verified under System ‣ Event Notifications ‣ SMS Notifications. Additional SMS bundles can be purchased from the Endian Network. These additional options are available:

    Do not require phone number confirmation

    Disable the request to write twice the cellphone number to which to send the confirmation. Useful when compiling the request on a smartphone.

    Allowed Country Codes

    Only the cellphones that belong to the selected countries are allowed to register for SmartConnect™ access. To add a new country, 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.

  • E-mail. An e-mail with the access credentials is sent to the e-mail address provided during the registration process. A confirmation link is also included, that should be clicked for the user to successfully complete the process and activate the account. This option requires a smarthost or SMTP server.

    Do not require email address confirmation

    Disable the request to write twice the email address to which to send the confirmation. Useful when compiling the request on a smartphone.

    Ticket rate for email address verification

    This drop-down menu allows the selection of one among the available rates to allow a user to connect for a short time for her to read and receive the confirmation email.

    Hint

    The rates that can be selected here need to be defined as time-based and pre-paid, from ticket creation validity, and not enabled for SmartConnect™.

    Mail server

    This drop down menu allows the choice of the smarthost that will send the email with the access credentials. The available options are: Custom mail server, in which the URL of a customised mail server can be provided, System smarthost, and System SMTP proxy. The latter options are available only if a smarthost and a SMTP proxy have been configured and are running on the appliance.

    Sender email address

    A custom e-mail address that will appear as the sender of the confirmation e-mail.

Fields for user registration

In this multiselect box it is possible to define which are the compulsory account’s attributes to be provided during the registration process. The attributes that are presented to the user appear in the right-hand side column, along with the required or optional mark. The total number of optional or required attributes is shown at the top of the left-hand side.

Note

Depending on the User Registration type, some field are mandatory and cannot be disabled. When registration by email is enabled, Username, Password, and Email address are required, while when registration by sms is active, only the Phone number is required and will act as the username.

Limit free tickets per account
The amount of free tickets that can be used by every account. The default option is “no limit”, meaning that new tickets can be purchased at every moment, but there’s the option “time limit” that allow users to purchase one new free ticket only every that given amount of minutes.
Enable Paid Tickets

This option allows users to pay for Hotspot tickets by using Paypal or a credit card. When enabled, this feature allows to configure a PayPal account on which the payments will be collected.

Warning

If this option is activated while users are connected to the Hotspot, they will all be forcibly disconnected.

Enable Paypal Sandbox
This box enables or disables the PayPal sandbox for testing/demo purposes only: Using the sandbox permits to verify that the Paypal API integration works, without actually running live transactions with real money.
Paypal API Username
The PayPal API username.
Paypal API Password
The PayPal API password.
Paypal API Signature
The PayPal API signature.

Note

In order to properly setup the SmartConnect™ functionality of the Endian Hotspot and receive customer payments, it is necessary to sign up and create a PayPal account.

See also

Step by step guides to the setup of a PayPal sandbox and of SmartConnect™ are available on the help.endian.com webpage.

SmartLogin

The SmartLogin functionality provides the Hotspot’s users a convenient means to avoid a new authentication when reconnecting to the hotspot. In other words, when a user closes the browser, she later needs only to restart the same browser for an immediate access to the Internet, with no necessity to authenticate again. The SmartLogin functionality can be enabled globally for all Hotspot’s users or individually for each user. In the latter case, SmartLogin works for those users even if it has not been activated globally, and can be enabled in the Login information section of the Accounts Editor.

The following options are available:

Enable SmartLogin
Tick the checkbox to enable SmartLogin for every user.
SmartLogin cookie lifetime
The time in days within the user has the possibility to use the SmartLogin functionality.
Allow users to override SmartLogin cookie removal on logout
When this option is enabled, in the user’s login portal appears a new option (Disable automatic login) that gives her the choice to use or not the SmartLogin functionality.

Rates for email verification.

In order to allow the user to read the confirmation email, she should be allowed a quick free access to the Internet and to her mail account to read the credentials of the newly created account. Hence, a suitable rate with precise characteristics must be linked to the SmartConnect™ user registration process. In case no rates is yet available, a message describes the required options for this ticket, which can be created under Ticket ‣ Rates. The ticket rates needs to be pre-paid, free, time-based, and not available for SmartConnect™. Moreover, they must also be defined with a ‘From ticket creation’ validity value. It is suggested that this value be limited to a few minutes, to give the user only the possibility to retrieve her credentials.

For help with the ticket rates creation, see also the online help.

Warning

If you do not see the social networks documentation below this warning you are probably using an ad blocker in your browser. Please deactivate the ad blocker on this page to read this part of the documentation.

Social Networks

The Hotspot can be configured in a way 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). The second feature allows you to use the Hotspot for marketing purposes by requiring users to share information about your business on various social networks. This feature is called Social Enabler.

Social Login

Social Login allows users with Facebook or Google accounts 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 Facebook or Google, while locally a new user is created, whose username is the respective e-mail address. At the first login, a ticket is assigned to the user. The user does not need a password, but will be treated like any other user. This means that 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:

Default ticket rate
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.
Enable Facebook login
Tick the checkbox to allow users to access the hotspot using their Facebook credentials.
Enable Google login
Tick the checkbox to allow users to access the hotspot using their Google credentials.

For each enabled Social Login, on the authentication page will appear a button that can be clicked to access the hotspot.

Social Enabler

Social Enabler gives you the possibility to enable guest access only once a user posts information about your service on one of the various supported social networks.

The Social Enabler can be configured through the following options:

Show a lockscreen with social buttons before activating the connection
Ticking this checkbox will activate the Social Enabler. Users will need to perform one of the available social activities to be able to connect to the Internet.
Allow users to skip this step by closing the lockscreen

This is enabled by default and will give users the possibility to close the lockscreen and directly use the Internet connection.

Note

Disabling this option might infringe the policies of various social networks and Endian cannot be held responsible if these networks therefore decide to block your accounts.

Automatically unlock the screen after
This option lets you configure whether the lockscreen should automatically disappear after a certain amount of time. The options are between 30 seconds and 5 minutes. By default the screen will not be unlocked automatically.
Social button theme

Here you can choose between one of the available themes for the social buttons. Below you can see what they look like.

The default theme is called starter and looks like this.

../../_images/theme-starter.png

The flat theme looks like this.

../../_images/theme-flat.png

The glass theme looks like this.

../../_images/theme-glass.png

The secrets theme looks like this.

../../_images/theme-secrets.png
Show social counters
Ticking this option will not only show the button to perform a social activity but also the number of times this has already been done.
Choose social activities to unlock the Hotspot

In this multiple select field it is possible to define which social activities should be 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
  • YouTube Subscribe

Note

When using LinkedIn Share, Twitter Follow and Twitter Tweet users might be able to use your Internet connection even if they close the window without sharing.

Social Network configuration

In this section it is possible to insert configuration parameters that are required for every single social network. They are grouped by social network.

Facebook
Facebook App ID
The App ID is required when enabling the Facebook Share option and can be entered here. Click here to find out how to create a Facebook App ID.
URL to like on Facebook
The URL that users will like once they click the respective button.
URL to share on Facebook
The URL that users will share once they click the respective button.
Google+
URL to +1 on Google+
The URL for which users will add +1 on Google+ once they click the respective button.
URL to share on Google+
This is the URL that users will share on Google+ once they click the respective button.
Twitter
URL to tweet on Twitter
This is the URL that will be tweeted once a user clicks on the Twitter Tweet button.
Tweet text
This is the additional text message that will be tweeted once a user clicks on the Twitter Tweet button.
Tweet via
This field allows you to specify a Twitter username to be specified as the original source of the tweet. If you add a name here it 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 (username, not @username).
URL of Twitter profile to follow
Paste the entire URL of the twitter profile that users should follow after clicking the respective button here.
LinkedIn
URL to share on LinkedIn
This is the URL that users will share on LinkedIn once they click the respective button.
YouTube
YouTube Channel ID to subscribe
Specify the ID of the YouTube channel that you want users to subscribe to after clicking the respective button. Note that the channel ID can be found in the URL of the channel. It is a string that directly follows the initial ‘https://www.youtube.com/channel/‘ in your location bar and looks similar to ‘UC3UU4klSmn2dg8qApAO8Otw’.
Google Client ID
To be able to subscribe to a YouTube channel a Google Client ID is required. This ID must be entered here. Click here to find out how to create a Google Client ID.

Getting a Facebook App-ID.

A Facebook App ID is required if you want users to be able to share your URL.

  1. Log into Facebook’s developer console.
  2. Create a new app (name + category + contact email)
../../_images/01-createapp.png
  1. Insert a name for your application, the contact email address, choose a category for your app (e.g. Utilities, Communication) and click on Create App ID.
../../_images/02-appname.png
  1. Make sure to fill out the security question and click Submit.
../../_images/03-securityquestion.png
  1. In the menu on the left go to Settings.
  2. Enter hotspot.endian.com in the App Domains field and change the logo if you would like to.
../../_images/04-appsettings.png
  1. Now scroll to the bottom of the page and click + Add Platform.
../../_images/05-appplatform.png
  1. In the popup that will appear select Website.
../../_images/07-platformtype.png
  1. In the Site URL field enter (http://hotspot.endian.com).
../../_images/06-hotspoturl.png
  1. In the menu on the left now choose App Review and make your app public by clicking on the switch. Once this has been done a message showing Your app is currently live and available to the public is shown.
../../_images/08-appreview.png
  1. In the menu on the left go back to Dashboard and copy the App ID. Paste the ID into the Hotspot configuration field called Facebook App ID.
../../_images/09-dashboard.png
  1. That’s it, your Hotspot is now ready!

Getting a Google Client ID.

A Google Client ID is required if you want users subscribe to your YouTube channel from the Hotspot. However, the process of getting such a client ID is not very straightforward and therefore described here:

  1. Make sure to be logged into your Google account and go to the Google developers console.

  2. Create a new project by clicking on Select a project and then Create a project... at the top right corner.

    ../../_images/01-BeforeCreateProject.png
  3. Enter the name of your project, e.g. “My Project”, and click the Create button.

    ../../_images/02-CreateProject.png
  4. You will be redirected to the API overview. Search for Social APIs and click on Google+ API.

    ../../_images/02b-APISelection-G.png
  5. Enable the API.

    ../../_images/03-Google+API.png
  6. Now go back to the API overview, search for YouTube APIs and enable the YouTube Data API as well.

    ../../_images/02b-APISelection-Y.png
  7. Once these APIs have been enabled click on Credentials on the left and a new page will open. On this page click OAuth consent screen and enter the Product name shown to users, e.g. “My Hotspot”.

    ../../_images/04-OAuthConsentScreen.png
  8. After having configured the consent screen it is finally time to create the client ID. At the top click on Credentials, then on Create credentials and choose OAuth client ID.

    ../../_images/05-CreateCredentials.png
  9. Choose Web application as Application type and enter a name for your client. In the Authorized JavaScript origins field you must enter the web address of your Hotspot’s web portal. The addresses you need to enter are http://hotspot.endian.com and https://hotspot.endian.com. Click Create to save the client ID.

    ../../_images/06-CreateClientID.png
  10. After saving the client ID a popup will show up and contain two values, the client ID and the client secret. All you need to do now is create the ID and paste it into the Hotspot configuration field called Google Client ID.

    ../../_images/07-SaveClientID.png
  11. That’s it, you are now ready to go!

Warning

If you do not see the social networks documentation above this warning you are probably using an ad blocker in your browser. Please deactivate the ad blocker on this page to read this part of the documentation.

API

This section controls the settings of the Endian Hotspot’s API, that allows the integration of the Hotspot of Endian UTM Appliance into an already running system. Depending on the chosen Mode, different parameters can be set.

Mode
Endian UTM Appliance provides three different API modes: Endian‘s generic API/JSON, the ASA jHotel, and the pcs phoenix interfaces. The ASA jHotel and the pcs phoenix interfaces are only needed by hotels that use the ASA jHotel or the pcs phoenix hotel management software, respectively, whereas the generic API can be exploited to interact with other software systems. The three available modes are mutually exclusive, i.e., they can be activated one at a time. If there is one of the three interfaces enabled, and a different one is enabled, then only the latter is active, while the former is automatically disabled.

The other configuration options depend on the selected Mode. The following are the option to specify for the ASA jHotel mode.

ASA jHotel Interface enabled
By ticking this checkbox the ASA jHotel interface is enabled.
ASA jHotel URL

The URL of the ASA jHotel management interface. Its correctness can be tested by clicking on the Test button on the right of the input box.

Hint

In the sample URL provided, replace the IP_ADDRESS of the ASA installation and the COMPANY name.

Allow guest registration (Guest Login / SmartConnect)
Allow a guest to self register by ticking this checkbox.
Guest registration default rate
Select the default rate that will be applied to new accounts from this drop-down menu. The available rates should already have been defined in Ticket ‣ Rates.
Allow non-free post paid tickets for guests that are not checked in.
Tick the checkbox to allow non checked-in hotel guests to buy post paid tickets.

Hotspot access with the ASA jHotel management software.

Any user that already has an account in the ASA management software can quickly access the Hotspot without the need to create an account, provided that the Hotspot is correctly configured. The steps needed on the Hotspot are:

  1. Tick the ASA jHotel Interface enabled checkbox and verify the the Hotspot can access the URL of the ASA jHotel interface.
  2. Under Ticket ‣ Rates, create a new postpaid rate, with Ticket Code the id used by ASA and give it a unique name (e.g., “my-ASA”).
  3. Go back to Settings ‣ API, and choose the ASA jHotel mode and choose as Guest registration default rate the rate name created in the previous step (“my-ASA”.

For the Generic API/JSON or the pcs phoenix interface, there are three options available:

API enabled
Tick the checkbox to enable the API.
Accounting URL
The Hotspot will send accounting information to this URL, to verify the data supplied by the user. Leave this field empty if the Hotspot should not accounting.
Accounting URL requires HTTP Authentication
If the URL provided in the previous option requires HTTP authentication, tick this checkbox. Two new text fields will appear to supply the username and password, respectively.

Finally, the API can be tested on the special page https://GREENIP:10443/admin/api/, in case the Generic API/JSON interface has been chosen.

Language

The Language section allows to set all the language-dependent options and customise all the string shown in the various languages and the portal templates. The page is organised in two boxes: Supported Languages, Edit Languages, with a third one showing up depending on the Edit choice made in the second box.

Supported Languages

In the first box it is possible to choose which languages are supported in the Hotspot and made available to the users. The languages must be selected in the multi-select box and then saved by clicking on the Store button. Only languages selected here will be available to the users during the registration process and when they connect to the portal.

Edit Languages

In the second box it is possible to modify either one of the four portal templates or the user interface strings, for every language activated in the previous box. To personalise the templates and the strings, there are several variables that can be used. When a message shall be sent to a user -for example, she lost her account’s password- each variable is replaced by an actual values, taken from the data stored in the Hotspot.

Language
The language for which to modify or add the translations. The available options from the drop-down menu depend on the activated languages.

Edit

The object(s) to modify. They can be either the Portal Templates or the Portal Strings. If the choice was to modify the Portal Strings, the editor is replaced by a list of the English words and sentences, used across the Hotspot’s GUI and portal, each with an input box in which to write the translation in the chosen language. For the Portal Templates choice, one of the templates can be edited in the box that opens: Welcome Page, Account Print, Terms of Service, Help, Email body, and Lost password email body.

To learn more details on how to customise the portal, skip to Hotspot customisation below.

The content of each template can be changed and personalised with the help of a fully featured WYSIWYG editor.

Hotspot customisation

The portal presented to the users when they first connect to the Hotspot can be customised in several ways: the Language used in the portal, the text contained in the various pages, the CSS, the logo of the company running the Hotspot, and the portal’s name. The last setting can be configured only from the CLI, while all other can be carried out from the Hotspot’s administration interface, in the Languages section (Hotspot ‣ Administration Interface ‣ Settings ‣ Languages)

Available languages.

There are six languages that are active by default: en (English, also used as default), de (German), it (Italian), ja (Japanese), es (Spanish), pt (Portuguese). A user connecting to the portal can select to customise each of the language. Additional languages can be served by the hotspot, by choosing them from the multi-select box the desired languages

Templates.

These are the templates that can be modified:

Welcome Page
The page presented to the user before logging in.
Account Print
A welcome message printed and handed out to the users after their registration along with their username and password. These are the variables that can be used: $title, $firstname, $lastname, $username, $password.
Terms of Service
They are presented to the user when clicking the link next to the checkbox asking them to accept the Terms of Service before being able to login.
Help
The content of this page will be shown to the user as an help message.
Email body

The text to be included in the e-mail sent with the user’s credentials upon registering, used when registration by email is active. These are the variables that can be used: $hotspot_name, $activation_link, $rate_name, $username, $password, $amount, $price, $currency, $txn_id.

New in version 2.5.

Lost password email body

The text to be included in the e-mail sent with the user’s credentials , used when the user lost them and the password recovery by email option is selected. These are the variables that can be used: $username, $password

New in version 2.5.

Each of the template can be edited for every language avavilable on the hotspot and can make use of the pre-defined variables (see these tables.

Text and images.

The content of the portal, be it images or text, can be modified from the editor, from which it is also possible to upload custom images, CSS and other files. To use the editor, go to the Edit Languages section, choose Portal Templates from the drop-down menu next to the Edit: label, then select the template from the drop-down menu below -labeled with Template- among those available:

  • Welcome Page: The page that all the user see before connecting.
  • Account print: The document to be printed and handed in to the user with her credentials.
  • Terms of Service: The rules that user shall follow during the use of the Hotspot.
  • Help: The page containing help and troubleshooting for the user.
  • Email body: The text of the e-mail sent to the user as confirmation for the successful account creation.
  • Lost password email body: The text of the e-mail sent to the user as a reminder of her credential to access the Hotspot.

In the editor at the bottom of the page it is possible to create documents with text and images. Adding images and custom files s indeed very simple: Put the curson on the point in which to insert an image, then click on the insert button to open a pop-up window called Image Properties. Here, in the Image Info tab, there are two alternatives to insert an image:

  1. Provide an hyperlink to an image on the web in the URL textfield
  2. Click on the Browse Server button to open a file browser and either choose an existing image on the server, or click on the Choose File button on the bottom of the page, to select an image from the local workstation, then click on the Upload button..

Hint

The uploaded files will be stored on the Endian UTM Appliance into the /home/httpd/html/userfiles/ directory. Custom files can be also directly uploaded e.g., via SSH in that location.

CSS.

Custom CSS files can also be used: Upload them to the Endian UTM Appliance, placing them in the /home/httpd/html/userfiles directory. Like image files, they can be uploaded using the insert button or via SSH. The file shall be named:

  • hotspotcustom.css, the CSS used for the administration interface
  • portalcustom.css, the CSS used for the the Hotspot portal
  • miniportalcustom.css, the CSS used for the Hotspot mini portal, i.e., the one with javascript disabled, tailored for mobile devices.

Hint

The original of these files can be found in the /home/httpd/html/include directory, and are named hotspot.css, portal.css and miniportal.css, respectively. They can be used as a basis for the custom ones.

Logo.

The logo that appears to the users on the portal can be replaced by using custom CSS portalcustom.css or miniportalcustom.css files. Upload the logo in the /home/httpd/html/userfiles directory (which shall be around 80x20 pixels in size), then modify the CSS files like:

div.logo img { display: none; }
div.logo { background-image: url('images/your-logo.png'); }

Hotspot name.

The operation of changing the domain name to the portal must be done manually from the CLI. The CLI access to the Endian UTM Appliance can be enabled under Menubar ‣ System ‣ SSH access (see Section Accessing the Endian UTM Appliance for directions).

Warning

Editing and modifying by hand any configuration file from the CLI file requires some acquaintance with the Endian UTM Appliance internals, since a a wrong edit to a file may cause a service to stop. It is recommended to be careful and it is suggested to save a backup copy of any file before editing it.

To change the Hotspot hostname and domain name, edit as root the file /var/efw/hotspot/settings, using e.g., the installed nano editor, and look for the lines, which are actually variable definitions (the values shown here are only examples):

HOTSPOT_HOSTNAME=hotspot
HOTSPOT_DOMAINNAME=example.com

Replace the values on the right-hand side (hotspot and example.com) with custom ones.

Moreover, since the connection to the captive portal is encrypted, a valid SSL configuration is also required, which amounts to create:

  • a valid certificate (i.e., no self signed one)
  • a private key file, not encrypted, and
  • a file containing the SSL key chain for the certificate.

These files can be created in any directory, although the suggested best practice is to copy these files under /var/efw/hotspot/ as well, to ensure that they are part of every configuration backup. Once all the certificates have been created, is is necessary also to make the Hotspot engine aware of their existence and to overwrite the default certificate settings, again editing the file /var/efw/hotspot/settings and add the following variables:

HOTSPOT_CERT=/<CUSTOM_PATH>/hotspot.example.com-cert.pem
HOTSPOT_KEY=/<CUSTOM_PATH>/hotspot.example.com-key.pem
HOTSPOT_CHAIN=/<CUSTOM_PATH>/hotspot.example.com-cabundle.pem

Remember to replace <CUSTOM_PATH> with the full path to the three certificates.

Finally, if an SSL key chain file is not needed, an empty value can be assigned to the last variable of the above configuration, like:

HOTSPOT_CHAIN=

Meaning of variables.

This is a complete reference for the variables that can be used when customising the Hotspot’s portal templates and portal strings. They prove useful to compose messages tailored to each user: Whenever one of these variables appears in a template, it will be replaced by the corresponding value defined for that account. The variables are grouped together in three tables: Table 1 contains variables that can be used in all portal tempales, Table 2 contains variables that can be used in the Print account template only, and Table 3 contains variable used in the portal strings.

Table 1: Variables for all Portal Templates.

Variable Replaced by
$title The title of the account holder
$firstname The first name of the account holder
$lastname The last name of the account holder
$username The username of the account
$password The password of the account
$rate_name The name of the Hotspot ticket rate
$amount The amount of traffic or time available
$price The cost of the ticket
$currency The currency in which the ticket was paid.
$txn_id The ID of the transaction.

The variables in the next table will be replaced in the printed account information by the values supplied in the corresponding fields of the account editor.

Table 2: Variables for the Account Print Portal Template.

Variable Replaced by
$language The language of the user
$birth_city The city or town of the user’r birth
$birth_date The date of the user’s birth.
$document_type The document that identifies the user
$document_party  
$document_id The ID of the document
$street The street in which the user lives
$country The country the user lives in
$city The city or town where the user lives
$zip The ZIP code of the user’s city
$description The account’s description
$static_ip  
$external_id  
$phonenumber The phonenumber supplied by the user
$areacode  
$email The e-mail of the user

Variables for the Portal Strings.

Variable Replaced by [string #]
%(recovery_freq)s How frequently can a new password can be recovered [4]
%(phonenumber)s The user’s phone number [9 42]
%(transaction_id)s The transaction ID [9 11 28 31 37 42 44 105 121]
%(email)s The user’s e-mail address [11 44 121]
%(grant_ticket_duration)s The minutes of the free Internet access [44, 121]
%(seconds)s The number of seconds an user has to wait [55 113]
%(home)s The link to the Hotspot’s home page. [107]

Only a few of the portal strings (14 on 123) contain variables. For those 14 strings, it is required that every variable contained in the original string (e.g., string #4 You are limited to one request every %(recovery_freq)s.) be contained also in the translated string.

The strings that contain some variables (and which) are the following:

4 %(recovery_freq)s

9, 42 %(phonenumber)s and %(transaction_id)s

11 %(email)s and %(transaction_id)s

28, 31, 37, 105, %(transaction_id)s

44, 121 %(grant_ticket_duration)s, %(email)s, and %(transaction_id)s

55, 113 %(seconds)s

107 %(home)s

Table Of Contents

Previous topic

Reports

Next topic

Hotspot User

Documentation archive

Version 3.2
Version 3.0
Version 2.5
Version 2.4
Version 2.3
Version 2.2
Version 2.1

Other products

Endian Hotspot 5.0
Endian 4i Edge 5.0