install_guide customers v2.0

install_guide/index.rst

@@ -3,109 +3,113 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Инструкция по установке приложения Arta Synergy Sales
+Инструкция по установке приложения Synergy Customers
 ==========================================================
 
 Общие сведения
 ---------------------
 
-Synergy Sales устанавливается отдельным пакетом. Возможны следующие варианты установки.
-
-1. ``Clean`` - полная установка приложения без демо-данных ("чистая" установка с загрузкой конфигурации и преднастроенных БД, хранилища, индексов Elasticsearch и Kibana, дашбордов).
-
-    .. hint:: Вариант установки ``Clean`` удаляет все текущие данные в системе!
-
-2. ``Install/Upgrade Configuration`` - установка приложения, загрузка его конфигурации, индексов и дашбордов (соответственно, без БД и хранилища).
-
-    .. hint:: Данный вариант установки отличается от других тем, что загружается конфигурация через Synergy API, не удаляя при этом информацию пользователя.
-
-3. ``Manual`` - установка только приложения без автоматической загрузки конфигурации, дашбордов и всего остального.
+Synergy Customers устанавливается отдельным пакетом. Единственный 
+возможный вариант установки - установка приложения, загрузка конфигураций 
+(Synergy и конструктора), без БД и хранилища. Соответственно, имеющиеся в 
+Системе данные не удаляются.
 
 Предварительные требования
 ------------------------------
 
 Важно! Для работы данного приложения требуется:
 
-* установить Arta Synergy 4.0 hamming (`инструкция по установке <http://tdd.lan.arta.kz/docs/synergy/tags/hamming/admin-manual/html/install-and-setup.html#install-and-setup.install>`_)
-* установить и запустить Elasticsearch и Kibana (`инструкция по установке <http://tdd.lan.arta.kz/docs/synergy/tags/hamming/admin-manual/html/appendix.dashboards.html>`_)
+* установить Arta Synergy 4.0 hamming актуальной версии 
+  (`инструкция по установке <http://tdd.lan.arta.kz/docs/synergy/tags/hamming/admin-manual/html/install-and-setup.html#install-and-setup.install>`_)
+* установить Конструктор приложений 2.0 актуальной версии 
+  (`инструкция по установке <https://docs.google.com/document/d/13XuzlP46CQ7KpnCe5_RCAk6SaO9XoiMhn9pYj1PEgvU/edit?usp=sharing>`_)
 * в подсистеме администрирования обновить базу данных и процессы
-* для варианта установки ``Install/Upgrade Configuration`` предварительно завести Системного пользователя (с произвольными логином/паролем, с доступом в систему, с ролью "Разработчик Synergy" и "Администратор", а также назначенного на произвольную должность)
+* предварительно завести Системного пользователя (с произвольными 
+  логином/паролем, с доступом в систему, с ролью "Разработчик Synergy", 
+  "Разработчик web-клиента" и "Администратор", а также назначенного 
+  на произвольную должность)
 
 Установка приложения
 --------------------------
 
-Установочный пакет находится в репозитории *unstable*. В файле ``/etc/apt/sources.list`` необходимо добавить либо раскомментировать следующую строку:
-
-``deb http://deb.arta.kz/tengri unstable main contrib non-free``
+Установочный пакет находится в репозитории *customers-2.0*. В файле 
+``/etc/apt/sources.list`` необходимо добавить либо раскомментировать 
+следующую строку:
 
-    .. note:: Для предотвращения дальнейшей нечаянной установки нестабильных версий пакетов из репозитория *unstable*, после установки ``arta-synergy-apps-sales`` рекомендуется его закомментировать в том же файле ``/etc/apt/sources.list``.
+``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-sales
+	# apt-get install arta-synergy-apps-customers
 
-Особенности установки Clean
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Особенности установки
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 В ходе установки необходимо выполнить следующее:
 
