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.

• 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
• README.md Guide on how to build standalone webui docker/docker-compose.

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

1. Install docker and docker-compose
2. Build ACE framework by running

git clone http://github.com/usnistgov/ace.git
cd ace
make cpu_nist-ace_extra  # creates the images "datamachines/nist-ace:demo", "ocv-ssd:demo", "ace-test-analytic:demo", "act-recognition:demo", and "camera_stream:demo"

3. Build ACE-UI by running

cd ../
git clone https://github.com/usnistgov/ace-ui.git
cd ace-ui
make build

4. Create the necessary external volumes

 docker volume create grafana-storage
 docker volume create influxdb-storage

5. Start the application by running

make start

6. Using a web browser, go to this URL http://localhost:8999/app/ to access the ACE UI
7. You can now jump to the README section "Using public video streams" if you'd like

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
start-web                      start web UI only
stop-web                       stop web UI only

docker-compose-gpu-enabled.yml   gpu enabled, generally used in GPU enabled service nodes
docker-compose-webui.yml         WEB UI only, with api endpoint set in web-app/.env file 
docker-compose.yml                full ACE services, with GPU disabled

• 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

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

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.