Настройки

Настройка Дóкви осуществляется через соответствующий пункт панели администратора и конфигурационный файл doc-v.conf, расположенный в корневом каталоге системы.

Настройки в административной панели

Настройки доступны только администратору системы.

Доступны следующие настройки:

  • Пользователь.
    • Стартовая страница — страница, которая открывается после входа пользователя в систему. В качестве стартовой страницы для пользователей может выступать документ, идентификатор которого находится в выбранном в данном параметре поле. Настройка не действует для администраторов - для них всегда отображается стартовая страница администратора
    • Тип аутентификации. Доступны встроенная в систему аутентификация и аутентификация через Active Directory.
      • Встроенная аутентификация имеет следующие настройки:
        • Срок действия пароля пользователя. Можно указать период (в днях) смены пароля пользователем. По истечении этого периода пользователь будет обязан изменить пароль. Если установить 0, ограничения на срок действия пароля не будет.
        • Максимальное количество ошибок аутентификации, которое пользователь может допустить при вводе пары логин / пароль. При превышении заданного количества пользователь блокируется. Разблокировать пользователя можно через справочник «Учетные записи». Если в данной настройке установлено значение, равное нулю, количество попыток аутентификации не ограничено. Кстати, установка пароля пользователя осуществляется через справочник «Учетные записи» в поле типа «Пароль». В настройках этого поля есть параметр «Уровень сложности». В типовой конфигурации установлен средний уровень, открыв упомянутое поле можно изменить сложность.
      • Active Directory. Включив этот вид аутентификации не выходите из До́кви, пока не убедитесь, что все работает нормально, и вы имеете возможность войти в систему от имени учетной записи с административными привилегиями, чтобы не потерять возможность переключения аутентификации на встроенную. Для настройки аутентификации в Active Directory по протоколу Kerberos необходимо:
        • Cоздать keytab-файл с названием doc-v.keytab и разместить его в каталоге data (например, /opt/doc-v/data/doc-v.keytab).
          1. Создать в Active Directory учетную записью компьютера для сервера Дóкви (например, Дóкви) через оснастку «Пользователи и компьютеры».
          2. Запустить в командной консоли на контроллере домена (от имени учетной записи администратора домена, обладающей всеми привилегиями):
          ktpass -princ HTTPS/doc-v.com@DOMAIN.MAIN -mapuser doc-v$@DOMAIN.MAIN -crypto ALL -ptype KRB5_NT_SRV_HST +rndpass -out C:\doc-v.keytab где
          -princ HTTPS/doc-v.com - SPN-имя вашего сервера Дóкви, состоящее из названия протокола (HTTP(s)) и доменного имени;
          -mapuser doc-v$@DOMAIN.MAIN - учетная запись Active Directory типа «Компьютер» для сервера Дóкви;
          DOMAIN.MAIN - название вашего домена Active Directory, в большинстве случаев, заглавными буквами;
          -crypto ALL — включить поддержку всех типов шифрования;
          -ptype KRB5_NT_SRV_HST — тип принципала хоста;
          +rndpass — сгенерировать случайный пароль для учетной записи;
          -out C:\doc-v.keytab — название keytab-файла и полный путь к нему.

          Полученный ключ C:\doc-v.keytab следует скопировать на сервер Дóкви в каталог storage (убедитесь, что пользователь, от имени которого запускается Дóкви, будет иметь к этому файлу права доступа).
        • Установить соответствующие настройки в административной панели Дóкви (Настройки / Пользователи).
        • Создать для каждого пользователя учетную запись (справочник «Учетные записи») с логином, соответствующем его UPN в каталоге Active Directory (вручную или через сервис Active Directory).
        • Для SSO-аутентификации (без ввода логина и пароля, если устройство находится в домене, и пользователь уже прошел аутентификацию в Active Directory) необходимо настроить браузер пользователя.
          В Google Chrome добавить в ярлык запуска параметр --auth-server-whitelist=доменное-имя-вашего-сервера-DOC-V В Mozilla Firefox ввести about:config и установить параметры: network.negotiate-auth.trusted-uris доменное-имя-вашего-сервера-DOC-V
          network.automatic-ntlm-auth.trusted-uris true
  • Время. В этой секции доступна одна настройка:
    • Часовой пояс, который необходимо выбрать из выпадающего списка.
  • Электронная почта. Для отправки почтовых сообщений Дóкви использует почтовый ящик, определяемый в следующих настройках:
    • Системный почтовый адрес, например, doc-v@gmail.com.
    • Адрес SMTP-сервера, например, smtp.gmail.com.
    • Порт SMTP-сервера, обычно 465.
    • Имя пользователя, например, doc-v@gmail.com.
    • Пароль пользователя. Обратите внимание, что многие популярные почтовые сервисы требуют установки отдельного пароля приложений. Инструкции доступны по ссылкам: Gmail, Yandex, Mail.ru.
  • Приложения.
    • Просмотр офисных файлов. Для работы предварительного просмотра поля «Файл» необходимо установить приложение Unoconv, после чего включить эту настройку.
    • Таймаут на формирование файла предварительного просмотра в секундах. Если в течение отведенного времени приложение Unoconv не сможет сформировать файл предварительного просмотра, процесс будет прерван и повторен позже.
  • Сообщения. Администратор имеет возможность отправить пользователям сообщение (например, о планируемом техническом перерыве в работе системы), которое будет отображаться в верхней части окна системы.

