Skip to content

Local_Instructions.md

Latest commit

 

History

History
77 lines (61 loc) · 3.98 KB

Local_Instructions.md

File metadata and controls

77 lines (61 loc) · 3.98 KB

Running ConnectedVCS Tools Locally

If you are running ConnectedVCS Tools locally, you can use the following instructions:

NOTE: Bing Maps is now deprecated and new users are no longer allowed to create API keys. We will be migrating to a different map provider and updating this documentation soon.

Prerequisites

ConnectedVCS Tools has been developed using Ubuntu 20.04 and Ubuntu 22.04. Further testing with other operating systems is needed before guidance is created. For the moment, please use Ubuntu 20.04 or later Ubuntu LTS Release.

  1. Install JDK (openjdk-8-jdk).
sudo apt-get install -y openjdk-8-jdk
  1. Install Maven (3.6.3).
sudo apt-get install -y maven
  1. Install gettext-base
sudo apt-get install -y gettext-base

Clone repository

  1. Clone the ConnectedVCS Tools respository:
git clone https://github.com/usdot-fhwa-stol/connectedvcs-tools.git

Local Setup Path

  1. Set up LD_LIBRARY_PATH by running:
echo export LD_LIBRARY_PATH="[path_to_connectedvcs-tools]/fedgov-cv-lib-asn1c/third_party_lib" >> ~/.bashrc

Update web.xml files for use with or without SSL

Update the web.xml based on SSL selection

  • If using SSL certificates:
export SECURITY_CONSTRAINT="<security-constraint><web-resource-collection><web-resource-name>Everything</web-resource-name><url-pattern>/*</url-pattern></web-resource-collection><user-data-constraint><transport-guarantee>CONFIDENTIAL</transport-guarantee></user-data-constraint></security-constraint>";
  • If not using SSL:
export SECURITY_CONSTRAINT="";

envsubst '$SECURITY_CONSTRAINT' < root/WEB-INF/web.xml > /tmp/web.xml.tmp && \
mv /tmp/web.xml.tmp root/WEB-INF/web.xml && \
envsubst '$SECURITY_CONSTRAINT' < fedgov-cv-TIMcreator-webapp/src/main/webapp/WEB-INF/web.xml > /tmp/web.xml.tmp && \
mv /tmp/web.xml.tmp fedgov-cv-TIMcreator-webapp/src/main/webapp/WEB-INF/web.xml && \
envsubst '$SECURITY_CONSTRAINT' < fedgov-cv-ISDcreator-webapp/src/main/webapp/WEB-INF/web.xml > /tmp/web.xml.tmp && \
mv /tmp/web.xml.tmp fedgov-cv-ISDcreator-webapp/src/main/webapp/WEB-INF/web.xml

Local Build Instructions

  1. To generate API keys required for the MAP Tool, first create user accounts with Google Maps Platform, Esri ArcGIS Location Platform, Azure Maps Platform.

  2. Generate new API Keys for Google Maps, Esri, and Azure. Use the Google Maps Platform, Esri ArcGIS Location Platform, Azure Maps Platform.

  3. Enter your keys into the application.properties file (within "google.map.api.key", "azure.map.api.key", and "esri.map.api.key").

  4. Run:

sudo ./build.sh

Local Deployment

  1. Locate root.war, private-resources.war, isd.war, and tim.war in connectedvcs-tools/, connectedvcs-tools/fedgov-cv-ISDcreator-webapp/target and connectedvcs-tools/fedgov-cv-TIMcreator-webapp/target respectively.
  2. Deploy as servlets in conjunction with Apache Tomcat.