Различия

Здесь показаны различия между двумя версиями данной страницы.

--- doc:1806:643.mgul.18061-01_32_01 [2021/07/27 09:05]
nozemiso [Настройка работы программы]
+++ doc:1806:643.mgul.18061-01_32_01 [2021/07/27 14:24] (текущий)
nozemiso [Сообщения системному программисту]
@@ Строка 8: / Строка 8: @@
 В директории "/node_modules" хранятся сами модули.
-По пути "/public/klop_in" находятся статические файлы "index.html", "style.css", "script.js" а также файл с группами точек "places.json"
+По пути "/public/klop_in" находятся статические файлы страницы отправки записей в базу "index.html", "style.css", "script.js", файл с группами точек "places.json" и файл конфигурации "settings.json"
+По пути "/public/klop_in/places" находятся статические файлы страницы редактирования списка групп точек "index.html", "style.css", "script.js"
 В директории "/routes" лежит скрипт "klop_api.js", отвечающий за пересылку данных на сервер с базой данных.
@@ Строка 20: / Строка 23: @@
 ===== Размещение программы =====
 Поместите архив с проектом в выбранную вами директорию. В данном примере используем удаленное подключение по SSH.
-<code>$ scp d:/dbloader_rest.zip nozemiso@webrobo.mgul.ac.ru:/home/nozemiso</code>
+<code>$ scp d:/klop_in.zip nozemiso@webrobo.mgul.ac.ru:/home/nozemiso</code>
 Распакуйте архив с программой
-<code>unzip dbloader_rest.zip</code>
+<code>unzip klop_in.zip</code>
 Удалите скачанный архив
-<code>rm dbloader_rest.zip</code>
+<code>rm klop_in.zip</code>
-Теперь программа готова к работе, корневой директорией проекта является "/home/nozemiso/dbloader_rest"
+Теперь программа готова к дальнейшей настройке, корневой директорией проекта является "/home/nozemiso/klop_in"
 ===== Настройка списков мест проведения измерений =====
-Файл со списком мест (/public/klop_in/places.json) имеет следующий вид.
+Файл со списком мест (/public/klop_in/places.json) имеет следующую структуру.
 <code>{
     "ИМЯ_НАБОРА_МЕСТ_1": ["ИМЯ_МЕСТА_1", "ИМЯ_МЕСТА_2", ..., "ИМЯ_МЕСТА_N"],
     "ИМЯ_НАБОРА_МЕСТ_2": ["ИМЯ_МЕСТА_1", "ИМЯ_МЕСТА_2", ..., "ИМЯ_МЕСТА_N"],
     ...
-    "ИМЯ_НАБОРА_МЕСТ_N": ["ИМЯ_МЕСТА_1", "ИМЯ_МЕСТА_2", ..., "ИМЯ_МЕСТА_N"],
+    "ИМЯ_НАБОРА_МЕСТ_N": ["ИМЯ_МЕСТА_1", "ИМЯ_МЕСТА_2", ..., "ИМЯ_МЕСТА_N"]
 }</code>
@@ Строка 42: / Строка 45: @@
     "МГУЛ 3 этаж": ["303", "319", "334", "344", "356", "365", "374"],
     "МГУЛ 4 этаж": ["476", "463", "449", "440", "432", "419", "404"],
-    "МГУЛ 5 этаж": ["505", "520", "532", "540", "558", "570", "579"],
+    "МГУЛ 5 этаж": ["505", "520", "532", "540", "558", "570", "579"]
 }
 </code>
-Чтобы создать новый набор мест следует добавить в файл строку соответствующего формата.
+Чтобы создать новый набор мест следует добавить в файл строку соответствующего формата. Также можно использовать готовую форму для ввода новых групп точек после окончания настройки программы. Всю информацию вы найдете в пункте документации "Руководство пользователя"
 ===== Настройка и запуск сервера =====
 Чтобы запустить WEB-сервер введите следующую команду, находясь в корневой директории проекта.
-<code>node serv.js &</code>
+. Создаем файл конфигурации
+<code>touch /etc/systemd/system/klop_in-application.service</code>
+. Вносим содержимое и сохраняем
+<code>
+[Unit]
+After=network-online.target
+[Service]
+WorkingDirectory=ПУТЬ_К_КОРНЕВОЙ_ДИРЕКТОРИИ_ПРОЕКТА
+ExecStart=ПУТЬ_К_ФАЙЛУ_SERV_JS
+Restart=on-failure
+[Install]
+WantedBy=multi-user.target
+</code>
+. Активируем сервис
+<code>
+systemctl enable klop_in-application
+</code>
+. Активируем сервис
+<code>
+systemctl start klop_in-application
+</code>
 По умолчанию программа будет прослушивать 3000 порт. Чтобы это изменить в файле serv.js измените строку 11. При изменении порта на 80 эта строка примет следующий вид:
@@ Строка 55: / Строка 88: @@
 ===== Настройка работы программы =====
+Для того чтобы дать доступ к редактированию групп точек определенного круга лиц, предусмотрены api-ключи, который вы можете изменять самостояльно. Чтобы установить связь между человеком и ключом рекомендуеся использовать ключ, содержащий в себе указание на человека или организацию, например, имя_фамилия_ключ.
-Настройка хода работы программы производится путем редактирования файла public/klop_in/settings.json
+Редактирование api-ключей производится путем редактирования файла public/klop_in/settings.json
 Пример файла settings.json
@@ Строка 86: / Строка 120: @@
 В случае успешного формирования и выполнения запросов вы увидите сообщение об успешной отправке строк в базу.
 Затем перейдите по ссылке "Просмотр базы данных" и убедитесь в наличии тестовой записи и соответствии данных в ней введенным вами данным.
+Для проверки работы формы редактирования ключей рекомендуется ввести в поле Api key ввести ключ "NeKKxx1", данный ключ дает доступ на редактирование набора групп точек.
-====== Сообщения системному программисту ======
+  * В поле Действие выбрать "добавить"
-При успешном запуске программы вы увидите сообщение:\\
+  * В поле Название группы ввести Test
-«Server is running on port НОМЕР_ПОРТА»
+  * В поле Кол-во точек ввести 2
+  * В поле название точек, точки назвать соответственно test1, test2
+При успешном добавлении группы точек, появится сообщение "Группа  Test успешно добавлена"

Robo wiki

Инструменты пользователя

Инструменты сайта

Различия

Инструменты страницы