July 20 2020 Linux Documentation
Total Page:16
File Type:pdf, Size:1020Kb
Linux SAFR® Documentation Linux SAFR® Documentation Documentation Version = 2.016 Publish Date = July 20, 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 Camera Best Practices 20 7 Manage People in the Person Directory 28 8 Importing and Registering People 29 9 Image Quality Metrics Guidance 31 10 Actions Overview 35 11 Actions Relay Event Service (ARES) 37 12 SAFRActions.config 38 13 Large Scale Deployments 49 14 Database Redundancy 53 15 Object Storage Service Redundancy (CVOS) 58 16 SSL Certificate Installation 63 17 SAFR Support Tools and Scripts 67 18 SAFR Server Backup and Restore 69 19 SAFR Platform Command Line Install Options 70 20 Video Recognition Gateway (VIRGO) 71 21 VIRGO Installation Guide 74 22 VIRGO System Requirements 76 23 VIRGO Command Line Interface 77 24 Docker 82 25 Factory Configuration 85 26 GPU Support 90 27 Service Logging 93 28 Service Monitoring 95 29 Troubleshooting 97 2 30 Command & Control Protocol (COP) 100 31 COP Introduction 101 32 COP Status Delivery 103 33 COP Status Reply 112 34 COP Image Capture 136 35 COP Tracking Result Capture 137 36 COP Logging 142 37 COP Software Updates 144 38 COP Errors 147 39 COP State Update Algorithms 153 40 COP Examples 158 41 Connect a Face Recognition Panel 163 42 Connect a Registration Kiosk 165 43 Customize a Registration Kiosk 167 44 Configure a Mobile Device into Locked Mode 169 45 Install SAFR Beam 179 46 Mobile Account Preferences 180 47 Mobile Detection Preferences 181 48 Mobile Recognition Preferences 182 49 Mobile Events Preferences 183 50 Mobile User Interface Preferences 184 51 Web Console 185 52 Status Page 186 53 People Page 192 54 Events Page 193 55 Video Feeds Pages 194 56 Reports Page 196 57 Traffic Dashboard 197 58 Queue Dashboard 200 59 Attendance Dashboard 202 3 60 Traversal Dashboard 204 61 Occupancy Dashboard 207 62 Traffic Report 209 63 Face Detection-Person Detection Tie-In 211 64 July 2020 Release Notes 212 65 June 2020 Release Notes 214 66 May 2020 Release Notes 215 67 April 2020 Release Notes 216 68 March 2020 Release Notes 218 69 January 2020 Release Notes 221 70 December 2019 Release Notes 223 71 November 2019 Release Notes 226 72 September 2019 Release Notes 229 73 August 2019 Release Notes 232 4 1 What’s New The following features are new in the July 2020 SAFR release: • Added a new report, the Occupancy Dashboard, which monitors how many people are within a certain physical space. 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. For example, you can unlock a door, turn on a light, send an alert, and so on. • SAFR Mobile: Available on Android and iOS. Installs the Mobile client. When you download SAFR Mobile for Android, you’re also offered the SAFR Beam download. SAFR Beam allows you to enable the more secure Lock Task Mode on your Android device. If you don’t install SAFR Beam, then Android devices can only enable the less secure Screen Pinning Mode. See Configure Devices into Locked Mode for more information. • Actions Relay Event Service (ARES): Available on all platforms. Installs ARES. • Video Recognition Gateway (VIRGO): Available on Linux and macOS. Installs VIRGO. 2.3 Deployment Types There are two types of SAFR deployment: cloud and local. Each deployment type requires its own account type; a cloud deployment requires a SAFR Cloud Account, while a local deployment requires a SAFR Local Account.