Конфигурационный файл

В корневом каталоге системы находится файл doc-v.conf, в котором могут определяться описываемые далее настройки. После внесения изменений в этот файл, необходимо выполнить команду:

doc-v reload Изменение ключей секций [DB] и [Network] требует полную перезагрузку Дóкви:
doc-v restart

Файл разделен на несколько секций, название которых заключено в []. Файл может не содержать все описываемые далее ключи, Дóкви в таких случаях использует значения по умолчанию.

Секция [General]

  • Language. Язык, используемый в системе по умолчанию. Значение по умолчанию: ru
  • Debug. Возможные значения: true, false. Включает / отключает режим отладки. В режиме отладки Дóкви ведет записи в файл log/debug.log.
  • FirstDayOfWeek. Возможные значения: от 0 до 6. Первый день недели. По умолчанию, 1 (понедельник).
  • MaxRouteContextCalls. Максимальное количество вызовов точек маршрутов в рамках одной сессии. Используется для защиты системы от зацикливания вследствие ошибок конфигурации. По умолчанию, 1024.
  • WarnRouteContextCalls. Количество вызовов точек маршрута, при превышении которого записывается предупреждение в файл info.log. Используется для выявления неоптимальной конфигурации. По умолчанию, 10.
  • LocaleDate. Формат даты, по умолчанию, 02.01.2006.
  • LocaleDateTime. Формат даты со временем, по умолчанию, 02.01.2006 15:04:05
  • FloatDecimals. Возможные значения: от 0 до 4. Количество знаков после запятой для форматирования вещественных чисел. По умолчанию, 2.
  • FloatDecPoint. Разделитесь целой и дробной частей вещественных чисел. По умолчанию, запятая.
  • FloatThousandsSep. Разделитель тысячных разрядов чисел. По умолчанию, пробел.
  • TokenTTL. Время «жизни» пользовательского токена. По истечению этого времени, пользователь должен будет заново ввести логин/пароль. Вводится в секундах. По умолчанию, 1 год.
  • OnlineUserTTL. Количество секунд с момента последней действия пользователя в системе в течение которых пользователь считается активным. Используется для подсчета активных пользователей на странице администратора. По умолчанию: 5 минут.
  • NoUpdateBackup. Возможные значения: true, false. Позволяет отключить (true) автоматическое резервное копирование при обновлении системы.
  • ImmutableDocumentUIDs. Идентификаторы документов (через запятую), которые не могут удалены из системы.
  • NoChangeSettings. Возможные значения: true, false. Позволяет отключить (true) изменение настроек системы.
  • NoFree. Возможные значения: true, false. Позволяет отключить (true) бесплатные 5 000 документов, то есть будут доступны только купленные модули. Значение по умолчанию: false.

