Установка базовой версии
Приложение может устанавливаться как под Windows, так и под Linux.
Шаги установки одинаковы для обеих операционных систем, за исключением имён командных файлов (.bat для Windows и .sh для Linux) и файлов конфигурации (*-win.properties, *-linux.properties).
В ходе установке выбирайте соответствующий файл в зависимости от операционной системы.
Предварительные требования
Для развёртывания приложения ПУМА должны быть выполнены следующие требования:
- Установлена операционная система Windows/Linux.
- Установлен Docker (Docker Desktop для Windows).
-
Установлена утилита Docker Compose v2.
Шаг 1. Подготовка дистрибутива
Скачайте файлы дистрибутива по ссылке, предоставленной производителем приложения ПУМА.
Шаг 2. Загрузка Docker образа приложения ПУМА
Вариант установки с образом приложения в виде файла
В данном варианте дистрибутив содержит файл «puma.dockerimage» с Docker образом приложения.
В папке дистрибутива выполните команду:
-
docker-local-load.bat
или
docker-local-load.sh
Убедитесь, что команда отработала успешно:
Образ приложения загружен из файла в локальный репозиторий и может быть использован для развёртывания контейнера.
Вариант установки с подключением к приватному репозиторию ПУМА
В данном варианте поставщик приложения ПУМА предоставляет заказчику доступ к приватному Docker репозиторию. Этот вариант позволяет оперативно обновлять приложение без необходимости вручную скачивать файл puma.dockerimage с образом приложения.
- Получите от поставщика приложения ПУМА файл с ключом доступа к приватному репозиторию (puma-docker-key.json).
-
Импортируйте ключ с помощью команды:
-
Windows:
docker login --username json_key --password-stdin cr.yandex < puma-docker-key.json
-
Linux:
cat puma-docker-key.json | docker login --username json_key --password-stdin cr.yandex
-
Убедитесь, что ключ импортирован корректно:
Шаг 3. Настройка параметров развёртывания
Откройте файл «docker-compose-puma-win.properties» («docker-compose-puma-linux.properties») и проверьте настройки. При необходимости измените номера портов или пути к папкам.
По умолчанию приложение будет развёрнуто со следующими параметрами:
Параметр | Значение по умолчанию |
Комментарий |
---|---|---|
CADDY_PORT | 80 | HTTP порт для сервера Caddy |
CADDY_PORT_SSL | 443 | HTTPS порт для сервера Caddy |
PUMA_PORT | 8080 | Прямой HTTP порт для доступа к приложению в обход Caddy |
PUMA_DATA_FOLDER | c:/puma/ или /opt/puma/ |
Папка |
PUMA_UI_URL | http://localhost/ | URL домашней страницы приложения |
Опционально: проверьте настройки веб-сервера Caddy в файле «Caddyfile». Подробнее см. документацию: https://caddyserver.com/docs/caddyfile
Шаг 4. Запуск развёртывания приложения
Выполните команду:
-
docker-compose-puma.bat
или
docker-compose-puma.sh
Убедитесь, что команда выполнена успешно:
Шаг 5. Проверка результата развёртывания
Результат развёртывания можно проверить через UI Docker Desktop, либо с помощью командной строки (см. инструкции ниже).
Убедитесь, что создано и запущено три контейнера:
- puma
- postgres-puma
- caddy-puma
Для контейнера “puma” убедитесь, что в логе присутствует строка вида
ru.cnsoftware.puma.PumaApplication : Started PumaApplication in 17.588 seconds (JVM running for 18.689)
Проверка через Docker Desktop
Убедитесь, что создан проект «puma», и все три контейнера в нём запущены.
Убедитесь, что в консоли контейнера «puma» присутствует строка «Started PumaApplication…».
Проверка через командную строку
Выполните следующие команды:
- docker ps
Убедитесь, что создано и запущено три контейнера.
- docker container logs puma
Убедитесь, что в консоли контейнера «puma» присутствует строка «Started PumaApplication…».
Шаг 6. Вход в приложение под администратором
Откройте корневую страницу приложения (по умолчанию - http://localhost/, либо другой адрес, указанный в файле конфигурации развёртывания).
Внимание!
Браузер может выдать сообщение, что SSL сертификат недействителен. Это нормально для тестового развёртывания – подтвердите, что Вы хотите продолжить без проверки сертификата:
Для развёртывания в рабочей среде потребуется конфигурация SSL ключа на веб-сервере Caddy или уже существующем сервере в инфраструктуре организации.
Убедитесь, что отображается страница логина.
Войдите в приложение как администратор. Используйте следующие логин и пароль:
- Логин: puma-admin
- Пароль: pumapass
Шаг 7. Инициализация справочников
Под учётной записью администратора, откройте следующий URL:
Нажмите кнопку «Начать инициализацию».
Начнётся процесс инициализации данных. Не закрывайте страницу. Информация о ходе процесса отображается на странице.
Дождитесь сообщения о завершении процесса:
Вернитесь на главную страницу: http://localhost/
Перейдите в раздел «Управление» и убедитесь, что в нём присутствуют базовые словари и классификаторы.
Перейдите в раздел «Издания» и убедитесь, что список изданий заполнен.
Шаг 8. Смена паролей тестовых пользователей
При установке приложения создаются тестовые пользователи с ролями администратора, модератора и пользователя. Логины и пароли предоставляются отдельно производителем приложения ПУМА.
После тестирования и отладки смените пароли пользователей в разделе «Права пользователей».
Шаг 9. Проверка папки данных
Данные приложения хранятся в папке puma-root, указанной в конфигурации развёртывания (по умолчанию – c:/puma/ или /opt/puma).
Убедитесь, что данная папка содержит следующие подпапки:
- caddy
- config
- custom
- import
- logs
- postgresql
Шаг 10. Завершение установки
На данном этапе установка базовой версии завершена.
Вы можете проверить функциональность приложения, описанную в документах «ПУМА – Руководство пользователя» и «ПУМА – Руководство администратора».