Перейти к содержанию

# Введение

Данный документ содержит информацию о структуре каталога комплекта поставки VisionLabs FaceStream (далее — FaceStream).

FaceStream осуществляет чтение и обработку видеопотоков, видеофайлов и наборов изображений, и отправку лучших снимков лиц или тел в виде HTTP запросов в LUNA PLATFORM. Более подробное описание приложения приведено в руководстве администратора "FS_Administrator_Manual_Rus.pdf" в комплекте поставки. Описание установки и запуска приведено в руководстве по установке "FS_Installation_Manual_Rus".*.

* форматы `pdf` и `html`

# Структура каталогов комплекта поставки

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

Имя директории | Описание
--- | ---
/example-docker | Директория включает в себя все файлы, необходимые для запуска Docker контейнеров
/extras | Дополнительные зависимости и вспомогательные скрипты
/docs | Документация для FaceStream

Директория "extras" содержит:

Имя директории | Описание
--- | ---
/conf | Конфигурационные файлы для FaceStream
/hasp | HASP утилиту и файлы, необходимые для активации лицензии

## Документация комплекта поставки

В данном разделе описывается пакет документации из комплекта поставки FaceStream. Все документы находятся в папке "/docs" комплекта поставки.

### Руководства по эксплуатации

Нижеперечисленные руководства описывают общие процессы FaceStream, его архитектуру и развертывание.

Большинство документов представлены в форматах PDF и HTML. Навигация в PDF документе проще, однако в HTML документе удобнее копировать команды.

Документ | Описание
--- | ---
FS_Administrator_Manual_Rus.pdf | Общая информация о FaceStream, его настройке и установке
FS_Installation_Manual_Rus.* | Инструкция по запуску FaceStream с помощью запуска Docker контейнеров или автоматическому запуску с помощью скрипта Docker Compose
FS_Release_Notes_Rus.* | Примечания к релизам FaceStream

* форматы `pdf` и `html`

### Справочные руководства

Нижеперечисленные руководства описывают спецификации Open API для FaceStream и LUNA Streams. Спецификация Open API — единственный документ, предоставляющий актуальную информацию о API сервисов. Спецификация может использоваться:

- Инструментами создания документации для визуализации API.
- Инструментами генерации кода.

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

Данные руководства расположены в директории "./docs/ReferenceManuals". В этой директории расположены документы сервиса LUNA Streams в формате YML и HTML и документ для FaceStream в формате HTML. Документ в формате YML содержит запросы к сервису LUNA Streams. Его можно использовать для автоматической генерации запросов в инструментах для тестирования API, например, Postman (не описано в документации FaceStream). Не гарантируется, что все запросы будут импортированы правильно, может потребоваться ручное редактирование. Документы в формате HTML используются для визуализации данных спецификации и могут быть не полными.

Спецификацию OpenAPI для сервиса LUNA Streams можно получить с помощью запроса "get openapi documentation" к данному сервису. Заголовок "Accept" должен принимать значение "application/x-yaml".

Документ | Описание
--- | ---
FaceStreamReferenceManual.html | Описание API для FaceStream
StreamsReferenceManual.* | Описание API для LUNA Streams

* форматы `yml` и `html`

### Руководство для разработчиков сервиса LUNA Streams

Руководство LUNA Streams предназначено для разработчиков и DevOps-инженеров. Оно расположено в директории "./docs/ServiceManuals/StreamsDevelopmentManual/index.html". Руководство содержит описание работы LUNA Streams с детальным раскрытием технических нюансов.

### Руководства по установке/обновлению FaceStream без запуска LP

При необходимости можно запустить FaceStream без запущенной LUNA PLATFORM. Документация по запуску/обновлению расположена в директории "./docs/Standalone/".