Загрузка...

Инструкции по установке и обновлению Doc-v 2

Автор Сообщение
Андрей (Documentov)
22.12.2021 16:02:15

Документация переехала на новый сайт , где будет обновляться и дополняться.

Загрузка и установка

Теперь вы можете загрузить новую бета-версию Дóкви и установить ее на свой собственный сервер.

Первым делом - предупреждение:

система находится в нестабильном состоянии и не рекомендуется для использования в промышленной эксплуатации. Она содержит ошибки и недоработки. Не доверяйте ей серьезные дела до финального релиза, который планируется пока на март 2022 года .


Система доступна для двух операционных систем:

Linux x64

Windows x64


Настройка базы данных

Для работы системы необходима установленная СУБД MySQL / MariaDB. Если у вас уже установлена эта СУБД, есть выделенный пользователь и база данных, переходите сразу к установке.

Если СУБД установлена и есть пользователь, обладающий привилегией создания новой базы данных, этот шаг также можно пропустить, т.к. установщик Doc-v сможет сам создать базу данных.

Если нет, то сначала установите СУБД. Для Linux достаточно выполнить команду sudo apt install mysql-server , для Windows загрузить инсталлятор и запустив установочный файл.

Создание пользователя и базы данных MySQL может выполняться разными способами, и вы можете использовать любой из них; ниже приводится вариант с использованием командной строки.

Запустите командную строку MySQL

Для Linux:

sudo mysql

Для Windows:

mysql.exe

Если вы получите ошибку о том, что Windows не может найти исполняемый файл mysql.exe добавьте в системную переменную операционной системы PATH полный путь к исполняемым файлам MySQL (каталог bin).

В зависимости от настроек, вы можете получить ошибку аутентификации. В этом случае запустите команду с параметрами:

mysql -uПОЛЬЗОВАТЕЛЬ -p

Успешно открыв командную строку MySQL, вы сможете выполнить нижеприведенные SQL-запросы для создания пользователя и базы данных.

Если у вас еще нет пользователя базы данных для работы Doc-v, создайте его (имя может быть любым, в дальнейших примерах используется doc-v):

CREATE USER 'doc-v'@'localhost' IDENTIFIED BY 'ВАШ_ПАРОЛЬ';

для MySQL8:   ALTER USER 'doc-v'@'localhost' IDENTIFIED WITH mysql_native_password BY ' ВАШ_ПАРОЛЬ ';

После чего можно создать базу данных следующими запросами:
CREATE DATABASE docv CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

GRANT ALL PRIVILEGES ON docv . * TO 'doc-v'@'localhost';

FLUSH PRIVILEGES;

quit;

База данных готова и можно приступить непосредственно к установке Дóкви.


Установка

Есть два варианта:

1. Обновление существующей системы.

2. Установка новой "чистой" системы.


Начало у обоих вариантов одинаковое - создаем каталог для системы и устанавливаем права.


LINUX

Во второй команде замените USERNAME на имя своего пользователя. Не стоит использовать пользователя root.

sudo mkdir -p /opt/doc-v

sudo chown USERNAME /opt/doc-v

cd /opt/doc-v

su USERNAME

Копируем дистрибутив системы в /opt/doc-v вручную или при помощи команды:

wget https://www.doc-v.com/download/doc-v.linux.tar.gz


И распаковываем:

tar xzvf doc-v.linux.tar.gz


WINDOWS  

Загрузите дистрибутив для Windows по адресу

https://www.doc-v.com/download/doc-v.windows.tar.gz

и скопируйте его в созданный на свое усмотрение новый каталог своего сервера. 


Запустите командую строку, перейдите в созданный каталог и выполните команду:

tar xf doc-v.windows.tar.gz


УСТАНОВКА НОВОЙ СИСТЕМЫ

Запускаем установку командой:

Linux: 

/opt/doc-v/doc-v

Windows:

/каталог_системы/doc-v.exe:

В процессе установки необходимо будет ввести:

  Адрес сервера MySQL (по умолчанию, 127.0.0.1): если MySQL на том же сервере просто нажимаем Enter

  Номер порта сервера MySQL (по умолчанию, 3306): если порт не изменяли, нажимаем Enter

  Название базы данных MySQL: docv

  Имя пользователя MySQL: doc-v

  Пароль пользователя MySQL: ВАШ_ПАРОЛЬ


  Имя пользователя Doc-v (рекомендуется e-mail)

  Пароль пользователя Doc-v не менее 8 символов


Будет автоматически создан конфигурационный файл, и Дóкви запустится. Но он будет привязан к консоли, поэтому, как только вы ее закроете, Дóкви остановится. Поэтому перезапустите его в режиме демона:

Ctrl+C  для остановки и

/opt/doc-v/doc-v start

(doc-v.exe start для Windows)

