Skip to content

# Introduction

This document contains information about the distribution package structure of VisionLabs FaceStream.

FaceStream reads and processes video streams/video files/set of images, sends face or body best shots via HTTP-requests to external services. For more details, please refer to "FS_Administrator_Manual.pdf" in the distribution package. The description of installation and launch is given in the installation manual "FS_Installation_Manual.*".

* `pdf` and `html` formats

# Distribution package structure

The package consist of the following directories:

Directory name | Description
--- | ---
/example-docker | The directory includes all the files required for launching docker containers
/extras | Additional dependencies and helper scripts
/docs | Documentation for FaceStream

The "extras" directory contents:

Directory name | Description
--- | ---
/conf | Configuration files for FaceStream
/hasp | HASP utility and files required for license activation

## Distribution documentation

This section covers the documentation package for FaceStream. All the documents can be found in "/docs" folder of the distribution package.

### Operation manuals

These manuals cover system deployment and architecture.

Most of the documents are provided in PDF and HTML formats. The PDF document is easier for navigation, the HTML document is more convenient to copy the commands.

File | Description
--- | ---
FS_Administrator_Manual.pdf | General information about FaceStream, its installation and configuration
FS_Installation_Manual.* | Instructions for launching FaceStream by launching Docker containers or automatically launching it using the Docker Compose script
FS_Release_Notes.* | Release notes for FaceStream
FS_Online_Documentation.html | Link to online documentation of the current FS version

* `pdf` and `html` formats

### Reference manuals

These manuals describe the Open API specifications for LUNA PLATFORM services. OpenAPI specification is the only valid document providing up-to-date information about the service API. The specification can be used:

- By documentation generation tools to visualize the API.
- By code generation tools.

All the documents and code generated using this specification can include inaccuracies and should be carefully checked.

The manuals can be found in the "./docs/ReferenceManuals" directory. This directory includes documents in the YML and HTML format. This directory contains documents of the LUNA Streams service in YML and HTML formats and a document for FaceStream in HTML format. The YML document contains requests to the LUNA Streams service. You can use it to automatically generate requests in API testing tools, for example, Postman (not described in FaceStream documentation). It is not guaranteed that all requests will be imported correctly, manual editing may be required. Documents in HTML format are used to visualize these specification and may not be complete.

The OpenAPI specification for the LUNA Streams service can be obtained from the "get openapi documentation" request to this service. The "Accept" header should take the value "application/x-yaml".

File | Description
--- | ---
FaceStreamReferenceManual.html | API specification for FaceStream
StreamsReferenceManual.* | API specification for LUNA Streams

* `yml` and `html` formats

### LUNA Streams developer manual

LUNA Streams reference guide is intended for developers and DevOps. This document is located in the "./docs/ServiceManuals/StreamsDevelopmentManual/index.html" directory. The manual contains a description of the work of LUNA Streams with a detailed disclosure of technical nuances.

### Install/upgrade manuals without LP launched

If necessary, you can launch FaceStream without launching LUNA PLATFORM. The install/upgrade documentation is located in the "./docs/Standalone/" directory.