Skip to content

Latest commit

 

History

History
77 lines (62 loc) · 3.54 KB

README.md

File metadata and controls

77 lines (62 loc) · 3.54 KB

ACE UI Application

Introduction

The ACE UI Application is a small web-based application built upon the ACE Framework. This application allows end users to interact, monitor, and configure with underlying ACE environment from a web dashboard. A preconfigured docker-compose file is provided with an example setup, but customization and extension of the application (e.g., additional or different analytics) are possible through modifying configuration files.

Detailed Documentations

  • Usage Details on how to use the user interface.
  • Development Guide on how to create local environment for development.
  • Contribution Guide on contributing to this repository

Requirements

You'll want to these packages for running and testing the full codebase

  • docker
  • docker compose
  • unix terminal with makefile installed. Most unix terminal has makefile installed by default.
  • ACE base containers and analytics built on the system (See the ACE Framework for more details on building these). TLDR: clone ACE Framework and run bash build.sh

Quick Start

  1. Install docker and docker-compose
  2. Build ACE framework by running
git clone http://github.com/usnistgov/ace.git
cd ace
bash build.sh
  1. Build ACE-UI by running
cd ../
git clone https://github.com/usnistgov/ace-ui.git
cd ../ace-ui
make build
  1. start the application run make start
  2. Using a web browser, go to this URL http://localhost:8999/app/ to access the ACE UI

Makefile shortcuts

To make development easier, a makefile was included. Run make help from the root of the project to see the documentation. As of writing this README, you can use the following options:

$make help
help                           This help.
dev                            install requirements.txt
build                          Build ace containers
start                          start ace stack using docker-compose
stop                           stop ace stack using docker-compose

Build and configure the Application

  • Run make docker-build to build the ACE API server docker container
  • To use local video files for testing, drop those files into this directory and update the docker-compose.yml file so that one of the video_file containers references your file (an example is shown below)
video_file_1:
    image: video_server:demo
    restart: always
    labels:
      type: video
    volumes:
      - $PWD:/videos
    command:
      - "-v"
      - "/videos/{video filename}"      # Replace "{video filename}" with the name of your video file

Two local video files can be configured this way using the example docker-compose deployment provided.

For additional information on configuring the application see the documentation

Using public video streams

Once the UI is available you can access it from the IP of your running docker VM (my case 127.0.0.1:8999/app) and can add streams to the UI http://127.0.0.1:8999/app/form

To add a public video stream available on insecam:

Find a stream to add to the dashboard from http://www.insecam.org/en/bytype/Axis/ and from here, right-click any video and select copy image address. You can use the address as a video stream on the configuration tab as a custom stream source. Adding a custom source URL is available when you toggle "Use custom stream source" on the configure page.