.. _Установка:

======================
Установка
======================

Установка сервера отчетов
-----------------------------

Рассмотрим установку сервера отчетов на примере ОС Debian.

Все команды следует выполнять с правами суперпользователя (root).

1. Создаем каталог для дистрибутива PGHS

    ::

        mkdir /root/xsquare

    переходим в каталог

    ::

        cd /root/xsquare

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

    ::

        wget https://lcdp.xsquare.ru/files/xreports/rpm_dep/6.0.0.3/deb/xsquare.xreports_6.0.0.3.deb


3. Устанавливаем xreports

    ::

        dpkg -i xsquare.xreports_6.0.0.3.deb


4. Проверяем состояние сервера отчетов

    ::

        curl http://localhost:8886/status


Установка шрифтов для RPM-based ОС
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

::
	
	dnf install msttcore-fonts-installer
	fc-cache –fv


Установка Libre Office
~~~~~~~~~~~~~~~~~~~~~~~~~~
Для конвертации документов DOCX/XLSX в PDF необходимо установить компоненты Libre Office.

.. note:: Если конвертация DOCX/XLSX в PDF не требуется, то установку Libre Office можно пропустить.

1. Скачиваем дистрибутив Libre Office

    ::

       wget https://lcdp.xsquare.ru/files/libreoffice/LibreOffice_24.8.4_Linux_x86-64_deb.tar.gz

2. Устанавливаем Libre Office

    ::

        apt -y install libxinerama1 libcairo2 libcups2 default-jre
        tar -xvzf LibreOffice_24.8.4_Linux_x86-64_deb.tar.gz
        dpkg -i ./LibreOffice_24.8.4.2_Linux_x86-64_deb/DEBS/*.deb

Файл конфигурации config.json
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Для работы сервера отчетов необходимо, чтобы в директории с сервисом присутствовал файл конфигурации config.json.
Файл конфигурации содержит 3 раздела:

1. Описатель App, где можно определить базовые настройки сервиса:

    ::

        {
          "app":
          {
            "port": "8886",
            "debug": false,
            "data-directory": "",
            "save-file-directory": "/tmp/xreports",
            "save-file-path-mask": "%DOMAIN%/%YYYY%/%MM%/%DD%/%HH%/%GUID%/%FILENAME%"
          }
        }

* **port** - строка. Определяет номер сетевого порта, на котором будет запущен сервис (по умолчанию - 8886)
* **debug** - логическое значение. Включает режим отладки, при котором доступен подробный лог обработки запросов, а также происходит сохранение всех запросов и готовых документов в локальной директории **reports_debug** сервиса (аналогично действию флага :ref:`enable-debug-report-save <enable_debug_report_save>` в свойствах запроса). Значение по умолчанию - **false**.
* **data-directory** - строка. Определяет абсолютный путь к каталогу с данными сервера отчета (assets, templates, reports_debug)
* **save-file-directory** - строка. Определяет абсолютный путь к каталогу для сохранения отчетов когда, сервер отчетов работает в режиме файлового сервера и возвращает ссылки на готовые отчеты
* **save-file-path-mask** строка. Определяет файловую маску для сохранения готовых отчетов. Маска поддерживает шаблонизированные параметры, которые можно использовать при составлении пути

     * %DOMAIN% - домен, задается в опциях запроса
     * %YYYY% - текущий год
     * %MM% - текущий месяц
     * %DD% - текущий день
     * %HH% - текущий час
     * %GUID% - случайный идентификатор
     * %FILENAME% - имя файла

2. Описатель formatConversion, где определяются настройки для приложения soffice из пакета Libre Office :

    ::

        "formatConversion":
        {
          "format-conversion-dir": "",
          "soffice-max-process-count": 0,
          "soffice-path": ""
        }


* **format-conversion-dir** - строка. Определяет директорию для хранения временных файлов (по умолчанию - "/tmp")
* **soffice-max-process-count** - число. Определяет количество ядер процессора, которое может использовать soffice для конвертации ( по умолчанию - "0", использовать все доступные ядра)
* **soffice-path** - строка. Определяет путь до исполняемого файла soffice (по умолчанию - путь, записанный в переменные окружения при установке Libre Office)

Если после установки Libre Office запуск soffice не доступен по имени - необходимо прописать полный путь в параметр  "soffice-path".

Например:

.. code-block:: json
    :emphasize-lines: 5

      "formatConversion":
      {
        "format-conversion-dir": "",
        "soffice-max-process-count": 0,
        "soffice-path": "/opt/libreoffice24.8/program/soffice"
      }

Для применения новых параметров конфигурации необходимо перезапустить сервер отчетов:

::

    systemctl restart xsquare.xreports.service