Подготовка к установке
Для установки SoftWLC в минимальной конфигурации нам понадобится сервер со следующими параметрами:
- Оперативная память не менее 8Гб
- CPU >= 2200MHz, 4CPU
- Память жесткого диска >= 35Gb
- Выход в Интернет
- Операционная система Ubuntu Server 20.04 LTS / Ubuntu Server 22.04 LTS / Astra Linux Special Edition 1.7.4 (Воронеж) / РЕД ОС Муром
Подробнее о требованиях к серверу смотрите здесь.
Рекомендуется устанавливать контроллер на чистую ОС.
Перед установкой необходимо выполнить обновление пакетов на сервере с помощью команд sudo apt update && sudo apt upgrade.
В комплекте с контроллером идет демо-лицензия.
Загрузка скрипта
В операционной системе необходимо создать отдельную директорию, где будет находиться сам скрипт, конфигурационные файлы, данные сервисов и логи. В качестве примера будет создана директория eltex-softwlc в домашней директории пользователя. Таким образом, полный путь будет выглядеть следующим образом
/home/<имя пользователя>/eltex-softwlc
Далее, необходимо загрузить скрипт установщик по ссылке из репозитория и разместить его в директории, созданной ранее.
Данную операцию также можно выполнить из терминала:
tester@localhost:~$ wget http://archive.eltex-co.ru/wireless/help/softwlc-latest/eltex-softwlc-helper-docker-latest.sh
--2023-12-21 08:30:24-- http://archive.eltex-co.ru/wireless/help/softwlc-latest/eltex-softwlc-helper-docker-latest.sh
Resolving archive.eltex.org (archive.eltex-co.ru)... 172.16.0.68
Connecting to archive.eltex-co.ru (archive.eltex-co.ru)|172.16.0.68|:80... connected.
HTTP request sent, awaiting response... 200 OK
Length: 25615 (25K) [text/x-sh]
Saving to: ‘eltex-softwlc-helper-docker-latest.sh’
eltex-softwlc-helper-docker_1.29 100%[=====================================>] 25,01K --.-KB/s in 0,02s
2019-04-29 08:30:24 (1,61 MB/s) - ‘eltex-softwlc-helper-docker-latest.sh’ saved [25615/25615]
Необходимо перейти в созданную директорию и выдать права на исполнение файла eltex-softwlc-helper-docker-latest.sh
tester@localhost:~$ cd eltex-softwlc
tester@localhost:~/eltex-softwlc$ chmod +x ./eltex-softwlc-helper-docker-latest.sh
Все действия со скриптом необходимо проводить с использованием sudo
Начало работы
Для успешного запуска SoftWLC в docker необходимо выполнить следующие шаги:
1) Установить Docker и его зависимости с помоью ключа --install. В директории со скриптом запустите его следующим образом:
tester@localhost:~/eltex-softwlc$ sudo ./eltex-softwlc-helper-docker-latest.sh --install
Дождаться завершения установки и надписи Install is complete
После установки для соблюдения требований информационной безопасности, доступ к командам docker выполняется только от пользователя root. При необходимости можно воспользоваться подробной инструкцией на официальном сайте docker. Краткая инструкция приведена ниже. Данные команды нужно выполнять от лица того пользователя, которому будет разрешено использование docker без sudo.
tester@localhost:~/eltex-softwlc$sudo groupadd docker
tester@localhost:~/eltex-softwlc$sudo usermod -aG docker $USER
tester@localhost:~/eltex-softwlc$newgrp docker
2) Загрузить конфигурационные файлы.
tester@localhost:~/eltex-softwlc$ sudo ./eltex-softwlc-helper-docker-latest.sh -d
При запуске ключа с параметром -d происходит очистка конфигурационных файлов env. Если вы решили выполнить эту операцию на рабочей системе, то необходимо сделать бэкап старых данных. Он выполняется с помощью ключа --backup, результатом является архив с копиями всех настроек, volume и.т.д, что находится в директории скрипта. Архив размещается в директории backup
3) Запустить конфигурацию системы. Это можно сделать, задав специальные ключи:
| Ключ | Значение |
|---|---|
| --configure | Настройка параметров SoftWLC |
| --emsip | Адрес EMS из сети управления |
| --serverip | Адрес личного кабинета и конструктора порталов из сети управления |
| --run | Запуск контейнеров |
Команда целиком выглядит следующим образом:
tester@localhost:~/eltex-softwlc$ sudo ./eltex-softwlc-helper-docker_1.29.sh --configure --emsip <IP адрес EMS> --serverip <IP адрес личного кабинета> --run
По завершению работы скрипта в терминале появятся данные для подключения:
Installation of Eltex SoftWLC finished successfully.
URLs of SoftWLC components:
Eltex.EMS Server management (internal) IP: <адрес EMS>
Eltex.EMS Server external IP: <адрес EMS>
Eltex.EMS GUI: http://<адрес EMS>:8080/ems/jws
login: admin
password: <empty>
Portal constructor: http://<Адрес конструктора порталов>:8080/epadmin
login: admin
password: password
Wi-Fi customer cabinet (B2B): http://<Адрес Личного кабинета>:8080/wifi-cab
login: admin
password: password
4) Систему необходимо конфигурировать только при первой установке. Для запуска уже установленной системы необходимо использовать ключ --run, для остановки --stop:
tester@localhost:~/eltex-softwlc$ sudo ./eltex-softwlc-helper-docker_1.29.sh --run
tester@localhost:~/eltex-softwlc$ sudo ./eltex-softwlc-helper-docker_1.29.sh --stop
На данном этапе установка SoftWLC в докере завершена. Остальные возмоджности скрипта рассмотрены ниже.
Начиная с версии 1.28 SoftWLC точки доступа realtek (WEP-200l,WEP/WOP-2L/30L, WEP-1L, WOP-30LS/30L-ex) необходимо обновить на версию 2.3.0 и выше, точки доступа wep-3ax на версию 1.11 и выше.
Инструкция по обновлению:v1.29_Обновление ПО ТД через SoftWLC
Запросить данное ПО можно через Service Desk или через заявку на нашем официальном сайте.
Создание резервной копии системы
При необходимости, резервную копию всех данных сервисов SoftWLC можно выполнить, используя ключ --backup. Все данные, содержащиеся в папке со скриптом-установщиком, помещаются в архив в директорию backup. Запуск происходит следующим образом:
tester@localhost:~/eltex-softwlc$ sudo ./eltex-softwlc-helper-docker_1.29.sh --backup
Backup has been completed!
tester@localhost:~/eltex-softwlc$ ls
args-compose-tools.log backup data docker-compose.yml eltex-softwlc-helper-docker_1.29.sh environment softwlc.tar volumes
tester@localhost:~/eltex-softwlc$ ls backup/
backup_20231221T100340.tar.gz
Запуск апплета EMS
Перед запуском апплета EMS через приложение Java Web Start убедитесь, что на ПК установлен Oracle Java.
В строке браузера введите следующий адрес:
http://<ip address SoftWLC>:8080/ems/jws/
При этом в браузере появится предложение открыть или скачать файл с расширением jnlp. Откройте этот файл с помощью приложения Java Web Start.
Рекомендуем использовать Oracle Java 17. Инструкция по запуску апплета - v1.29_Запуск апплета EMS на Java 17
Для создания ярлыка на рабочем столе для запуска апплета EMS в Java Control Panel должно быть включено хранение временных файлов.
После установки Вы можете изменить пароли в различных модулях SWLC:
Добавление лицензии
Для базовой лицензии. Файл 'licence.xml'.
Нужно заменить файл 'licence.xml' в каталоге '/eltex-softwlc/data/eltex-ems/usr/lib/eltex-ems/conf/licence' и перезапустить сервис eltex-ems.
Для инкрементальной лицензии. Файл 'licence-2.xml', 'licence-3.xml' и т.д.
Нужно скопировать файл 'licence-2.xml' в каталог '/eltex-softwlc/data/eltex-ems/usr/lib/eltex-ems/conf/licence' и перезапустить сервис eltex-ems.
После добавления лицензии необходимо пересобрать контейнер командой :
|
Ключи запуска скрипта
| Ключ | Значение |
|---|---|
--backup | Сохраняет резервную копию всех данных и конфигурационных файлов сервисов SoftWLC |
| --clean | Удаляет контейнеры и очищает все данные сервисов |
| --configure | Запускается один раз при установке сервисов SoftWLC. Производит предварительную настройку БД. |
| --delete-containers | Удаляет контейнеры |
| --download, -d | Загружает установочный архив, содержащий конфигурационные файлы |
| --emsip <ADDRESS> | Устанавливает адрес EMS в сети управления |
| --generate-keys | Генерирует новые ключи для сервисов Eltex-doors и Eltex-wifi-cab |
| --help, -h | Справка о ключах скрипта |
| --install | Устанавливает docker, docker-compose |
| --pull, -p | Загружает последние версии образов сервисов SoftWLC |
| --recreate-service <SERVICE> | Пересобирает сервис после примененых изменений к нему |
| --serverip <ADDRESS> | Устанавливает адрес личного кабинета и конструктора порталов в сети управления |
| --run, -r | Запускает контейнеры |
| --show-containers | Показывает актуальную информацию о запущенных контейнерах |
| --show-images | Показывает актуальную информацию о загруженных образах |
| --stop | Останавливает все контейнеры |
| --test-ports | Запускает функционал проверки портов SoftWLC |
Изменение переменных окружения
В случае необходимости изменить или добавить какие-либо переменные окружения, необходимо добавить или исправить их в файле .env.override или в файлах