open-ode updated quick start guide.

README.md

@@ -21,7 +21,7 @@ In the context of ITS, an Operational Data Environment is a real-time data acqui
 
 [IV. Quickstart Guide](#quickstart-guide)
 
-[V. Testing the Application](#testing)
+[V. Running the Application](#running)
 
 [VI. ODE Limitation](#dev-tools)
 
@@ -200,7 +200,12 @@ If you wish to change the application properties, such as change the location of
 
 #### Step 3: Build and deploy the application.
 
-Navigate to the root directory of the jpo-ode project. The easiest way to do run the ODE application and all its submodules is using Docker. The script ```clean-build-and-deploy``` executes all the necessary commands to do just that:
+Copy the fillowing files from jpo-ode directory into your DOCKER_SHARED_VOLUME directory.
+- Copy jpo-ode/ppm.properties to ${DOCKER_SHARED_VOLUME}/config.properties. Open the newly copied `config.properties` file in a text editor and update the `metadata.broker.list=your.docker.host.ip:9092` line with your system's DOCKER_HOST_IP in place of the dummy `your.docker.host.ip` string. 
+- Copy jpo-ode/adm.properties to ${DOCKER_SHARED_VOLUME}/adm.properties
+- Copy jpo-ode/aem.properties to ${DOCKER_SHARED_VOLUME}/aem.properties
+
+Navigate to the root directory of the jpo-ode project. The easiest way to build _and_ run the ODE application and all its submodules is using Docker. The script ```clean-build-and-deploy``` executes all the necessary commands to do just that:
 
 ```
 #!/bin/bash
@@ -211,7 +216,7 @@ docker-compose up --build -d
 docker-compose ps
 ```
 
-For other build options, see the next section. Otherwise, move on to section [V. Testing ODE Application](#testing)
+For other build options, see the next section. Otherwise, move on to section [V. Running ODE Application](#running)
 
 [Back to top](#toc)
 
@@ -253,9 +258,9 @@ You can run the application on your local machine while other services are deplo
 
 [Back to top](#toc)
 
-<a name="testing"/>
+<a name="running"/>
 
-## V. Testing ODE Application
+## V. Running ODE Application
 Once the ODE is running, you should be able to access the jpo-ode web UI at `localhost:8080`.
 
 1. Press the `Connect` button to connect to the ODE WebSocket service.

ppm.properties

@@ -0,0 +1,35 @@
+# Configuration details for the velocity filter.
+# min and max velocity values are in units m/s per the J2735 specification.
+privacy.filter.velocity=ON
+privacy.filter.velocity.min=2.235
+privacy.filter.velocity.max=35.763
+
+# Configuration details for privacy ID redaction.
+privacy.redaction.id=ON
+privacy.redaction.id.value=FFFFFFFF
+privacy.redaction.id.inclusions=ON
+privacy.redaction.id.included=BEA10000,BEA10001
+
+# Configuration details for geofencing.
+privacy.filter.geofence=ON
+privacy.filter.geofence.mapfile=/ppm_data/road_file.csv
+privacy.filter.geofence.sw.lat=40.997
+privacy.filter.geofence.sw.lon=-111.041
+privacy.filter.geofence.ne.lat=42.085
+privacy.filter.geofence.ne.lon=-104.047
+
+# ODE / PPM Kafka topics.
+privacy.topic.consumer=topic.OdeBsmJson
+privacy.topic.producer=topic.FilteredOdeBsmJson
+
+group.id=0
+
+# For testing purposes, use one partition.
+privacy.kafka.partition=0
+
+# The host ip address for the Broker.
+metadata.broker.list=your.docker.host.ip:9092
+
+# specify the compression codec for all data generated: none, gzip, snappy, lz4
+compression.type=none
+

quickstart-compose.yml

@@ -87,7 +87,7 @@ services:
 # environment:
 # DOCKER_HOST_IP: ${DOCKER_HOST_IP}
 # volumes:
-# - ${DOCKER_SHARED_VOLUME}:/ppm_data#
+# - ${DOCKER_SHARED_VOLUME}:/ppm_data
 
 # cvpep_bsm_s3dep:
 # build: ./jpo-s3-deposit