Skip to content

Commit 3676f46

Browse files
committed
Update README
1 parent fc6d97d commit 3676f46

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,25 @@
22

33
<p align='center'>Pull in Officer Locations via AXON Body Cams</p>
44

5-
## Development
5+
## Setup
6+
7+
1. Contact the administrator of the Axon Evidence Account to create an API Token for the ETL to use.
8+
2. From the admin account navigate to the "Admin" tab
9+
3. Then select "API Settings" under "Security Settings"
10+
4. Click "Create Client" & fill in a name - IE "COTAK"
11+
5. For API permissions select the following:
12+
- `Device: state.any.read Allowed`
13+
- `Response: self.locate: Allowed`
14+
- `Response: self.alert_mark: Allowed`
15+
- `Response: any.locate: Allowed`
16+
- `Users: read: Allowed`
17+
6. Create the client & Provide the:
18+
- Secret
19+
- Partner ID
20+
- Client ID
21+
- Agency Domain (IE <your-agency>.evidence.com)
22+
23+
<details><summary>Development Information</summary>
624

725
DFPC provided Lambda ETLs are currently all written in [NodeJS](https://nodejs.org/en) through the use of a AWS Lambda optimized
826
Docker container. Documentation for the Dockerfile can be found in the [AWS Help Center](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html)
@@ -38,8 +56,9 @@ node dist/task.js
3856

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

41-
Github actions will build and push docker releases on every version tag which can then be automatically configured via the
59+
Github actions will build and push docker releases on every version tag which can then be automatically configured via the
4260
CloudTAK API.
4361

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

64+
</details>

0 commit comments

Comments
 (0)