antmounds/antennae repository overview

⁠Supported tags and respective Dockerfile links

• 2, latest (Dockerfile)⁠
• 1, lite (Dockerfile)⁠
• 0.9 (Dockerfile)⁠

⁠Quick reference

• Where to get help:
  the Antmounds Community Discord⁠

• Where to file issues:
  the Antennae GitLab⁠

• Maintained by:
  the Antmounds Antennae Team⁠

• Published image artifact details:
  - (image metadata, labels, layers, transfer size, tags)⁠ - (Quay vulnerability scans)⁠

• Source of this description:
  repo's docker/ directory⁠ (history⁠)

• Supported Docker versions:
  the latest release⁠ (down to 1.6 on a best-effort basis)

⁠What is Antennae?

Antennae is a free and open-source face recognition node.js app using AWS Rekognition⁠ to detect and match faces. The app allows you to create collections of 'face prints' and later search an image across any number of selected databases. Each search will also return detected emotions, gender, estimated age range, and other facial features such as the presence of glasses, face hair and smiles. Use cases include allowing you to easily and quickly find missing persons, helping the visually impaired, verifying dates and rendevouz, recognizing celebrities, victim identificaion, and so much more!

Check-in stand mode allows you to set this up for point-of-sale, self-service check-in/out, vip recognition, loyalty rewards programs and greet returning guests by name. Simply by being recognized, allow guests to enter queues, pre-order, confirm options and view current status from their Antennae app. The dashboard shows all guests and where they were recognized.

This repo features infrastructure code that will allow you to self-host the application using a containerized, highly available, self-repairing, military grade, secure cloud environment. For a managed SaaS solution check out Antennae Cloud⁠, featuring private and pre-populated public face print databases, teams, white-label and 24/7 support options.

Antmounds provides two versions of Antennae: Antennae⁠ and Antennae Lite⁠.

⁠How to use this image

AWS keys and mongodb url are set at runtime to avoid building secrets into the image. At a minimum, keys must have permissions for AWS Rekognition⁠ service. For further usage instructions see main project repo⁠

⁠1) Set runtime parameters

The following runtime arguments are required:

• AWS_ACCESS_KEY_ID - required for AWS access
• AWS_SECRET_ACCESS_KEY - required for AWS access
• MONGO_URL - required to save face and search metadata

⁠2) Run latest version of app

docker run --rm -d -P -e AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID} -e AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY} -e MONGO_URL=${MONGO_URL} --name antennae antmounds/antennae

⁠Command Description

docker run \
    --rm \          # removes container after it is stopped
	-d \            # runs container in detached mode
	-P \            # publishes the images exposed port 3000 to a random port on localhost
	-e AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID} \      # set environment variable
	-e AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY} \   # set environment variable
	-e MONGO_URL=${MONGO_URL} \   # set environment variable
	--name antennae \       # name the container whatever you want
	antmounds/antennae   # latest official Antennae image from dockerhub

⁠Docker Compose

⁠1) Create a docker-compose.yml file with the following contents:

version: '3.6'

services:

  app:
    image: antmounds/antennae
    restart: on-failure
    environment:
      - AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID}
      - AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY}
      - MONGO_URL=mongodb://mongo/antennae
      - MONGO_OPLOG_URL=mongodb://mongo/local
    ports:
      - 80:3000
    networks:
      - overlay
    depends_on:
      - db

  db:
    image: mongo
    restart: always
    networks:
      overlay:
        aliases:
          - mongo
    command: mongod --config /etc/mongod.conf
    volumes:
      - ./docker/mongod.conf:/etc/mongod.conf
      - ./docker/replicaSet.js:/docker-entrypoint-initdb.d/replicaSet.js

networks:
  overlay:

⁠2) Start the services

• docker-compose up - starts services
• docker-compose ps - view running processes of services

⁠Where can I run Antennae container images?

You can run Antennae container images in any Docker based environment. Examples include, your laptop, in AWS/GCP/Azure instances and clusters.

⁠How is Antennae different from Antennae Lite?

There are three major differences in Antennae from its predecessor:

1. it includes admin/user accounts
2. it enables check-in by users
3. it saves images by default for later comparison

⁠Is Antennae backward compatible with Antennae Lite?

Due to the inclusion of new architecture in Antennae such as user accounts, your applications running on the current version of Antennae may require additional changes to run on Antennae Lite.

⁠Contributing

Pull requests, forks and stars are mucho appreciated and encouraged. See CONTRIBUTING.md⁠ for how to get involved in this project.

• ⁠Get official Antmounds gear!

  

• ⁠Become a Supporter!

  

⁠Get in touch

• Join the Antmounds discord⁠ server for more discussion and support on this project.
• Watch LIVE development of this app on YouTube⁠, Twitch.tv⁠ and Mixer⁠
• Use the issue tracker⁠ for bugs, feature requests and enhancements
• For serious business inquiries contact [email protected]⁠

⁠Authors

• Nick@antmounds⁠ - initial development

⁠License

Copyright © 2018-present Antmounds.com, Inc. or its affiliates. All Rights Reserved.