В консоли никаких сообщений больше не будет, вся информация в логах в каталоге /opt/doc-v/log



ОБНОВЛЕНИЕ СУЩЕСТВУЮЩЕЙ СИСТЕМЫ

В первую очередь необходимо создать копию существующей базы. Вы можете сделать это любым удобным для себя способом либо тем, что описан ниже:

Создаем новую базу данных:

sudo mysql

CREATE DATABASE docv CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

GRANT ALL PRIVILEGES ON docv . * TO 'ВАШ_ПОЛЬЗОВАТЕЛЬ'@'localhost';

FLUSH PRIVILEGES;

quit;

Импортируем данные в новую базу:

mysqldump -u ВАШ_ПОЛЬЗОВАТЕЛЬ -p БАЗА_ПЕРВОЙ_ВЕРСИИ > db.sql

mysql -u ВАШ_ПОЛЬЗОВАТЕЛЬ -p docv < db.sql


Копируем файловое хранилище из существующей версии:

cp -Rf /путь_к_первой_версии/system/storage/download /opt/doc-v/storage/

chown -R USERNAME /opt/doc-v/storage

где USERNAME - имя вашего пользователя для запуска Doc-v


И создаем конфигурационный файл /opt/doc-v/doc-v.conf со следующим содержимым:

[Network]
Hostname = documentov.com # для формирования URL-адресов
Port = 8080
HTTPS = false #true для включения HTTPS
SSLCertFile = ssl/www_documentov_com.crt #файл сертификата
SSLKeyFile = ssl/private.key #файл приватного ключа
SSLChainFile = ssl/www_documentov_com.ca-bundle #файл цепочек центра сертификации

[File]
MaxFileSize = 32M

[DB]
Hostname = 127.0.0.1
Name = название базы
User = пользователь
Password = пароль

После запуска системы в лог-файле log/info.log (в Linux можно ввести команду tail -f /opt/doc-v/log/info.log, чтобы наблюдать за изменением этого файла) вы увидите сообщения об обновлении. После завершения обновления сервер будет запущен, но еще некоторое время будут создаваться таблицы для просмотра журналов (информация об этом также будет выводится в файл log/info.log). В зависимости от количества документов в журналах это время может быть продолжительным, а работа с системой будет затруднена, поэтому дождитесь окончания операции и не останавливайте сервер.


Автозагрузка


После перезагрузки сервера Дóкви самостоятельно не запустится. Исправить это упущение пока можно так:

LINUX  

/opt/doc-v/doc-v stop
sudo cp /opt/doc-v/data/doc-v.service /etc/systemd/system/

Изменяем файл /etc/systemd/system/doc-v.service :

  User=ВАШ_ПОЛЬЗОВАТЕЛЬ

Выполняем команды:

sudo systemctl enable doc-v  
sudo systemctl start doc-v
systemctl status doc-v
    Получаем похожее сообщение:
    doc-v.service - Doc-v
    Loaded: loaded (/etc/systemd/system/doc-v.service; enabled; vendor preset: enabled)
    Active: active (running) since Wed 2021-12-15 11:45:12 +06; 39s ago
    .................
    
Впредь запуск системы осуществляется командой:
sudo systemctl start doc-v

а остановку:
sudo systemctl stop doc-v

WINDOWS     

Загрузите файл https://nssm.cc/release/nssm-2.24.zip и распакуйте его.

Запустите консоль от имени администратора, перейдите в каталог nssm-2.24\win64 и выполните команду

nssm.exe install Doc-v путь_к_Doc-v\doc-v.exe


Андрей (Documentov)
22.12.2021 16:07:29

Лицензионный ключ

Пока в системе менее 5 000 документов доступны все имеющиеся на текущий момент модули. Когда количество документов превысит 5 000 документов платные модули перестанут отображать информацию, но большинство из них продолжит свою работ. Покупая модуль, вы получите файл license.key, который необходимо будет скопировать в корневой каталог системы и перезагрузить ее, после чего приобретенные модули возобновят свою работу.

Если у вас уже есть приобретенные модули, и вы решили принять участие в бета-тестировании, нажмите, пожалуйста, здесь для получения лицензионного ключа. Ключ вы получите в любом случае, даже если не нажмете, просто во втором случае это случится после выпуска финальной версии системы.


Андрей (Documentov)
22.12.2021 16:14:29

Тестирование

В системе есть ошибки. Если вы столкнетесь с ними, пишите в соответствующем разделе нашего форума.

Самое главное. 

До выпуска финальной версии обязательно проверьте как обновится ваша версия конфигурации на новую систему. Если будут трудности, сейчас мы, скорее всего, сможем исправить их. После выпуска финальной версии все исправления и дополнительные настройки вам придется делать самостоятельно вручную. 


Андрей (Documentov)
23.12.2021 18:36:43

Обновление

