Page tree
Skip to end of metadata
Go to start of metadata

<div class="aui-message error aui-message-error">
<p class="title">
<span class="aui-icon icon-error"></span>
<strong>Comala Metadata License Details</strong>
</p>
<p>Invalid commercial evaluation license with a expired error. Please click <a href="https://marketplace.atlassian.com/plugins/org.andya.confluence.plugins.metadata" target="_blank">here</a> to purchase a commercial license.</p>
</div>

Описание

В состав SoftWLC включен WEB-портал, с помощью которого реализуется модель авторизации hotspot-клиентов. Неизвестный системе пользователь может свободно (без получения заранее логина и пароля) подключиться к точке доступа, но при попытке выйти в интернет через браузер пользователь перенаправляется на страницу WEB-портала, на которой может по выбору пройти процедуру авторизации или получения авторизационных данных (например, с помощью SMS). В процессе выполнения процедур авторизации абонент может наблюдать рекламные сообщения в виде баннеров, кастомизированных в соответствии с требованиями оператора.

Данный сервис используется для отображения страниц виртуальных порталов и проведения регистрации и авторизации Wi-Fi пользователей, подключающихся на точках доступа Eltex или при помощи ESR/BRAS.

Установка выполняется при помощи пакета eltex-portal.

Во время инициализации сервиса eltex-portal и до момента пока сервис полностью не загрузится,  вместо портала будет отображаться страница "Warming up".  Что свидетельствует о том, что портал еще в процессе инициализации, а модули сервиса находятся в процессе конфигурации. После того как сервис eltex-portal полностью загрузился, будет произведен автоматический редирект пользователя на главную страницу портала.
Пример страницы инициализации портала:

Управление сервисом

ДействиеКомандаОтвет
Проверка состояния
service eltex-portal status

Сервис работает

eltex-portal start/running, process <pid>

Сервис не работает

eltex-portal stop/waiting
Запуск сервиса
service eltex-portal start

Сервис запустился

eltex-portal start/running, process <pid>

Сервис уже работает

start: Job is already running: eltex-portal
Остановка сервиса
service eltex-portal stop

Сервис успешно остановлен

eltex-portal stop/waiting

Сервис не остановлен, т.к. не был запущен

stop: Unknown instance: 
Перезапуск сервиса
service eltex-portal restart

Сервис успешно перезапущен

eltex-portal stop/waiting
eltex-portal start/running, process <pid>
stop: Unknown instance: 
eltex-portal start/running, process <pid>


Конфигурация

/etc/eltex-portal/application.conf

основной конфигурационный файл. Пример дефолтной конфигурации:

portal {
    defaultRedirectUrl = "http://eltex-co.ru"
    tariffCheckerPeriod = 1440
}

jetty {
    https {
        port = 9443
        keystorePass = 12345
        keystoreFile = /etc/eltex-portal/localhost.pfx
        keystoreType = PKCS12
        keyAlias = 1
        ciphers = [
            TLS_RSA_WITH_AES_128_CBC_SHA256
            TLS_RSA_WITH_AES_128_CBC_SHA
            TLS_RSA_WITH_AES_256_CBC_SHA256
            TLS_RSA_WITH_AES_256_CBC_SHA
        ]
    }

    accessLog {
        enabled = true
        directory = /var/log/eltex-portal/

        # <default> : NCSA format
        # <custom>  : customized NCSA with additional parameters
        format = default
        retainDays = 30
        append = false
        logCookies = true
        logAP = true
        logBRAS = true
    }
}

database {
    host = localhost
    port = 3306
    name = ELTEX_PORTAL
    user = javauser
    password = javapassword

    readOnly = true

    pool {
        # Time to wait for a connection
        connectionTimeout = 10s
        # Time to wait for connection validation
        validationTimeout = 3s

        min = 1
        max = 10
    }

    cache {
        # Limit of cached simple entries count (for each query type)
        maxEntries = 1000
        # Limit of total cached portal resources size
        maxResourceBytes = 32m
        # Maximum time to retain items in the cache
        expireTime = 2m
    }
}


ПараметрыОписание
portal

defaultRedirectUrl

Адрес, на который будет выполнено перенаправление пользователя в случае когда необходим перезапустить его сессиию на портале. Должен быть настроен по протоколу http.

tariffCheckerPeriod

Интервал выполнения проверки наличия тарифных планов на порталах. В случае отсутствия тарифного плана формируется сообщение об ошибке.
jetty
https

Настройки работы контейнера по https. Необходимо указать расположение сертификата, ключ и прослушиваемый порт.

port - прослушиваемый порт

keystorePass - ключ от хранилища сертификатов

keystoreFile - файл хранилища, содержащий сертификат

keystoreType - тип хранилища

certAlias - алиас сертификата в хранилище

ciphers - поддерживаемые методы шифрования


accessLog

Логирование запросов на сервис.

enabled - статус логирования

directory - директория сохранения логов

format - форма логов default - стандартный формат NCSA, custom - расширенный формат для отладки

append - продолжение записи существующего файла после перезапуска сервиса

retrainDays - время хранения логов

append - дополнительная информация

logCookies - сохранение cookie в логах

