Руководство администратора
Версия 1.5.5
Требования к серверу приложений
СУБД - 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-битная: Альт Сервер 9 и более новые версии/РЕД ОС 7.2 и более новые версии/другая версия Linux, выпущенная не ранее 2016 года/macOS выпущенный не ранее 2015 года / ОС Windows Server 2008 R2 SP1 / 2012 R2 / 2016 / 2019;
Oracle Java SE Development Kit (JDK) 8 версии 1.8.0_171 или более новая сборка данной версии. Рекомендуем использовать Belsoft Liberica JDK 8 версии (Java более старших версий в настоящее время не поддерживается).
Аппаратные требования к серверу БД определяются:
выбранной платформой (Windows Server/Linux/macOS);
требованиями СУБД (MS SQL Server / PostgreSQL);
предполагаемым количеством пользователей системы;
объемом данных;
В каждом конкретном случае конфигурация сервера определяется индивидуально.
Примерные характеристики сервера на 10-50 пользователей:
2 процессора Quad Core (минимально 1 процессор Core Duo);
оперативная память 8 Гб (минимально 4 Гб);
жесткие диски 100 Гб (минимально 50 Гб)
Возможно размещение сервера приложений и сервера СУБД на одном сервере. В этом случае рекомендуется сервер виртуальный или физический сервер с оперативной памятью не менее 6 ГБ и свободным дисковым пространством не менее 50 ГБ.
Требования к клиентским устройствам.
Операционная система: Windows 7/8/8.1/10, MacOS, Linux, Android 4.3, iPadOS или более новая версия.
Браузеры: Google Chrome, Mozilla Firefox, Safari, Opera 15+, Internet Explorer 11, Microsoft Edge, Яндекс-браузер.
Установка системы на Linux (приводится пример на основе Ubuntu 20.04).
Проверка наличия установленной Java 8 в Linux
Проверка выполняется консольной командой
update-alternatives --list java 2>/dev/null | grep java-8 | head -1
При наличии в системе установленной Java 8 версии будет выведена строка содержащая полный путь к ней. Пустой вывод означает отсутствие установленной Java 8 версии.
Установка Java 8
Выполните команду:
sudo apt install openjdk-8-jdk
и далее создайте файл с переменными окружения:
sudo vi /etc/profile.d/java8jdk.sh
со следующим содержанием:
Выполните следующую команду для их установки в терминале:
sudo –s source /etc/profile.d/java8jdk.sh
Создание пользователя и группы для работы приложения
Создайте пользователя tomcat участником группы tomcat с домашней
директорией /opt/vedoc (куда мы будем устанавливать Ведок) и с оболочкой /bin/false
Установка PostgreSQL в Linux
В том случае если у вас отсутствует установленная СУБД PostgreSQL, установите ее выполнив команду:
Распаковка архива с приложением
Дистрибутив поставляется в виде архива. Создайте каталог /opt/vedoc используя команду:
Распакуйте архив в созданный каталог:
Сделайте пользователя tomcat владельцем всех файлов:
sudo chown tomcat:tomcat /opt/vedoc -R
Установите флаг исполнения на командных файлах:
sudo chmod u+x,o-x /opt/vedoc/tomcat/bin/*.sh
Создание базы данных
Создайте пустую базу средствами СУБД или выполните в терминале команду:
sudo -i -u postgres psql -c "CREATE DATABASE <имя_базы_данных>;"
рекомендуемое имя создаваемой базы данных vedocdb
Проверка конфигурационного файла для подключения к БД
Основной конфигурационный файл приложения имеет имя local.app.properties
и располагается по пути /opt/vedoc/tomcat/webapps/vedoc/WEB-INF
.
Проверьте параметры в этом файле и при необходимости внесите изменения, в соответствии со своими настройками:
cuba.dataSource.username = postgres
– владелец базы данных (по умолчанию postgres);cuba.dataSource.password = postgres
– пароль владельца базы данных (задается при установке или настройке СУБД PostgreSQL);cuba.dataSource.dbName = vedocdb
– имя базы данных, указанной выше;cuba.dataSource.port = 5432
– порт используемый СУБД;cuba.dataSource.host = localhost
– имя сервера СУБД (при установкке СУБД и программы на одном сервере). Имя компьютера или IP адрес, при установке на разных;
Вместо текста <указать_пароль> указать устанавливаемый пароль. Пароль заключается в одинарные кавычки. Вся команда заключается в двойные кавычки.
Более подробное описание состава данного файла по ссылке: https://postgrespro.ru/docs/postgresql/12/auth-pg-hba-conf При внесении изменений в файл pg_hba.conf произведите перезапуск СУБД.
Изменение имени компьютера и номера порта приложения
Для своей работы приложение использует порт 8080 и локальное имя компьютера. При необходимости использования приложения по локальной сети произведите изменения:
в файле local.app.properties находящемуся по пути /opt/vedoc/tomcat/webapps/vedoc/WEB-INF/ значение localhost в параметре
cuba.webAppUrl = http://localhost:8080/vedoc
на имя или IP адрес компьютера, где установлена программа. Номер порта 8080 на требуемое вами значение порта. В свойстве приложения cuba.connectionUrlList измените номер порта 8080 на новое.
– в файле opt/vedoc/tomcat/conf/server.xml, найдите блок параметров:
И измените port="8080"
на значение, выбранное на предыдущем шаге.
Пробный запуск приложения
Выполните команду для запуска приложения:
sudo /opt/vedoc/tomcat/bin/startup.sh
Для контроля запуска выполните:
sudo tail –f /opt/vedoc/tomcat/logs/catalina.out
Появление строк
означает успешный запуск приложения.
Для доступа к приложению перейдите в браузере по ссылке: http://localhost:8080/vedoc
В случае внесения изменений в имя, например test и/или номера порта, например на 8111, ссылка будет иметь вид: http://test:8111/vedoc
При правильной настройке вы попадете на страницу входа Ведок:
Учетные данные для входа administrator/administrator – логин/пароль соответственно.
Для завершения работы приложения выполните команду:
sudo /opt/vedoc/tomcat/bin/shutdown.sh
Создание системного юнита для автоматического запуска
Для автоматического запуска программы при старте сервера создайте файл vedoc.service в каталоге /etc/systemd/system
sudo vi /etc/systemd/system/vedoc.service
следующего содержания (приведен пример при установки приложения в каталог /opt/vedoc):
После сохранения файла, для внесения изменений в список системных юнитов, выполните:
sudo systemctl daemon-reload
.
Включите автоматический запуск приложения при запуске операционной системы
sudo systemctl enable vedoc
Используйте команды запуск/остановка/отслеживание статуса для управления работой приложения:
sudo systemctl start/stop/status vedoc
Установка системы в Windows.
Проверка наличия Java в Windows
Убедитесь, что на вашем компьютере установлена 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. Имя каталога для вашей версии будет другим.
Распаковка приложения
Дистрибутив поставляется в виде архива. Создайте каталог, в котором будет размещаться программа. Распакуйте архив в созданный каталог.
Особенности при использовании СУБД MS SQL Server
Запустите SQL Management Studio и разверните ветку Безопасность под узлом вашего сервера. В "Имена для входа" выбрать логин sa и посмотреть его свойства.
Скорее всего, у вас там Russian. Это приводит к проблемам выполнения скриптов. По этой причине не загружаются все данные типовых настроек, т.к. в скрипте формат даты интернациональный, а если у sa установлен русский язык, то SQL ожидает даты в формате русской локали. Измените для логина sa язык по умолчанию на English - us_english.
Особенности при использовании СУБД PostgreSQL в Windows
Дистрибутив доступен по ссылке: https://www.enterprisedb.com/downloads/postgres-postgresql-downloads
Средство администрирования PgAdmin: https://www.pgadmin.org/download/pgadmin-4-windows/
При установке на шаге выбора локализации выберите:
Остальные пункты изменения не требуют.
Создание базы данных
Средствами СУБД создайте пустую базу (используемое по умолчанию в конфигурационном файле имя базы vedocdb):
В MS SQL Server в создаваемой базе «Параметры сортировки» должны быть «Cyrillic_GeC_AS»
При создании базы данных в PostgreSQL введите только имя базы данных не изменяя другие параметры.
Изменение конфигурационного файла для подключения к БД
При создания базы с другим именем – произведите корректировку файла local.app.properties в каталоге tomcat\webapps\vedoc\WEB-INF.
В текущей конфигурации установлены параметры по умолчанию для PostgreSQL:
cuba.dataSource.username = postgres
– владелец базы данных (при создании БД от имени другого пользователя измените это значение );cuba.dataSource.password= postgres
– пароль владельца базы данных (был задан вами на этапе установки СУБД, при необходимости измените);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
– порт СУБД.
Изменение имени компьютера и номера порта приложения
Для своей работы приложение использует порт 8080 и локальное имя компьютера.
Для своей работы приложение использует порт 8080 и локальное имя компьютера. При необходимости использования приложения по локальной сети произведите изменения:
в файле tomcat\webapps\vedoc\WEB-INF\local.app.properties значение localhost в параметре
cuba.webAppUrl = http://localhost:8080/vedoc
на имя или IP адрес компьютера, где установлена программа. Номер порта 8080 на требуемое вами значение порта. В свойстве приложения cuba.connectionUrlList измените номер порта 8080 на новое.в файле tomcat\conf\server.xml найдите секцию:
измените
port="8080"
на новое значение.
Пробный запуск приложения
Запустите на выполнение файл startup.bat
из каталога tomcat/bin/
Появление сообщения: INFO: Server strartup in …. ms означает запуск приложения.
Для доступа к приложению перейдите в браузере по ссылке http://localhost:8080/vedoc
В случае внесении изменений в имя, например test и/или номера порта, например на 8111, ссылка будет иметь вид: http://test:8111/vedoc
При правильной настройке вы попадете на страницу входа Ведок:
Учетные данные для входа administrator/administrator – логин/пароль соответственно.
Команды запуск/остановка приложения:
Для запуска приложения перейдите в каталог \tomcat\bin и запустите файл startup.bat
. Для остановки приложения запустите файл shutdown.bat
в этом же каталоге
Установка запуска/остановки приложения через системную службу
Откройте «командную строку» от имени администратора.
Перейдите в папку tomcat\bin внутри распакованного дистрибутива Ведок. Например, если вы распаковали дистрибутив в директорию c:\Vedoc\, то команда будет выглядеть так:
cd c:\Vedoc\tomcat\bin
Выполните
service.bat install
После установки приложения системной службой управление запуском и остановкой выполняется через Панель управления -> Администрирование -> Службы -> ApacheTomcat…
Установка системы на macOS.
Проверка наличие установленной программы Java
Проверьте наличие установленной программы java, запустив Терминал.
java -version
Ниже приведен вывод данной команды, показывающий установленную версию Java:
Загрузка и установка Java версии 8 от компании BellSoft
При отсутствии произведите загрузку и установку Java версии 8 от компании BellSoft https://axiomjdk.ru/pages/downloads/
Установка PostgreSQL
Доступные ресурсы для загрузки PostgreSQL: https://www.postgresql.org/download/macosx - для загрузки и установки полной версии с утилитами для управления или https://postgresapp.com/downloads.html - приложение, без необходимости установки и без утилит для управления СУБД.
Установите утилиту для администрирования СУБД – pgAdmin
:
Распаковка архива с приложением
Дистрибутив поставляется в виде архива. Создайте каталог /opt/vedoc, в котором будет размещаться программа. Распакуйте архив в созданный каталог.
Создание базы данных
Средствами СУБД или с помощью утилиты pgAdmin создайте пустую базу (по умолчанию имя базы vedocdb, владелец vedoc с паролем vedoc).
Изменение конфигурационного файла для подключения к БД
В случае создания базы с другим именем – измените файл 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
– порт СУБД.
Изменение имени компьютера и номера порта приложения
Для своей работы приложение использует порт 8080 и локальное имя компьютера. При необходимости использования приложения по локальной сети произведите изменения:
в файле /opt/vedoc/tomcat/webapps/vedoc/WEB-INF/local.app.properties значение localhost в параметре
cuba.webAppUrl = http://localhost:8080/vedoc
на имя или IP адрес компьютера, где установлена программа. Номер порта 8080 на требуемое вами значение порта. В свойстве приложения cuba.connectionUrlList измените номер порта 8080 на новое.
– в файле opt/vedoc/tomcat/conf/server.xml, найдите блок параметров:
И измените port="8080"
на значение, выбранное на предыдущем шаге.
Установка бита исполнения у запускаемых файлов
В каталоге /opt/vedoc/tomcat/bin приложения установите бит исполнения на все файлы с расширением .sh
(в Терминале sudo chmod u+x /opt/vedoc/tomcat/bin/*.sh
)
Запуск и остановка приложения
Выполните startup.sh
из каталога /opt/vedoc/tomcat/bin для запуска приложения.
Для доступа к приложению перейдите в браузере по ссылке http://localhost:8080/vedoc В случае внесения изменений в имя, например test и/или номера порта, например на 8111, ссылка будет иметь вид: http://test:8111/vedoc
Остановка приложение производится выполнением команды shutdown.sh
из каталога /opt/vedoc/tomcat/bin
Учетные данные для входа administrator/administrator – логин/пароль соответственно.
Настройка уведомлений посредством электронной почты
Авторизуйтесь в Ведок под пользователем с правами администратора.
Перейдите в меню Администрирование -> Свойства приложения:
Раскройте ветвь cuba в ней найдите и раскройте ветвь email:
Заполните параметры smtp сервера с которого будут отправлять письма:
cuba.email.adminAddress
- адрес электронной почты, на который отправляются все сообщения при включенном свойствеcuba.email.sendAllToAdmin
. Если он указан, то при возникновении в работе программы ошибки, на данный адрес возможно отправить расширенную информацию по ней нажав на кнопку «Сообщить об ошибке».cuba.email.sendAllToAdmin
- указывает, что все сообщения должны отправляться на адресcuba.email.adminAddress
, независимо от указанного адреса получателя. Этот параметр рекомендуется использовать во время отладки системы.cuba.email.smtpHost
- адрес SMTP сервера.cuba.email.smtpPort
- порт SMTP сервера.cuba.email.smtpAuthRequired
- требуется ли аутентификация на SMTP сервере.cuba.email.smtpSslEnabled
- включен ли протокол SSL.cuba.email.smtpStarttlsEnable
- задает использование команды STARTTLS при аутентификации на SMTP сервере.cuba.email.smtpUser
- имя пользователя для аутентификации на SMTP сервере.cuba.email.smtpPassword
- пароль пользователя для аутентификации на SMTP сервере.После заполнения таблица у вас будет выглядеть примерно так:
Для проверки корректности введенных параметров открываем пункт меню Администрирование -> Консоль JMX. Раскрываем ветвь vedoc-core.cuba, в ней найдите строку у которой ObjectName совпадает с
vedoc-core.cuba:type=Emailer
и двойным кликом откройте ее:В данной области введите адрес электронной почты, к которому у вас сейчас есть доступ, и нажмите кнопку Запустить (на него будет выслано тестовое письмо):
Если вы все сделали правильно, то появиться сообщение (адрес электронной почты будет ваш) и на него придет тестовое письмо:
Теперь заходим в Администрирование -> Назначенные задания и нажимаем кнопку Создать
Заполните поля как на картинке ниже и нажимаете Ок.
Period, sec
определяет как часто система рассылает письма(в секундах):После этого нажмите на кнопку «Активировать»:
Настройка системы уведомлений о событиях с карточками в программе посредством электронной почты завершена. В дальнейшем каждый пользователь, в свойствах которого заполнено поле Email, может настроить получение уведомлений по интересующим его событиям. Настройка этого описана в «Ведок. Руководство пользователя» глава «Настройки пользователя».
Обновление программы
Процедура обновления с версии 1.4.х до версии 1.5.0 отличается от стандартной. Перед первым запуском версии 1.5.0 (пункт 10 - смотри ниже) однократно выполните на базе данных Ведок скрипт из файла, находящегося внутри каталога Скрипты БД по ссылке дистрибутива:
при использовании в качестве СУБД MS SQL Server - mssql-activity-renameTables.sql
при использовании в качестве СУБД PostgreSQL - postgres-activity-renameTables.sql
Процедура обновления:
Напишите нам на info@vedoc.biz, запросите дистрибутив новой версии и скачайте его.
Остановите приложение.
Создайте резервную копию используемой приложением базы данных.
Создайте резервную копию файлового хранилища, обычное место хранения файлов каталог - app_home/vedoc_core/work (В случае отсутствия файлов в данном каталоге для уточнения последующих действий свяжитесь с технической поддержкой support@cs-consult.ru)
Сохраните файл local.app.properties из каталога приложения \tomcat\webapps\vedoc\WEB-INF в другое место.
Удалите папку tomcat\webapps\vedoc со всем содержимым.
Из архива vedoc-Х.Х.Х.zip (Х.Х.Х — номер текущей версии) скопируйте содержимое каталога tomcat\webapps\vedoc на то место, где он располагался ранее.
Для систем Linux установите пользователя и группу для новых файлов
sudo chown tomcat:tomcat /opt/vedoc -R
Скопируйте ранее сохраненный файл local.app.properties в каталог \tomcat\webapps\vedoc\WEB-INF с заменой существующего в нем.
Запустите приложение.
Настройка Ведок для работы по протоколу HTTPS
Рассматривается создание самоподписанного сертификата сервера на примере системы Windows (для Linux используется эта же утилита, но для её запуска не потребуется писать полный путь к программе). При необходимости работы самоподписанного сертификата на локальном компьютере (localhost) внесите в него альтернативные имена SubjectAlternativeName (SAN). То есть, URL нашего приложения vedoc на локальном компьютере будет иметь следующий адрес :
// незащищенное соединение
http://localhost:8080/vedoc/
// защищенное соединение
https://localhost:8443/vedoc/
С портом 8080 мы стартовали приложение при незащищенном соединении. Приложение в защищенном соединении будет использовать порт 8443, даже если мы будем пытаться открыть сайт на порту 8080.
Для создания сертификата используется утилита keytool
с ключом -genkey
. Символы переноса '\ использованы только для наглядности представления команды; в реальности они могут быть убраны и команда может быть представлена одной строкой.
Необходимо обратить внимание на опцию -ext
(4-ая строка), которая позволяет включить в сертификат альтернативные имена SAN
, используя в качестве разделителя символ запятой. Помните, что наименования альтернативных имен должны начинаться с символов, т.е. если вместо localhost использовать значение 127.0.0.1 утилита keytool
выбросит исключение :
Для задания IP адресов в качестве альтернативы используйте следующее:
SAN=dns:localhost,IP:10.10.10.1
Сертификат и закрытый ключ будут созданы в файле keystore.jks
Данный файл является хранилищем по умолчанию для java. Более подробная информация о нём по ссылке
Настройка SSL конфигурации сервера Tomcat
Tomcat может использовать две различные SSL реализации:
JSSE (Java Secure Socket Extension) реализацию как часть Java runtime, начиная с версии 1.4;
APR (Apache Portable Runtime) реализацию, использующую по умолчанию OpenSSL engine.
Выбираем первый вариант и настраиваем Tomcat на использование библиотеки Java для безопасных сетевых соединений JSSE, в котором реализованы протоколы SSL и TLS. В первую очередь переносим в директорию /conf созданное на предыдущем шаге хранилище сертификата keystore.jks.
Файл конфигурации server.xml
Находим в директории инсталляции Tomcat'a /conf/ файл конфигурации server.xml и вносим следующий код, в котором указывается порт 8443, схема HTTPS, протокол TLS, тип хранилища JKS и его месторасположение conf/keystore.jks. В обязательном порядке следует указать пароль доступа к хранилищу и алиас ключа/сертификата.
Поскольку APR реализацию не используем, то комментируем строку определения слушателя AprLifecycleListener
.
Дексриптор приложения web.xml
Чтобы перевести WEB-приложение в режим защищенного соединения необходимо настроить дескриптор приложения web.xml. Необходимо добавить следующий код в дескриптор /conf/web.xml в конец файла до завершающего тега /web-app:
Шаблон url-pattern говорит о том, что любую страницу/ресурс приложения (/*
) необходимо показывать в защищенном режиме, т.е. доступ должен быть через HTTPS. Значение CONFIDENTIAL тега <transport-guarantee>
гарантирует работу приложения в SSL соединении.
Чтобы отключить защищенное SSL соединение необходимо только изменить CONFIDENTIAL на NONE. Это может быть использовано, если по каким либо причинам не продлили серверный SSL сертификат и браузер стал открывать предупреждающую об опасности страницу.
Работа с лицензионными ключами
После приобретения программы Ведок, для получения возможности использования всех лицензий, необходимо выполнить запрос лицензионного ключа.
Для его получения выполните следующие действия:
Авторизуйтесь в программе с правами администратора
Перейдите в меню Меню приложения (1) - Управление лицензиями (2)
В поле Номер лицензии (3) введите присвоенный вам при покупке серийный номер программы.
Нажмите кнопку Сгенерировать ключ запроса (4).
Скопируйте и пришлите на адрес электронной почты support@cs-consult.ru содержимое поля Ключ запроса лицензии (5) с указанием вашей организации и серийного номера.
После получения лицензионного ключа внесите его содержимое в поле Лицензионный ключ (6) и нажмите кнопку Активировать ключ (7).
Выполнение данной операции потребуется:
при первичном вводе лицензии;
при переносе БД программы на другой сервер;
после выполнения обновления программы с изменением первго или второго знака номера версии. Например, при переходе с 1.4.4 на 1.5.0 или с 1.5.0 на 1.6.0. Но при обновлении с 1.5.2 на 1.5.3 выполнять этого не требуется.
Резервное копирование и восстановление информации
Для обеспечения целостности и сохранности данных необходимо периодически производить резервное копирование.
Резервное копирование БД Ведок осуществляется штатными средствами установленной у вас СУБД. Прикрепленные файлы находятся в каталоге /app_home/vedoc_core/work, который тоже должен копироваться.
Настройки подключения находятся в файлах /tomcat/webapps/vedoc/WEB-INFO/local.app.properties и vedoc/tomcat/conf/server.xml которые так же должны копироваться для упрощения восстановления в случае сбоя
Данные для обращения в техническую поддержку
По вопросам технической поддержки обращаться на адрес электронной почты: support@cs-consult.ru
При возникновении ошибок при запуске или в работе программы к заявке прикладывайте логи запуска и работы программы, находящиеся в каталогах:
Каталог_программы /tomcat/logs файл catalina.log
и
Каталог_программы /app_home/logs файл app.log