Skip to content

Docker_Instructions.md

Latest commit

 

History

History
58 lines (42 loc) · 3.48 KB

Docker_Instructions.md

File metadata and controls

58 lines (42 loc) · 3.48 KB

Running Dockerized ConnectedVCS Tools

If you are running ConnectedVCS Tools using a docker image, 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.

Install Docker CE

Instructions for installing Docker may change, so please use the current instructions at the Docker website: https://docs.docker.com/desktop/install/linux-install/.

Run the ConnectedVCS Tools Image

Build a Custom Image

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

  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. Using SSL vs not using SSL:

    • If using SSL certificates, you may look up instructions to generate a keystore and SSL certficiates with your certificate authority (CA) of choice. In this case, the ssl.ini and keystore files will need to be updated or replaced to copy your applicable keystore information to the image. NOTE: The current ssl.ini and keystore files are examples only. Please update or replace before running the following command.
    sudo docker build -t usdotfhwastol/connectedvcs-tools:<tag> --build-arg USE_SSL=true .
    • If running the tool without certificates, no changes are needed. Run the following command.
    sudo docker build -t usdotfhwastol/connectedvcs-tools:<tag> --build-arg USE_SSL=false .

Run Image with SSL certificate

sudo docker run -d -p 443:443 usdotfhwastol/connectedvcs-tools:<tag>

Run Image without SSL certificate

sudo docker run -d -p 8080:8080 usdotfhwastol/connectedvcs-tools:<tag>

Access the ConnectedVCS Tools Interface

  1. In your browser, navigate to: