-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge release/2.1.0 branch into master (#77)
<!-- Thanks for the contribution, this is awesome. --> # PR Details Merge the release/2.1.0 branch into the master branch as part of the release process. This merge should be tagged and then deployed on the new production website. Note: #76 Should be merged first ## Description <!--- Describe your changes in detail --> ## Related GitHub Issue <!--- This project only accepts pull requests related to open GitHub issues or Jira Keys --> <!--- If suggesting a new feature or change, please discuss it in an issue first --> <!--- If fixing a bug, there should be an issue describing it with steps to reproduce --> <!--- Please DO NOT name partially fixed issues, instead open an issue specific to this fix --> <!--- Please link to the issue here: --> ## Related Jira Key [Map-88](https://usdot-carma.atlassian.net/browse/MAP-88) ## Motivation and Context <!--- Why is this change required? What problem does it solve? --> ## How Has This Been Tested? <!--- Please describe in detail how you tested your changes. --> <!--- Include details of your testing environment, and the tests you ran to --> <!--- see how your change affects other areas of the code, etc. --> ## Types of changes <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Defect fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that cause existing functionality to change) ## Checklist: <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [ ] I have added any new packages to the sonar-scanner.properties file - [ ] My change requires a change to the documentation. - [ ] I have updated the documentation accordingly. - [ ] I have read the [**CONTRIBUTING**](https://github.com/usdot-fhwa-stol/carma-platform/blob/develop/Contributing.md) document. - [ ] I have added tests to cover my changes. - [ ] All new and existing tests passed.
- Loading branch information
Showing
101 changed files
with
8,548 additions
and
435 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,3 +26,4 @@ target/ | |
| .classpath | ||
| .vscode/ | ||
| root.war | ||
| private-resources.war | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| Bing Maps API Key Guidance | ||
| ---------------------------- | ||
|
|
||
| **NOTE: Bing Maps is now deprectated. We will be migrating to a different map provider.** | ||
|
|
||
| The current version of the MAP Creation Tool uses Bing Maps for its base map. An API key must be generated by each individual user if a personal deployment of the tool is desired. By default, we recommend securing your API keys according to the official instructions on [Enhanced Security for Bing Maps API Keys](https://blogs.bing.com/maps/2018-05/Announcing-Enhanced-Security-for-Bing-Maps-API-Keys). Enabling security will ensure no bad actors will be able to abuse the use of your personal API keys. | ||
|
|
||
| In case the tool will not be publically available, the security feature does not need to be enabled. However, it is still recommended to periodically check the usage of your keys. | ||
|
|
||
| ### **Getting a Bing Maps API Key** | ||
|
|
||
| An account with Bing Maps can be created using the [Bing Maps Portal](https://www.bingmapsportal.com/). After an account is created, you may follow the official instructions on [Creating a Bing Maps Key](https://learn.microsoft.com/en-us/bingmaps/getting-started/bing-maps-dev-center-help/getting-a-bing-maps-key). | ||
|
|
||
| ### **Using your API Key** | ||
|
|
||
| Once a key is obtained, please insert your key and any arbitrary username in the [ISDcreator-webapp-keys](/private-resources/js/ISDcreator-webapp-keys.js) file and build your updated ConnectedVCS Tools using either the [Local](/docs/Local_Instructions.md) or [Docker](/docs/Docker_Instructions.md) build instructions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| # 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](https://releases.ubuntu.com/). | ||
|
|
||
| ### 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 | ||
| ``` | ||
| 2. Note: Placeholder for map API key generation. | ||
|
|
||
| 3. Enter a map API key and username in [ISDcreator-webapp-keys](/private-resources/js/ISDcreator-webapp-keys.js) | ||
| and API key in [application.properties](/fedgov-cv-map-services-proxy/src/main/resources/application.properties#L2). | ||
|
|
||
| 4. Create a new Google Maps API Key using the [Google Maps Platform](https://developers.google.com/maps/documentation/javascript/get-api-key#create-api-keys). | ||
| - Please read the [Google Maps API Key Guidance](/docs/GoogleMaps_API_Key_Guidance.md). | ||
| 5. Enter your key to the end of the Geocomplete src link (indicated by "google.map.api.key") at the [application.properties](/fedgov-cv-map-services-proxy/src/main/resources/application.properties#L1) | ||
|
|
||
| 6. 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: | ||
| - with SSL: https://127.0.0.1:443/ | ||
| - without SSL: http://127.0.0.1:8080/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| Google Maps API Key Guidance | ||
| ---------------------------- | ||
|
|
||
| The current version of the MAP Creation Tool uses Google Maps for the Places Autocomplete plugin. This plugin allows a user to input an address in the searchbar at the top of the MAP Creation Tool page and autonavigate to the address. To enable the plugin, an API key must be generated by each individual user if a personal deployment of the tool is desired. By default, we recommend securing your API keys according to the official instructions on [Google Maps Platform security guidance](https://developers.google.com/maps/api-security-best-practices#restricting-api-keys). Enabling security will ensure no bad actors will be able to abuse the use of your personal API keys. | ||
|
|
||
| In case the tool will not be publically available, the security feature does not need to be enabled. However, it is still recommended to periodically check the usage of your keys. | ||
|
|
||
| ### **Getting a Google Maps API Key** | ||
|
|
||
| An account with Google Maps and an API Key can be created using the [Google Maps Platform](https://developers.google.com/maps/documentation/javascript/get-api-key#create-api-keys). | ||
|
|
||
| ### **Using your API Key** | ||
|
|
||
| Once a key is obtained, please insert your key to the end of the Geocomplete src link (indicated by "YOUR_API_KEY") at the [index.html](/fedgov-cv-ISDcreator-webapp/src/main/webapp/index.html) file and build your updated ConnectedVCS Tools using either the [Local](/docs/Local_Instructions.md) or [Docker](/docs/Docker_Instructions.md) build instructions. |
Oops, something went wrong.