Skip to content

README.md

Latest commit

 

History

History
68 lines (47 loc) · 2.53 KB

README.md

File metadata and controls

68 lines (47 loc) · 2.53 KB

ETL-AXON

Pull in Officer Locations via AXON Body Cams

Setup

  1. Contact the administrator of the Axon Evidence Account to create an API Token for the ETL to use.

  2. From the admin account navigate to the "Admin" tabrtaImage

  3. Then select "API Settings" under "Security Settings"image

  4. Click "Create Client" & fill in a name - IE "COTAK"

  5. For API permissions select the following:

    • Device: state.any.read AllowedrtaImage

    • Respond: self.locate: Allowed

    • Respond: self.alert_mark: Allowed

    • Respond: any.locate: AllowedrtaImage

    • Users: read: AllowedrtaImage

  6. Create the client & Provide the:

  • Secret
  • Partner ID
  • Client ID
  • Agency Domain (IE .evidence.com)rtaImage

Development Information

DFPC provided Lambda ETLs are currently all written in NodeJS through the use of a AWS Lambda optimized Docker container. Documentation for the Dockerfile can be found in the AWS Help Center

npm install

Add a .env file in the root directory that gives the ETL script the necessary variables to communicate with a local ETL server. When the ETL is deployed the ETL_API and ETL_LAYER variables will be provided by the Lambda Environment

{
    "ETL_API": "http://localhost:5001",
    "ETL_LAYER": "19"
}

To run the task, ensure the local CloudTAK server is running and then run with typescript runtime or build to JS and run natively with node

ts-node task.ts

npm run build
cp .env dist/
node dist/task.js

Deployment

Deployment into the CloudTAK environment for configuration is done via automatic releases to the DFPC AWS environment.

Github actions will build and push docker releases on every version tag which can then be automatically configured via the CloudTAK API.

Non-DFPC users will need to setup their own docker => ECS build system via something like Github Actions or AWS Codebuild.