О выходе новых версий можно узнавать в этой теме . Если вы на нее подпишитесь (кнопка вверху на странице темы), то будете получать уведомления на почту.

Для обновления:

1. Скопируйте файл с дистрибутивом системы в каталог системы:

cd /opt/doc-v

wget https://www.doc-v.com/download/doc-v.linux.tar.gz 

2. Остановите сервер Doc-v

/opt/doc-v/doc-v stop

3. Распакуйте файлы архива в каталог с системой с заменой существующих файлов:

tar xzvf doc-v.linux.tar.gz 

4. Запустите сервер Докви:

/opt/doc-v/doc-v start

Обновление можно автоматизировать, создав bash-скрипт /opt/doc-v/update.sh со следующим содержимым:

#!/bin/sh
cd /opt/doc-v
wget --no-check-certificate https://www.doc-v.com/download/doc-v.linux.tar.gz 
rm -Rf ./view/*
tar xzvf doc-v.linux.tar.gz
/opt/doc-v/doc-v stop # запуск сервиса произойдет автоматически через systemd

Сделайте скрипт выполняемым: chmod +x /opt/doc-v/update.sh и можно запускать: /opt/doc-v/update.sh от имени своего (непривилегированного) пользователя (от имени которого работает Докви).

Обновления на Windows аналогично: скопируйте дистрибутив в каталог с системой, остановите сервер Doc-v (doc-v.exe stop или через службу, если вы настроили автозагрузку), распакуйте файлы каталог системы с заменой существующих файлов и запустите сервер Doc-v  (doc-v.exe start или через запуск службы)


Андрей (Documentov)
11.01.2022 10:52:04

Дополнительные приложения

Для работы некоторых функций необходимы следующие приложения, установленные на сервере:

  • unoconv для работы предварительного просмотра офисных форматов файлов в поле "Файл", в котором включен атрибут предварительного просмотра
  • wkhtmltopdf для экспорта в PDF в действии "Экспорт в файл"
  • onlyOffice для редактирования файлов в поле "Файл" в браузере (после установки в в настройках сервиса Doc-v OnlyOffice включить интеграцию и указать сервер: http://Ваш IP:90)

Установка unoconv / LibreOffice

Linux Ubuntu :

sudo apt install unoconv

Однако в состав Ubuntu включены устаревшие версии uniconv / LibreOffice, которые имеют программные ошибки, из-за которых для некоторых файлов может не работать предварительный просмотр. Ниже приводится инструкция по обновлению ( здесь более подробно):

1. Установка последней версии Unoconv

cd /opt

sudo wget https://raw.githubusercontent.com/dagwieers/unoconv/master/unoconv

Изменить в файле /opt/unoconv первую строку на:

#!/usr/bin/env python3

sudo chmod ugo+x /opt/unoconv

sudo mv /usr/bin/unoconv /usr/bin/unoconv2 // если не была установлен unoconv, команда выведет ошибку - это нормально
sudo ln -s /opt/unoconv /usr/bin/unoconv

2. Обновление до последней версии LibreOffice

sudo add-apt-repository ppa:libreoffice/ppa
sudo apt-get update
sudo apt-get install libreoffice

3. Проверка результатов

Выполните команду
unoconv --version

Результат должен быть похожим на следующие строки:
unoconv 0.8.2
Written by Dag Wieers <dag@wieers.com>
Homepage at http://dag.wieers.com/home-made/unoconv/

platform posix/linux
python 3.8.10 (default, Nov 26 2021, 20:14:08) 
[GCC 9.3.0]
LibreOffice 7.2.5.2

Windows :

1. Установить LibreOffice

2. Загрузить unoconv , распаковать zip архив, например, в  С:/unoconv

3. В папке Windows/System32 создать файл unoconv.cmd со строкой:

call "c:\Program Files\LibreOffice\program\python.exe" C:\unoconv\unoconv %*

Установка Wkhtmltopdf

Linux Ubuntu :

sudo apt install  wkhtmltopdf

Windows :

1. Загрузить и установить  дистрибутив

2. В системную переменную Windows Path добавить путь к wkhtmltopdf\bin

3. Перезагрузить сервер


Установка OnlyOffice

Linux Ubuntu

1. sudo  apt install - docker docker.io

2. sudo docker run -i -t -d -p 90:80 --restart=always onlyoffice/documentserver

3. В настройках сервиса Doc-v OnlyOffice включить интеграцию и указать сервер: http://Ваш_IP_или_доменное_имя:90 (IP не может быть 127.0.0.1)


При включенном HTTPS в Doc-v необходимо также настроить на HTTPS и OnlyOffice:

1. mkdir -p /app/onlyoffice/DocumentServer/data/certs

2. Скопируйте в созданный каталог /app/onlyoffice/DocumentServer/data/certs файлы SSL-сертификатов и дайте им названия: onlyoffice.crt  и onlyoffice.key 

3. Запустите контейнер: sudo docker run -i -t -d -p 8443:443 --restart=always -v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data  -v /app/onlyoffice/DocumentServer/logs:/var/log/onlyoffice onlyoffice/documentserver

4. В настройках сервиса Doc-v OnlyOffice укажите сервер: https://Ваш_IP_или_доменное_имя:8443

Если при открытии документа OnlyOffice будет выдавать ошибку о невозможности сохранения файла и необходимости проверки соединения, посмотрите лог файл  /app/onlyoffice/DocumentServer/logs/documentserver/docservice/out.log. Если в этом файле будет ошибка, похожая на "Error: unable to verify certificate", проблему можно решить перезапуском контейнера с переменной USE_UNAUTHORIZED_STORAGE:

sudo docker run -i -t -d -e USE_UNAUTHORIZED_STORAGE=true -p 8443:443 --restart=always -v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data  -v /app/onlyoffice/DocumentServer/logs:/var/log/onlyoffice onlyoffice/documentserver


Андрей (Documentov)
02.02.2022 15:32:13

Изменение порта


По умолчанию, Докви запускается на порте 8080. Если вы захотите изменить порт на значение ниже 1024 необходимо предоставить сначала доступ к этим портам непривилегированным пользователям. Отредактируйте (или создайте, если его нет) файл:
/etc/sysctl.d/50-unprivileged-ports.conf

добавив в него строку:
net.ipv4.ip_unprivileged_port_start=0

После чего можно изменить файл /opt/doc-v/doc-v.conf:

[Network]
Port = 80

После чего выполнить команду:
sudo sysctl --system

и перезагрузить Докви.

Включение HTTPS


Для включения HTTPS необходимо в файле doc-v.conf в секцию Network добавить след настройки:

[Network]
HTTPS = true
SSLCertFile = ssl/www.crt
SSLKeyFile = ssl/private.key
SSLChainFile = ssl/www.ca-bundle

Там же нужно изменить порт на 443 и перезагрузить Докви.

Если у вас нет сертификата SSL, его можно приобрести или зарегистрировать бесплатно, например, в центре сертификации Let’s Encrypt. Ниже приводится краткая инструкция по работе с Let’s Encrypt в Linux Ubuntu:
1. sudo apt install certbot
2. Если у вас работает на 80-м порту какой-либо веб-сервер, остановите его
3. certbot certonly --standalone
Ответьте на вопросы установщика (в DNS для доменного имение, для которого вы регистрируете сертификат, должен быть указан публичный IP-адрес сервера, с которого вы запускаете certbot)
4.  Установите права доступа к папкам /etc/letsencrypt/live, /etc/letsencrypt/archive и файлу приватного ключа в /etc/letsencrypt/archive/ВАШЕ ДОМЕННОЕ ИМЯ для пользователя, от имени которого запускается Doc-v, или скопируйте файлы из /etc/letsencrypt/archive/ВАШЕ ДОМЕННОЕ ИМЯ в, например, /opt/doc-v/ssl (в пятом пункте в этом случае подставьте этот путь для файлов SSL)
5. Исправьте файл doc-v.conf:
Port = 443
HTTPS = true
SSLCertFile = /etc/letsencrypt/live/ВАШЕ ДОМЕННОЕ ИМЯ/cert.pem
SSLKeyFile = /etc/letsencrypt/live/ВАШЕ ДОМЕННОЕ ИМЯ/privkey.pem
SSLChainFile = /etc/letsencrypt/live/ВАШЕ ДОМЕННОЕ ИМЯ/fullchain.pem

Обратите внимание, что сертификаты Let’s Encrypt действительны три месяца. Для продления сертификата необходимо будет выполнить команду:
sudo certbot renew --dry-run

Для автоматизации обновления сертификатов можно использовать следующий скрипт (он предполагает, что сертификаты будут копироваться в каталог /opt/doc-v/ssl, этот путь должен быть указан в doc-v.conf для настроек SSL):

#!/bin/sh
certbot renew --dry-run
cp /etc/letsencrypt/live/ВАШЕ ДОМЕННОЕ ИМЯ/* /opt/doc-v/ssl/
chown doc-v /opt/doc-v/ssl/*
systemctl restart doc-v

Если на 80-м порту у вас работает веб-сервер, добавьте команду для его остановки перед certbot renew --dry-run и запуска после нее, т.к. в приведенной конфигурации для certbot необходим свободный 80-й порт.

Настройте в cron запуск этого скрипта каждые три месяца во время наименьшей нагрузки от имени пользователя root.

После включения HTTPS в Doc-v необходимо будет включить HTTPS и для OnlyOffice, если вы используете этот сервис.


Андрей (Documentov)
19.04.2022 20:57:10

Документация переехала на новый сайт , где будет обновляться и дополняться.


Сообщений: 7