May 12 2020 Linux Documentation
Total Page:16
File Type:pdf, Size:1020Kb
Linux SAFR® Documentation Linux SAFR® Documentation Documentation Version = 2.007 Publish Date = April 12, 2020 Copyright © 2020 RealNetworks, Inc. All rights reserved. SAFR® is a trademark of RealNetworks, Inc. Patents pending. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. 1 Contents 1 What’s New 5 2 SAFR Overview 6 3 SAFR System Requirements 9 4 Licensing 15 5 Getting Started with SAFR Platform on Linux 17 6 Manage People in the Person Directory 20 7 Importing and Registering People 21 8 Image Quality Metrics Guidance 23 9 Actions Overview 27 10 Actions Relay Event Service (ARES) 29 11 SAFRActions.config 30 12 Large Scale Deployments 41 13 Database Redundancy 45 14 Object Storage Service Redundancy (CVOS) 50 15 SSL Certificate Installation 55 16 SAFR Support Tools and Scripts 59 17 SAFR Server Backup and Restore 61 18 Video Recognition Gateway (VIRGO) 62 19 VIRGO Installation Guide 65 20 VIRGO System Requirements 67 21 VIRGO Command Line Interface 68 22 Docker 73 23 Factory Configuration 76 24 GPU Support 81 25 Service Logging 84 26 Service Monitoring 86 27 Troubleshooting 88 28 Command & Control Protocol (COP) 91 29 COP Introduction 92 2 30 COP Status Delivery 94 31 COP Status Reply 103 32 COP Image Capture 127 33 COP Tracking Result Capture 128 34 COP Logging 133 35 COP Software Updates 135 36 COP Errors 138 37 COP State Update Algorithms 144 38 COP Examples 149 39 Connect a Face Recognition Panel 154 40 Connect a Registration Kiosk 156 41 Customize a Registration Kiosk 158 42 Configure a Mobile Device into Locked Mode 160 43 Install SAFR Beam 170 44 Mobile Account Preferences 171 45 Mobile Detection Preferences 172 46 Mobile Recognition Preferences 173 47 Mobile Events Preferences 174 48 Mobile User Interface Preferences 175 49 Web Console 176 50 Status Page 177 51 People Page 183 52 Events Page 184 53 Video Feeds Pages 185 54 Reports Page 187 55 Traffic Dashboard 188 56 Queue Dashboard 191 57 Attendance Dashboard 193 58 Traversal Dashboard 195 59 Traffic Report 198 3 60 Face Detection-Person Detection Tie-In 200 61 May 2020 Release Notes 201 62 April 2020 Release Notes 202 63 March 2020 Release Notes 204 64 January 2020 Release Notes 207 65 December 2019 Release Notes 209 66 November 2019 Release Notes 212 67 September 2019 Release Notes 215 68 August 2019 Release Notes 218 4 1 What’s New The following features are new in the May 2020 SAFR release: • Added Mask Detection integration. Only available on Windows. An enhanced mask recognition model has been implemented that greatly increases SAFR’s ability to recognize people even when they’re wearing a mask. Only standard blue or white surgical masks are currently supported; SAFR is unable to use the enhanced mask recognition model with masks of different colors or with masks that have customized patterns. Mask detection can be configured on the Recognition Preferences tab of the Windows Desktop client. • Added Intel RealSense camera support. Only available on Windows. • Added 3D Liveness Detection. (Beta Feature) Only available on Windows. 3D liveness is a special feature of Intel RealSense cameras that allows them to distinguish flat images from 3 dimensional ones, thus allowing SAFR to tell the difference between a real face and a photo. This feature only works with Intel RealSense cameras; if you don’t have any cameras of this type connected to SAFR, then this feature will not work. 3D Liveness Detection can be configured on the Recognition Preferences tab of the Windows Desktop client. 5 2 SAFR Overview SAFR is a facial recognition system that integrates cameras, door locks, and alert systems with face recognition technology to enhance access control and security. It runs on a variety of operating systems, including Windows, macOS, Linux, iOS, and Android. 2.1 SAFR Components SAFR primarily consists of the following components: • SAFR Server: Available for Windows, macOS, and Linux. The SAFR Server installation contains the recognition engine, event server, several databases, and the Web Console. The databases contain stored enrolled face images, the identity information for the stored faces, and recognition events that have been generated by the SAFR system. The SAFR Server runs as several background services that automatically start on system reboot and are kept active by the operating system. They must be running at all times for the system to be operational. All other SAFR components must connect to a SAFR Server, although if you’re doing a cloud deployment you’ll be connecting to a SAFR Server in the cloud that RealNetworks maintains. • Desktop client: Available for Windows and macOS. The Desktop client is one of the primary ways that administrators and operators can interact with the SAFR system. As such, the client can be used to enable camera connectivity, monitor video camera feeds, register users, view recognition events, and more. • Mobile client: Available for Android and iOS. The Mobile client converts a mobile device into a registration kiosk or a recognition panel. Registration kiosks allow people to self-register their face into the Identity Database so they can be approved for access or granted other privileges. Recognition panels enable the mobile device to scan the faces of people that walk by and to compare those faces against faces in the Identity Database. Mobile devices set up as recognition panels can also provide visual or audio feedback to the person viewing the mobile device based on actions that a SAFR administrator has configured. • VIRGO: Available as a standalone download for macOS and Linux. It’s also available as part of the SAFR Desktop, SAFR Edge, and SAFR Platform download packages for Windows, macOS, and Linux. The Video Recognition Gateway (VIRGO) is a daemon system which receives video feeds from one or more cameras and recognizes and tracks faces in those video streams in real time. It generates tracking events and sends those events to an event server. The VIRGO daemon can be controlled either by the command line tool or through the Video Recognition Gateway Administration (VIRGA) command & control server. • Web Console: Available on all platforms. The Web Console provides administrators and operators web-based access to the SAFR system. As such, the Web Console can be used to generate analytical reports, monitor video camera feeds, register users, view recognition events, and more. • ARES: Available as a standalone download for all platforms. Actions Relay Event Service (ARES) is a cross-platform Java application that acts as the event listener that dispatches configured actions in response to events. ARES can provide replies on any event handled by the client that originates an event and is normally installed as a service when either SAFR Platform or SAFR Edge are installed. It is constantly active and is automatically started by the operating system on power-up. • SAFR Actions: SAFR Actions is a GUI that facilitates configuring SAFRActions.config. SAFRAc- tions.config is the file that defines all the defined actions for your SAFR System, as well as a couple fields that are used to connect ARES (and SAFR Actions) to your primary SAFR Server, whether that server is local or in the cloud. See Actions for more information about actions in SAFR. 6 In addition to the SAFR components listed above, SAFR also relies on a couple additional non-SAFR components: • IP Cameras: As you might expect, Internet Protocol (IP) cameras are absolutely integral to SAFR. Both the Desktop client and VIRGO automatically detect integrated, USB, and Open Network Video Interface Forum (ONVIF) IP cameras. If an IP camera does not support ONVIF or doesn’t have ONVIF enabled, you can still manually add it to the SAFR system as described here. • Physical access control devices: Door locks, electronic gates, etc. can all be used by SAFR to grant or deny access to people, depending on whether or not they’re identified as having the proper authorization. • Notification systems: Email can be used to discretely notify specified people of various events, while general alarms can be used to alert everybody in the vicinity when unauthorized people attempt to force entry. • Additional external peripherals: Any device that can be controlled by a computer language or protocol can be incorporated into the SAFR system. 2.2 Available Download Packages The following download packages are available on the SAFR Download Portal: • SAFR Platform: Available on Windows, macOS, and Linux. The SAFR Platform installs everything you need to set up a local deployment of SAFR. This downlaod package enables a locally deployed system to be easily deployed on a single computer and afterwards expanded to additional computers as needed. See Getting Started with SAFR Platform on Linux for more information. • SAFR Desktop: Available on Windows and macOS. Installs the Desktop client and one of the VMS extensions. Windows has an additional download variant called SAFR Desktop Lite which has fewer features and lower system requirements. • SAFR Edge: Available on Windows and macOS. SAFR Edge installs the Desktop client as well as SAFR Actions, a programmable interface to create and manage responses to event triggers.