Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 2.73 KB

Docker_Instructions.md

File metadata and controls

56 lines (41 loc) · 2.73 KB
Raw

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. Note: Placeholder for map API key generation.

  2. Enter a map API key and username in ISDcreator-webapp-keys and API key in application.properties.

  3. Create a new Google Maps API Key using the Google Maps Platform.

  4. Enter your key to the end of the Geocomplete src link (indicated by "google.map.api.key") at the application.properties

  5. 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 Dockerfile will need to be updated to copy your applicable keystore information to the image. NOTE: Only the last two lines in the Dockerfile will need to be updated.
    sudo docker build -t usdotfhwastol/connectedvcs-tools:<tag> --build-arg USE_SSL=true .
    • If running the tool without certificates, the default Dockerfile may be used as is.
    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: