Технические требования для установки и работы системы «Ведок»
Описание порядка установки для операционных систем:
По вопросам технической поддержки обращаться на адрес электронной почты: Адрес электронной почты защищен от спам-ботов. Для просмотра адреса в вашем браузере должен быть включен Javascript.. В тексте письма укажите название вашей организации.
При возникновении ошибок прикладывайте логи запуска и работы программы, находящиеся в каталогах: Каталог_программы/tomcat/logs и Каталог_программы/app_home/logs.
Технические требования для работы системы
Поддерживаемые СУБД
PostgreSQL / PostgreSQL Pro 10.3 и более новые версии / MS SQL Server 2012 SP3, рекомендуется MS SQL Server 2014 SP2, MS SQL Server 2016 SP1, MS SQL Server 2019
Требования к серверу БД
Операционная система 64-битная.
Аппаратные требования к серверу БД определяются:
- выбранной платформой (Windows Server 2008 R2 SP1 / Windows Server 2012 R2 / Windows Server 2016 /Альт Сервер 9 и более новые версии/РЕД ОС 7.2 и более новые версии/другая система Linux, выпущенная не ранее 2016 года/macOS выпущенный не ранее 2015 года.
- требованиями СУБД (MS SQL Server / PostgreSQL);
- предполагаемым количеством пользователей системы;
- объемом данных;
В каждом конкретном случае конфигурация сервера определяется индивидуально.
Примерные характеристики сервера на 10-50 пользователей:
- 2 процессора Quad Core (минимально: 1 процессор Core Duo);
- оперативная память 8 Гб (минимально – 4 Гб);
- жесткие диски 500 Гб (минимально 100 Гб) *
*размер жестких дисков определяется объемом обрабатываемых данных.
Требования к серверу приложений:
- Операционная система 64-битная.
- Альт Сервер 9 и более новые версии/РЕД ОС 7.2 и более новые версии/другая версия Linux, выпущенная не ранее 2016 года/macOS выпущенный не ранее 2015 года / ОС Windows Server 2008 R2 SP1 / 2012 R2 / 2016 / 2019;
- Веб-сервер Tomcat 8.5.23 и более новой версии;
- Oracle Java SE Development Kit (JDK) 8 версии 1.8.0_171 или более новая – рекомендуется использовать Belsoft Liberica JDK (Java 9 в настоящее время не поддерживается).
Примерные характеристики сервера на 10-50 пользователей:
- 2 процессора Quad Core (минимально: 1 процессор Core Duo);
- оперативная память 8 Гб (минимально – 4 Гб);
- жесткие диски 500 Гб (минимально 100 Гб).
Возможно размещение сервера приложений и сервера СУБД на одном сервере. В этом случае рекомендуется сервер виртуальный или физический сервер с оперативной памятью не менее 6 ГБ и свободным дисковым пространством от 15 ГБ.
Требования к клиентским устройствам:
ОС Windows 7 / 8 / 8.1 / 10 / MacOS / Linux/ Android 4.3/iPadOS или более новая версия.
Браузеры: Google Chrome, Mozilla Firefox, Safari, Opera 15+, Internet Explorer 9+, Microsoft Edge.
Установка для системы Windows
1. Проверка наличия Java
Убедитесь, что на вашем компьютере установлена Java version 8. Для этого откройте раздел «Установка и удаление программ» и найдите в нем Oracle Java версии 8 или Axiom JDK версии 8.
Если программа не найдена, перейдите на сайт https://axiomjdk.ru/pages/downloads/ и скачайте сборку для вашей разрядности системы Windows. Установите скачанный файл c настройками по умолчанию.
При наличии Oracle Java проверьте и при необходимости создайте переменную окружения JAVA_HOME (Мой компьютер - Свойства - Дополнительные параметры системы - Переменные среды...).
В разделе Системные переменные создайте новую с именем JAVA_HOME и значением C:\Program Files\Java\jdk1.8.0_321 – данное значение приведено для установленной java версии 1.8.0.321. Имя каталога для вашей версии будет другим.
2. Распаковка приложения
Дистрибутив поставляется в виде архива. Создайте каталог, в котором будет размещаться программа. Распакуйте архив в созданный каталог.
3. Особенности при использовании СУБД MS SQL Server.
Запустите SQL Management Studio и разверните ветку Безопасность под узлом вашего сервера. В "Имена для входа" выбрать логин SA и посмотреть его свойства.
Скорее всего, в разделе "Язык по умолчанию" у вас указан Russian. Это часто приводит к проблемам выполнения скриптов. Из-за этого не загружаются все данные типовых настроек, т.к. в скрипте формат даты интернациональный, а если у SA установлен русский язык, то SQL ожидает даты в формате русской локали.
Измените для логина SA язык по умолчанию на English - us_english.
4. Особенности при использовании СУБД PostgreSQL
Дистрибутив доступен по ссылке: https://www.enterprisedb.com/downloads/postgres-postgresql-downloads
Средство администрирования PgAdmin: https://www.pgadmin.org/download/pgadmin-4-windows/
При установке на шаге выбора локализации выберите:
Остальные пункты изменения не требуют.
5. Создание базы данных
Средствами СУБД создайте пустую базу (по умолчанию имя базы «vedocdb»):
Примечание: В MS SQL Server в создаваемой базе «Параметры сортировки» должны быть «Cyrillic_GeC_AS».
– При создании базы данных в PostgreSQL введите только имя базы данных, не изменяя другие параметры.
6. Изменение конфигурационного файла для подключения к БД
При создании базы с другим именем – произведите корректировку файла local.app.properties в каталоге tomcat\webapps\vedoc\WEB-INF.
В текущей конфигурации установлены параметры по умолчанию для PostgreSQL:
cuba.dataSource.username = vedoc – владелец базы данных;
cuba.dataSource.password= vedoc – пароль владельца базы данных;
cuba.dataSource.dbName = vedocdb – имя базы данных;
cuba.dataSource.host = localhost – имя сервера СУБД (при использование на одном сервере);
cuba.dataSource.port = 5432 – порт СУБД;
Параметры при использовании MS SQL Server:
Добавьте строку:
cuba.dbmsType = mssql
Измените:
cuba.dataSource.username = sa – владелец базы данных;
cuba.dataSource.password= XXXXXXX – пароль владельца базы данных;
cuba.dataSource.dbName = vedocdb – имя базы данных;
cuba.dataSource.host = localhost – имя сервера СУБД (при использование на одном сервере, при использовании отдельного сервера СУБД измените данное поле);
cuba.dataSource.port = 1433 – порт СУБД;
7. Изменение имени компьютера и номера порта приложения
Для своей работы приложение использует порт 8080 и локальное имя компьютера.
При необходимости использования приложения по локальной сети произведите следующие изменения:
– Измените значение localhost на имя или IP адрес компьютера в параметре и соответственно номер 8080 на планируемый для использования в файле local.app.properties в каталоге tomcat\webapps\vedoc\WEB-INF, где установлена программа.
cuba.webAppUrl = http://localhost:8080/vedoc,
– Изменить номер порта необходимо также в файле tomcat\conf\server.xml
Найдите секцию:
<Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443" />
Измените port="8080" на новое значение.
8. Пробный запуск приложения
Запустите на выполнение файл «startup.bat» из каталога tomcat/bin/
Появление сообщения: «INFO: Server strartup in …. ms» означает запуск приложения.
Для доступа к приложению перейдите в браузере по ссылке «http://localhost:8080/vedoc»
В случае внесении изменений в имя и/или номера порта, например на 8111, ссылка будет иметь вид: http://имя_компьютера:8111/vedoc
При правильной настройке вы попадете на страницу входа в систему «Ведок»:
9. Установка запуска/остановки приложения через системную службу
– Откройте «командную строку» от имени администратора.
– Перейти в папку «tomcat\bin» внутри распакованного дистрибутива Ведок, например если вы распаковали дистрибутив в директорию «c:\Vedoc\», то команда будет выглядеть «cd c:\Vedoc\tomcat\bin»
– Выполните «service.bat install»
После установки приложения как системной службы управление запуском и остановкой выполняется через «Панель управления» -> «Администрирование» -> «Службы» -> «ApacheTomcat…»
Установка системы на Linux
1. Проверка наличия установленной Java 8
java-version
openjdk version "1.8.0_312"
OpenJDK Runtime Environment (build 1.8.0_312-8u312-b07-0ubuntu1~20.04-b07)
OpenJDK 64-Bit Server VM (build 25.312-b07, mixed mode)
2. Установка Java 8
При отсутствии произведите загрузку и установку (пример для Ubuntu в терминале):
sudo apt install openjdk-8-jdk
или java от компании BellSoft
wget https://download.bell-sw.com/java/8u292+10/bellsoft-jdk8u292+10-linux-amd64.deb
sudo apt install ./bellsoft-jdk8u292+10-linux-amd64.deb
или с сайта https://axiomjdk.ru/pages/downloads/
3. Определение переменной окружения при использовании Java 8
Создайте файл с переменными окружения (выполнять данный пункт только при установке java командой sudo apt install openjdk-8-jdk)
sudo vi /etc/profile.d/java8jdk.sh
со следующим содержанием:
export PATH=$PATH:/usr/lib/jvm/java-8-openjdk-amd64/bin export
JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64
export JRE_HOME=/usr/lib/jvm/java-8-openjdk-amd64/jre
export J2SDKDIR=/usr/lib/jvm/java-8-openjdk-amd64
export J2REDIR=/usr/lib/jvm/java-8-openjdk-amd64/jre
Выполните следующую команду для их установки в терминале:
sudo source /etc/profile.d/java8jdk.sh
4. Создание пользователя и группы для работы приложения
Создайте пользователя tomcat участником группы tomcat с домашней директорией /opt/vedoc (куда мы будем устанавливать Ведок) и с оболочкой в /bin/false
sudo groupadd tomcat
sudo useradd -s /bin/false -g tomcat -d /opt/vedoc tomcat
5. Установка PostgreSQL
sudo apt-get install postgresql postgresql-contrib
6. Распаковка архива с приложением
Дистрибутив поставляется в виде архива. Создайте каталог /opt/vedoc. Распакуйте архив в созданный каталог и сделайте пользователя tomcat владельцем всех файлов
sudo chown tomcat:tomcat /opt/vedoc -R
7. Создание базы данных
Средствами СУБД создайте пустую базу (по умолчанию имя базы «vedocdb, владелец vedoc с паролем vedoc») или из терминала
sudo -i -u postgres psql -c "CREATE DATABASE vedocdb;"
sudo -i -u postgres psql -c "CREATE USER vedoc WITH password 'vedoc';"
sudo -i -u postgres psql -c "GRANT ALL privileges ON DATABASE vedocdb TO vedoc;"
8. Изменение конфигурационного файла для подключения к БД
В случае создания базы с другим именем – произведите корректировку файла local.app.properties в каталоге /opt/vedoc/webapps/vedoc/WEB-INF, внеся необходимые изменения:
cuba.dataSource.username = vedoc – владелец базы данных;
cuba.dataSource.password= vedoc – пароль владельца базы данных;
cuba.dataSource.dbName = vedocdb – имя базы данных;
cuba.dataSource.host = localhost – имя сервера СУБД (при использование на одном сервере, имя компьютера или IP адрес при использовании на разных);
cuba.dataSource.port = 5432 – порт СУБД;
9. Изменение имени компьютера и номера порта приложения
Для своей работы приложение использует порт 8080 и локальное имя компьютера.
При необходимости использования приложения по локальной сети произведите следующие изменения и используйте другой порт:
– значение localhost в параметре cuba.webAppUrl =http://localhost:8080/vedoc файла /opt/vedoc/tomcat/webapps/vedoc/WEB-INF/local.app.properties на имя или IP адрес компьютера, где установлена программа, и 8080 на новое значение.
– в файле «opt/vedoc/tomcat/conf/server.xml», находим:
<Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443" />
И меняем port="8080" на значение, выбранное на предыдущем шаге.
10. Установка бита исполнения у запускаемых файлов
В каталоге /opt/vedoc/tomcat/bin приложения установите бит исполнения на все файлы с расширением .sh
sudo chmod u+x /opt/vedoc/tomcat/bin/*.sh
11. Пробный запуск приложения
Выполните startup.sh из каталога /opt/vedoc/tomcat/bin для запуска приложения.
Для контроля запуска выполните:
tail –f /opt/vedoc/tomcat/logs/catalina.out
Появление строки:
10-Mar-2022 04:02:36.745 INFO [main] org.apache.catalina.startup.HostConfig.deployWAR
Deployment of web application archive [/opt/ap/webapps/vedoc.war] has finished in [36 093] ms
10-Mar-2022 04:02:36.750 INFO [main] org.apache.coyote.AbstractProtocol.start Starting
ProtocolHandler ["http-jsse-nio-8080"]
10-Mar-2022 04:02:36.762 INFO [main] org.apache.catalina.startup.Catalina.start Server startup
in [36 255] milliseconds
Означает успешный запуск приложения.
12. Создание системного юнита для автоматического запуска
Для автоматического запуска программы создайте файл vedoc.service в каталоге /etc/systemd/system (для систем использующих систему инициализации systemd)
sudo vi /etc/systemd/system/vedoc.service
следующего содержания (приведен пример при использовании Java от компании BellSoft и установки приложения в каталог /opt/vedoc):
[Unit]
Description=Apache Tomcat Web Application Container
After=network.target
[Service]
Type=forking
Environment=JAVA_HOME=/usr/lib/jvm/bellsoft-java8-amd64
Environment=CATALINA_PID=/opt/vedoc/tomcat/temp/tomcat.pid
Environment=CATALINA_HOME=/opt/vedoc/tomcat
Environment=CATALINA_BASE=/opt/vedoc/tomcat
Environment='CATALINA_OPTS=-Xms1024M -Xmx1024M -server -XX:+UseParallelGC'
Environment='JAVA_OPTS=-Djava.awt.headless=true -Djava.security.egd=file:/dev/./urandom -
Dapp.home=/opt/vedoc/app_home'
ExecStart=/opt/vedoc/tomcat/bin/startup.sh
ExecStop=/opt/vedoc/tomcat/bin/shutdown.sh
User=tomcat
Group=tomcat
UMask=0007
RestartSec=10
Restart=always
[Install]
WantedBy=multi-user.target
13. Внесите изменения в систему инициализации:
sudo systemctl daemon-reload
14. Команды для запуска/остановки/отслеживания статуса работы приложения:
sudo systemctl start/stop/status vedoc
15. Включение автоматического запуска приложения при запуске операционной системы:
sudo systemctl enable vedoc
Установка системы на macOS
1. Проверьте наличие установленной программы Java
Проверьте наличие установленной программы java, запустив Терминал.
java -version
openjdk version "1.8.0_312"
OpenJDK Runtime Environment (build 1.8.0_312-8u312-b07-0ubuntu1~20.04-b07)
OpenJDK 64-Bit Server VM (build 25.312-b07, mixed mode)
2. Загрузка и установка Java версии 8 от компании BellSoft
При отсутствии произведите загрузку и установку Java версии 8 от компании BellSoft https://axiomjdk.ru/pages/downloads/.
3. Установка PostgreSQL
Произведите установку PostgreSQL:
- https://www.postgresql.org/download/macosx/ - для загрузки и установки полной версии с утилитами для управления;
или
- https://postgresapp.com/downloads.html - приложение, без необходимости установки и без утилит для управления СУБД.
Установите утилиту для администрирования СУБД – pgAdmin - https://www.pgadmin.org/download/pgadmin-4-macos/
4. Распаковка архива с приложением
Дистрибутив поставляется в виде архива. Создайте каталог /opt/vedoc, в котором будет размещаться программа. Распакуйте архив в созданный каталог.
5. Создание базы данных
Средствами СУБД или с помощью утилиты pgAdmin создайте пустую базу (по умолчанию имя базы «vedocdb», владелец vedoc с паролем vedoc ).
6. Изменение конфигурационного файла для подключения к БД
В случае создания базы с другим именем – измените файл local.app.properties в каталоге /opt/vedoc/webapps/vedoc/WEB-INF, внеся необходимые изменения:
cuba.dataSource.username = vedoc– владелец базы данных;
cuba.dataSource.password= vedoc– пароль владельца базы данных;
cuba.dataSource.dbName = vedocdb– имя базы данных;
cuba.dataSource.host = localhost– имя сервера СУБД (при использование на одном сервере);
cuba.dataSource.port = 5432 – порт СУБД;
7. Изменение имени компьютера и номера порта приложения
Для своей работы приложение использует порт 8080 и локальное имя компьютера. При необходимости использования приложения по локальной сети произведите следующие изменения и используйте другой порт:
– значение localhost в параметре cuba.webAppUrl = http://localhost:8080/vedoc файла /opt/vedoc/tomcat/webapps/vedoc/WEB-INF/local.app.properties на имя или IP адрес компьютера, где установлена программа и 8080 на новое значение.
– в файле «opt/vedoc/tomcat/conf/server.xml», находим:
<Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443" />
И меняем port="8080" на значение, выбранное на предыдущем шаге.
8. Установка бита исполнения у запускаемых файлов
В каталоге /opt/vedoc/tomcat/bin приложения установите бит исполнения на все файлы с расширением .sh (в Терминале sudo chmod u+x /opt/vedoc/tomcat/bin/*.sh)
9. Запуск и остановка приложения
Выполните startup.sh из каталога /opt/vedoc/tomcat/bin для запуска приложения. Через минуту приложение будет доступно в браузере по адресу http://localhost:8080/vedoc - на компьютере где оно установлено и http://имя_компьютера:номер_порта/vedoc. Остановка приложения производится выполнением команды shutdown.sh из каталога /opt/vedoc/tomcat/bin
