new release december 2019 (updated platform dependencies)

install_guide/install.rst

+Установка приложения
+----------------------
+
+Предварительные шаги
+~~~~~~~~~~~~~~~~~~~~~~
+
+#. Установить самую актуальную версию платформы Arta Synergy, 
+   не менее версии `4.1 minsky`_.
+
+#. Установить самую актуальную версию Конструктора приложений, 
+   не менее версии `2.1`_.
+
+#. В подсистеме администрирования обновить базу данных и процессы.
+
+#. Завести Системного пользователя:
+
+   * с произвольными логином/паролем;
+   * с доступом в систему;
+   * с ролью "Разработчик Synergy", "Разработчик web-клиента" и 
+     "Администратор";
+   * назначенный на произвольную должность.
+
+.. _`4.1 minsky`: http://tdd.lan.arta.kz/docs/synergy/tags/minsky/admin-manual/html/install-and-setup.html#install-and-setup.install
+
+.. _`2.1`: https://docs.google.com/document/d/13XuzlP46CQ7KpnCe5_RCAk6SaO9XoiMhn9pYj1PEgvU/edit?usp=sharing
+
+Процесс установки
+~~~~~~~~~~~~~~~~~~~
+
+Synergy Customers устанавливается отдельным пакетом. Возможны следующие 
+варианты установки:
+
+#. ``Install/Upgrade Configuration`` - установка приложений Customers и 
+   импорта, загрузка конфигураций (Synergy и конструктора), без БД и 
+   хранилища. Соответственно, имеющиеся в Системе данные не удаляются.
+
+#. ``Manual`` - установка только приложения для импорта. 
+
+Установочный пакет находится в репозитории *customers-2.0*. В файле 
+``/etc/apt/sources.list`` необходимо добавить либо раскомментировать 
+следующую строку:
+
+    .. code-block:: html 
+
+	deb http://deb.arta.kz/tengri customers-2.0 main contrib non-free
+
+Для установки приложения необходимо выполнить команду:
+
+    .. code-block:: html 
+
+	# apt-get update
+	# apt-get install arta-synergy-apps-customers
+
+В ходе установки необходимо выполнить следующее:
+
+* Выбрать тип установки ``Install/Upgrade Configuration`` из предложенного 
+  списка:
+
+    .. figure:: resources/img/customers_install.png
+
+        Рис. Тип установки
+
+* Указать URL до Synergy, на котором производится работа (например: 
+  http://192.168.4.80:8080/Synergy):
+
+    .. figure:: resources/img/customers_1.png
+
+        Рис. Ввод synergy URL
+
+* Ввести последовательно логин и пароль Системного пользователя:
+
+    .. figure:: resources/img/customers_2.png
+
+        Рис. Ввод логина
+
+    .. figure:: resources/img/customers_3.png
+
+        Рис. Ввод пароля
+
+После установки
+~~~~~~~~~~~~~~~~~
+
+Во-первых, в подсистеме конфигурирования необходимо добавить Системного 
+пользователя в группу "Все права" (с кодом ``customers_groups_access_all``).
+
+Во-вторых, там же в подсистеме конфигурирования необходимо прописать 
+логин и пароль Системного пользователя в следующих блокирующих процессах:
+
+* ``event.blocking.interpreter.changeDealStage``
+* ``event.blocking.interpreter.createActivity``
+* ``event.blocking.interpreter.createUserPlansForSales``
+* ``event.blocking.interpreter.getEndDealStatus``
+
+В-третьих, необходимо проверить доступность приложения Customers по 
+адресу ``http://адрес_сервера:порт/customers`` (например: 
+http://192.168.4.80:8080/customers).
+
+Ожидаемое поведение:
+
+1. Откроется страница авторизации.
+2. Авторизация Системным пользователем произойдет успешно.
+3. Откроется главная страница модуля (с поиском и кнопками создания).
+4. При выполнении произвольного запроса в поиске приложение отвечает не 
+   ошибкой сервера, а отсутствием данных.
+
+Если фактическое поведение отличается от ожидаемого, то необходимо:
+
+* в подсистеме администрирования проверить актуальность базы данных и 
+  процессов и, при необходимости, их обновить;
+
+* проверить конфигурационный файл ``/etc/nginx/sites-enabled/synergy-base`` 
+  на наличие следующих настроек:
+
+    .. code-block:: xml 
+
+        location /constructor {
+               allow                   all;
+               proxy_pass              http://127.0.0.1:8080;
+               proxy_set_header        Host       $host;
+               proxy_set_header        X-Real-IP  $remote_addr;
+               }
+
+        location /customers {
+               proxy_pass http://127.0.0.1:8080/customers;
+               }
+
+        location /import {
+               allow                   all;
+               proxy_pass              http://127.0.0.1:8080/import;
+               proxy_set_header        Host       $host;
+               proxy_set_header        X-Real-IP  $remote_addr;
+               }
+
+* открыть Конструктор приложений по адресу ``http://адрес_сервера:порт/constructor`` 
+  (например: http://192.168.4.80:8080/constructor), авторизоваться под Системным 
+  пользователем, открыть приложение с кодом ``customers`` и задеплоить его через 
+  меню "Клиент" -> "Деплой".
+

install_guide/update.rst

+Обновление приложения
+-----------------------
+
+Предварительные шаги
+~~~~~~~~~~~~~~~~~~~~~~
+
+#. Установить самую актуальную версию платформы Arta Synergy, 
+   не менее версии `4.1 minsky`_.
+
+#. Установить самую актуальную версию Конструктора приложений, 
+   не менее версии `2.1`_.
+
+#. В подсистеме администрирования обновить базу данных и процессы.
+
+#. Завести Системного пользователя:
+
+   * с произвольными логином/паролем;
+   * с доступом в систему;
+   * с ролью "Разработчик Synergy", "Разработчик web-клиента" и 
+     "Администратор";
+   * назначенный на произвольную должность.
+
+.. _`4.1 minsky`: http://tdd.lan.arta.kz/docs/synergy/tags/minsky/admin-manual/html/install-and-setup.html#install-and-setup.install
+
+.. _`2.1`: https://docs.google.com/document/d/13XuzlP46CQ7KpnCe5_RCAk6SaO9XoiMhn9pYj1PEgvU/edit?usp=sharing
+
+Процесс обновления
+~~~~~~~~~~~~~~~~~~~~
+
+Synergy Customers обновляется из пакета. Все действия аналогичны процессу 
+установки, используйте вариант установки ``Install/Upgrade Configuration``:
+
+#. ``Install/Upgrade Configuration`` - установка приложений Customers и 
+   импорта, загрузка конфигураций (Synergy и конструктора), без БД и 
+   хранилища. Соответственно, имеющиеся в Системе данные не удаляются.
+
+#. ``Manual`` - установка только приложения для импорта. 
+
+Установочный пакет находится в репозитории *customers-2.0*. В файле 
+``/etc/apt/sources.list`` необходимо добавить либо раскомментировать 
+следующую строку:
+
+    .. code-block:: html 
+
+	deb http://deb.arta.kz/tengri customers-2.0 main contrib non-free
+
+Для установки приложения необходимо выполнить команду:
+
+    .. code-block:: html 
+
+	# apt-get update
+	# apt-get install arta-synergy-apps-customers
+
+В ходе установки необходимо выполнить следующее:
+
+* Выбрать тип установки ``Install/Upgrade Configuration`` из предложенного 
+  списка:
+
+    .. figure:: resources/img/customers_install.png
+
+        Рис. Тип установки
+
+* Указать URL до Synergy, на котором производится работа (например: 
+  http://192.168.4.80:8080/Synergy):
+
+    .. figure:: resources/img/customers_1.png
+
+        Рис. Ввод synergy URL
+
+* Ввести последовательно логин и пароль Системного пользователя:
+
+    .. figure:: resources/img/customers_2.png
+
+        Рис. Ввод логина
+
+    .. figure:: resources/img/customers_3.png
+
+        Рис. Ввод пароля
+
+.. attention:: В случае, если платформа Arta Synergy была обновлена с версии 
+               **4.0 hamming** до **4.1 minsky**, требуется переустановка 
+               приложения для импорта. 
+
+Для этого необходимо переустановить пакет Customers командой:
+
+    .. code-block:: html 
+
+	# aptitude reinstall arta-synergy-apps-customers
+
+И в ходе обновления необходимо выбрать тип установки ``Manual`` из 
+предложенного списка:
+
+    .. figure:: resources/img/customers_manual.png
+
+        Рис. Тип установки
+
+После обновления
+~~~~~~~~~~~~~~~~~~
+
+Из-за особенностей загрузки конфигурации в Конструкторе приложений после 
+обновления будет 2 приложения: старое и новое. При этом по умолчанию активным 
+будет именно старое приложение. Поэтому все действия сводятся к следующим шагам:
+
+1. В старом приложении освободить дефолтные код и URL.
+
+2. В новом приложении настроить дефолтные код и URL.
+
+3. Передеплоить приложение со стороны сервера.
+
+Во-первых, настроить обновленное приложение в Конструкторе:
+
+* Открыть Конструктор приложений по адресу ``http://адрес_сервера:порт/constructor`` 
+  (например: http://192.168.4.80:8080/constructor) и авторизоваться под Системным 
+  пользователем.
+
+* Открыть старое приложение с кодом и URL ``customers`` и выполнить следующие 
+  действия в нем:
+
+    * выбрать меню "Клиент" -> "Свойства";
+    * изменить название на любое значение, отличное от исходного (для примера 
+      подойдет ``Customers Old 1``);
+    * изменить код и URL на любое значение, отличное от исходного ``customers`` 
+      (для примера подойдет ``customers1``);
+    * сохранить изменения.
+
+* Открыть новое приложение с названием ``Customers 2.0_IMPORTED`` и выполнить 
+  следующие действия в нем:
+
+    * выбрать меню "Клиент" -> "Свойства";
+    * изменить название на любое значение, отличное от исходного 
+      ``Customers 2.0_IMPORTED`` (для примера подойдет название по умолчанию 
+      ``Customers 2.0``);
+    * изменить код и URL строго на значение ``customers``;
+    * сохранить изменения;
+    * выбрать меню "Клиент" -> "Деплой".
+
+Во-вторых, передеплоить приложение со стороны сервера:
+
+* Перейти в папку ``deployments``:
+
+    .. code-block:: html 
+
+	# cd /opt/synergy/jboss/standalone/deployments
+
+* Выполнить команду:
+
+    .. code-block:: html 
+
+	# touch customers.war.dodeploy
+
+Готово, можно проверять.