logAP - сохранение заголовков переданных точкой доступа

logBRAS - сохранение данных, переданных BRAS'ом

database
hostАдрес сервера БД
portПорт, на который сервер БД принимает входящее подключение
nameНазвание БД
userИмя пользователя БД
passwordПароль пользователя БД

readOnly

Статус подключения к базе данных

pool

Управление соединениями к БД

connectionTimeout - Время жизни коннекта при бездействии

validationTimeout - интервал проверки бездействующих коннектов

min - минимальное количество коннектов

max - максимальное количество коннектов

cache

Настройки кэширования

maxEntries - максимальное количество элементов в кэше

maxResourceBytes - размер кэша

expireTime - время хранения данных в кэше



/etc/default/eltex-portal

Файл содержит параметры, необходимые для инициализации сервиса. Пример дефолтной конфигурации:

# Eltex-Portal daemon parameters

# Port for use by Eltex Portal
PORT=9000

# Initial size of Java heap
JAVA_INIT_HEAP=16m
# Maximum size of Java heap
JAVA_MAX_HEAP=256m

# Additional arguments to pass to java
JAVA_OPTS="-XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/var/log/eltex-portal"
ПараметрыОписание
PORT
порт, на который сервис будет принимать соединения
JAVA_INIT_HEAP
Количество памяти, выделяемое на работу сервиса при старте. Рекомендуется выставлять равное JAVA_MAX_HEAP.
JAVA_MAX_HEAP
Максимальное количество памяти, которое может зарезервировать сервис
JAVA_OPTS
Дополнительные опции для запуска jvm

/etc/eltex-portal/log4j2.xml

настройки логирования работы сервиса. Пример дефолтной конфигурации

<?xml version="1.0" encoding="UTF-8"?>

<configuration monitorInterval="600">
    <properties>
        <Property name="maxFileSize">20 MB</Property>
        <Property name="accumulatedFileSize">100 GB</Property>
        <Property name="lastModified">4d</Property>
        <Property name="maxCount">20</Property>
        <Property name="baseDir">/var/log/eltex-portal</Property>
    </properties>
    <appenders>

        <RollingFile name="RollingFile" fileName="${baseDir}/log_ep.txt"
                     filePattern="${baseDir}/log/log_ep-%i.txt.gz">
            <PatternLayout>
                <pattern>%d{ISO8601} [%t] %-5p %logger{12} %C{1}.%M(line:%L). %m%n</pattern>
            </PatternLayout>
            <Policies>
                <SizeBasedTriggeringPolicy size="${maxFileSize}"/>
            </Policies>
            <DefaultRolloverStrategy max="${maxCount}">
                <Delete basePath="${baseDir}" maxDepth="3">
                    <IfFileName glob="log_ep-*.txt.gz">
                        <IfLastModified age="${lastModified}" />
                        <IfAny>
                            <IfAccumulatedFileCount exceeds="${maxCount}" />
                            <IfAccumulatedFileSize exceeds="${accumulatedFileSize}" />
                        </IfAny>
                    </IfFileName>
                </Delete>
            </DefaultRolloverStrategy>
        </RollingFile>

    </appenders>

    <Loggers>
        <Root>
            <AppenderRef ref="RollingFile" level="WARNING"/>
        </Root>
        <Logger name="org.springframework" level="INFO"/>
        <Logger name="net.sf.ehcache"      level="ERROR"/>
        <Logger name="org.eclipse.jetty"   level="INFO"/>

        <!--SQL logging-->
        <Logger name="org.jooq.tools.LoggerListener" level="OFF"/>

        <Logger name="jndi"       level="OFF"/>
        <Logger name="org.quartz" level="OFF"/>
        <Logger name="com.zaxxer" level="OFF"/>
        <Logger name="org.apache" level="OFF"/>
    </Loggers>

</configuration>



ПараметрОписание
monitorInterval
Интервал автоматического перечитывания конфигурации логгера.
maxFileSize
Максимально допустимый размер файла. При его превышении создается новый файл. а старый архивируется
accumulatedFileSize
Суммарный размер логов (текущий файл + архивные). При его превышении наиболее старые файлы будут удаляться.
lastModified
Срок хранения логов, файлы модифицированные раннее этого срока будут удаляться.
maxCount
Максимальное количество архивных файлов, при его превышении наиболее старые файлы будут перезаписываться.
baseDir
Базовая директория хранения логов.


<AppenderRef ref="RollingFile" level="ERROR"/>
минимальный порог записи для всех логеров

Описание ошибок в логах.

Логфайл: /var/log/eltex-portal/log_ep.txt 

НазваниеЗначениеПример
CHECK LOGIN AND PSW IN smsc_gate.confПроблема доступности NGW к сервису отправки SMS сообщений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Проблема доступности портала к сервису NGW2020-07-09T09:45:07,827 [qtp76432244-17] ERROR org.eltex.portal.sms.NotificationClient NotificationClient.getConfigurationInfo(line:527). Can`t connect to Ngw server with code: 1601 code 1601:NGW_NOT_AVAILABLE and reason: NgwException{FAILED: 'Protocol is not supported by the server: eltex-ngw-api#1.16.5'}
  • No labels