-* Выбрать тип установки из предложенного списка
-
-    .. figure:: resources/img/sales_clean_1.png
+* Указать URL до Synergy, на котором производится работа (например: 
+  http://192.168.4.80:8080/Synergy)
 
-        Рис. Тип установки
-
-* Указать URL до Synergy, на котором производится работа (например: http://192.168.2.164:8080/Synergy)
-
-    .. figure:: resources/img/sales_2.png
+    .. figure:: resources/img/customers_1.png
 
         Рис. Ввод synergy URL
 
-* Ввести пароль mysql
-
-    .. figure:: resources/img/sales_clean_3.png
-
-        Рис. Ввод пароля mysql
-
-    .. attention:: В случае, если после установки приложения вариантом ``Clean`` имеются проблемы с авторизацией пользователей (ошибка ``loginservlet``), то выполните в терминале команду ``dpkg-reconfigure arta-synergy-synergy`` и следуйте `мастеру установки <http://tdd.lan.arta.kz/docs/synergy/tags/hamming/admin-manual/html/install-and-setup.html#install-and-setup.install>`_.
-
-Особенности установки Install/Upgrade Configuration и Manual
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+* Ввести последовательно логин и пароль Системного пользователя
 
-В ходе установки необходимо выполнить следующее:
+    .. figure:: resources/img/customers_2.png
 
-* Выбрать тип установки из предложенного списка
+        Рис. Ввод логина
 
-    .. figure:: resources/img/sales_install_1.png
+    .. figure:: resources/img/customers_3.png
 
-        Рис. Тип установки
+        Рис. Ввод пароля
 
-* Указать URL до Synergy, на котором производится работа (например: http://192.168.2.164:8080/Synergy)
+    .. attention:: В случае, если после установки приложения вариантом ``Clean`` имеются проблемы с авторизацией пользователей (ошибка ``loginservlet``), то выполните в терминале команду ``dpkg-reconfigure arta-synergy-synergy`` и следуйте `мастеру установки <http://tdd.lan.arta.kz/docs/synergy/tags/hamming/admin-manual/html/install-and-setup.html#install-and-setup.install>`_.
 
-    .. figure:: resources/img/sales_2.png
+После установки
+-------------------
 
-        Рис. Ввод synergy URL
+Во-первых, необходимо добавить Системного пользователя в группу 
+"Все права" (с кодом `customers_groups_access_all`).
 
-* Ввести последовательно логин и пароль Системного пользователя
+Во-вторых, необходимо проверить доступность приложения по адресу 
+http://адрес_сервера:порт/customers (например: 
+http://192.168.4.80:8080/customers).
 
-    .. figure:: resources/img/sales_install_3.png
+Ожидаемое поведение:
 
-        Рис. Ввод логина
+1. Откроется страница авторизации.
+2. Авторизация Системным пользователем произойдет успешно.
+3. Откроется главная страница модуля (с поиском и кнопками создания).
+4. При выполнении произвольного запроса приложение отвечает не ошибкой 
+   сервера, а отсутствием данных.
 
-    .. figure:: resources/img/sales_install_4.png
+Если фактическое поведение оличается от ожидаемого, то необходимо:
 
-        Рис. Ввод пароля
+* проверить конфигурационный файл ``/etc/nginx/sites-enabled/synergy-base`` 
+  на наличие следующих настроек:
 
-* Ввести пароль mysql
+```
+   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;
+        }
 
-    .. figure:: resources/img/sales_clean_3.png
+   location /customers {
+            proxy_pass http://127.0.0.1:8080/customers;
+        }
+```
 
-        Рис. Ввод пароля mysql
+* открыть Конструктор приложений по адресу http://адрес_сервера:порт/constructor 
+  (например: http://192.168.4.80:8080/constructor), авторизоваться под Системным 
+  пользователем, открыть приложение с кодом `customers` и задеплоить его через 
+  меню "Клиент" -> "Деплой".
 
-После установки
--------------------
+В-третьих, обязательно выполнить прочие пункты 
+`инструкции по внедрению <http://rtd.lan.arta.kz/docs/sales-introduction-guide/ru/v2.0/>`_.
 
-После установки приложения обязательно выполнить пункты `инструкции по внедрению <http://rtd.lan.arta.kz/docs/sales-introduction-guide/ru/v1.5/>`_.