Description
WEB portal is included into SoftWLC project to implement Hotspot clients authorization model. An unknown user can connect to an access point without getting login and password in advance. But if he (or she) tries to access the Internet via a browser, he will be redirected to a WEB portal page where authorization or credentials obtaining (for example, via SMS) can be performed. During authorization, a user can see advertisement banners customized in accordance with operator's requirements.
The service is used for displaying virtual portals' pages and for registration and authorization of Wi-Fi users connected via Eltex access points or ESR/BRAS.
Installation is performed using eltex-portal package.
"Warming up" page will be dispayed instead of the portal during eltex-portal service initialization until the service is fully loaded. It shows that both portal initialization and service module configuration processes have not been finished yet. After eltex-portal service is fully loaded, the user will be redirected to the main page of the portal.
An example of a portal initialization page:
Service management
Operation | Command | Response |
Status check | service eltex-portal status | Service is running eltex-portal start/running, process <pid> Service is waiting eltex-portal stop/waiting |
Service start | service eltex-portal start | Service has been started eltex-portal start/running, process <pid> The service is already running start: Job is already running: eltex-portal |
Service stop | service eltex-portal stop | Service has been stopped successfully eltex-portal stop/waiting Service has not been stopped, as it was not started stop: Unknown instance: |
Service restart | service eltex-portal restart | Service has been restarted successfully
|
Configuration
/etc/eltex-portal/application.conf
main configuration file. Default configuration example:
Parameter | Description |
portal | |
defaultRedirectUrl | The address where the user will be redirected if his session should be restarted. It should be set in accordance with http protocol. |
tariffCheckerPeriod | The interval for checking tariff availability on portals. If there are no available tariffs, the error message is generated. |
jetty | |
https | Configuring container operation on https. Certificate location, key and listened port must be specified. |
accessLog | Server requests logging. |
database | |
host | Database server address |
port | The port of the database server for getting inbound connection |
name | Database name |
user | Database user's name |
password | Database user's password |
readOnly | Database connection status |
pool | Database connections management |
cache | Caching settings |
/etc/default/eltex-portal
The file contains parameters needed for service initialization. Default configuration example:
Parameter | Description |
PORT | The port for the server to get connections. |
JAVA_INIT_HEAP | Amount of memory allocated for service operation on startup. Recommended to be set equal to JAVA_MAX_HEAP. |
JAVA_MAX_HEAP | Maximum amount of memory that the service can reserve. |
JAVA_OPTS | Additional options for jvm launch. |
/etc/eltex-portal/log4j2.xml
service operation logging settings. Default configuration example
Parameter | Description |
monitorInterval | The interval for automatic monitoring of the logger configuration. |
maxFileSize | The maximum file size. When exceeded, a new file is created, and an old file is archived. |
accumulatedFileSize | Total log size (a current file + archived ones). When exceeded, the oldest files will be deleted. |
lastModified | Log storage time, files modified earlier than the timeless, will be deleted. |
maxCount | The maximum number of archived files. When exceeded, the oldest files will be deleted. |
baseDir | Base directory to store logs. |
<AppenderRef ref="RollingFile" level="ERROR"/> | Minimum logging level. |
Log errors description
Log file: /var/log/eltex-portal/log_ep.txt
Browser | Description | Example |
CHECK LOGIN AND PSW IN smsc_gate.conf | NGW failed to access SMS sending service | 2018-08-22T09:38:56,420 [SimpleContainerScope.Executor@266376052-35] ERROR org.eltex.portal.sms.SendSmsWithPswResponseHandler SendSmsWithPswResponseHandler.onResult(line:53). Error while sending message on number: 79529056800. ErrorCode: 10, errMessage: 79529056800. Received error code = 1. CHECK LOGIN AND PSW IN smsc_gate.conf. Error in the parameters of function of dispatch sms via http protocol |
NGW_NOT_AVAILABLE | The portal failed to access NGW service |