Секция [Network]

  • Hostname. Адрес хоста системы. Например, doc-v.com. Используется для формирования гиперссылок, например, при отправке почтовых сообщений.
  • Port. Номер порта, на котором работает Дóкви.
  • HTTPS. Возможные значения: true, false. Позволяет включить (true) HTTPS. Помимо изменения данной настройки, необходимо подготовить SSL-сертификат (например, настройку Let’s Encrypt) и установить следующие три ключа:
  • SSLCertFile. Путь к файлу SSL-сертификата. Например, /opt/doc-v/ssl/cert.pem или просто ssl/cert.pem.
  • SSLKeyFile. Путь к файлу приватного ключа. Например, /opt/doc-v/ssl/privkey.pem
  • SSLChainFile. Путь к цепочке центров сертификации SSL-сертификата. Например, /opt/doc-v/ssl/fullchain.pem
  • Interface. Сетевой интерфейс (IP-адрес) , на котором будет работать Дóкви. По умолчанию ключ пустой, и Дóкви «слушает» все интерфейсы.
  • Timeout. Таймаут не выполнение пользовательского запроса в секундах. Значение по умолчанию: 120 секунд.
  • EDSCheckerAddress. Сетевой адрес для RPC-сервера проверки ЭЦП (для Казахстана). По умолчанию, 127.0.0.1
  • EDSCheckerPort. Сетевой порт для RPC-сервера проверки ЭЦП (для Казахстана). По умолчанию, 22072

Секция [Файл]

  • Backup. Путь к папке с резервными копиями Дóкви, создаваемыми действием «Резервное копирование» сервиса «Планировщик задач». По умолчанию, storage/backup.
  • Log. Путь к папке для хранение лог-файлов. По умолчанию, log в корневой директории Дóкви.
  • FileStorage. Путь к папке файлового хранилища. По умолчанию, storage/files в корневой директории Дóкви.
  • FileStoragePreview. Путь к папке файлов предварительного просмотра поля «Файл». По умолчанию, storage/fpreview в корневой директории Дóкви.
  • DocumentLogDir. Путь к папке файлов хода работы документов. По умолчанию, storage/doclogs в корневой директории Дóкви.
  • EmailStorage. Путь к папке временного хранения отправляемых файлов действия «Электропочта». По умолчанию, storage/templ/email в корневой директории Дóкви.
  • ExportfStorage. Путь к папке временного хранения отправляемых файлов действия «Экспорт в файл». По умолчанию, storage/templ/exportf в корневой директории Дóкви.
  • Temp. Путь к временной папке для служебных нужд. По умолчанию, temp в корневой директории Дóкви.
  • AllowedCopyDirs. Список разрешенных каталогов (через запятую) для копирования файлов из файловой системы в Дóкви.
  • MaxFileSize. Максимальный размер загружаемого файла по умолчанию (в поле «Файл» можно переопределить эту настройку). По умолчанию, размер неограничен.
  • MySQLPath. Путь к исполняемым файлам MySQL / MariaDB. Допускается использование переменной DOC-V_WORKING_DIR, которая заменяется на корневой каталог Дóкви. По умолчанию настройка не используется, применяются системные переменные.
  • LogSizeRotation. Максимальный размер лог-файлов для ротации (сжатия). По умолчанию, 50 МБ, после превышения этого размера лог файл очищается, а существующие записи размещаются в новом zip-файле с датой создания в названия.

Секция [DB]

  • Hostname. Доменное имя или IP-адрес сервера базы данных.
  • Port. Порт сервера базы данных, по умолчанию, 3306.
  • User. Имя пользователя для подключения к серверу базы данных.
  • Password. Пароль пользователя для подключения к серверу базы данных.
  • Name. Название базы данных.
  • MaxOpenConns. Максимальное количество открытых соединений с базой данных. По умолчанию, 50. При большой нагрузке следует увеличить это значение, учитывая, что чрезмерное количество способствует неоправданному расходу ресурсов. Для определения оптимального значения можно включить режим отладки (ключ Debug = true в секции [General]) и мониторить файл debug.log, в который будут периодически записываться измерение нагрузки на базу данных в виде:
    Using DB-connections: N WaitCount: C, WaitDuration: D sec, где
    N — количество используемых соединений с базой данных в момент записи в лог-файл;
    C — общее количество (с момента загрузки сервера Дóкви) недостающих соединений с базой данных;
    D — время ожидания свободных соединений с базой данных в секундах.
  • MaxIdleConns. Максимальное количество простаивающих соединений с базой данных. По умолчанию, 50. Должно быть не меньше MaxOpenConns.