From 23be0ae336469c4dfa2ca0326b93104a0312ef8e Mon Sep 17 00:00:00 2001 From: dev Date: Tue, 30 Apr 2024 11:28:40 -0400 Subject: [PATCH] Added documentation for deployment --- configuration/README.md | 42 +++++++++++++++++++++++++++ configuration/amd64/initialization.sh | 1 + configuration/arm64/initialization.sh | 1 + 3 files changed, 44 insertions(+) create mode 100644 configuration/README.md diff --git a/configuration/README.md b/configuration/README.md new file mode 100644 index 000000000..507534b38 --- /dev/null +++ b/configuration/README.md @@ -0,0 +1,42 @@ +## Deployment Configuration +### Introduction +This directory contains deployment configurations for deploying V2X-Hub on both ARM64(arm64) and x86(amd64) architectures. +### Deployment Instructions +Once downloaded, navigate to the directory corresponding to your computer’s processor (1) or (2): +``` +cd ~/V2X-Hub/configuration/arm64/ +cd ~/V2X-Hub/configuration/amd64/ +``` +Run the initialization script: +``` +./initialization.sh +``` +Follow the prompts during installation. + +You will be prompted to create a mysql_password and mysql_root_password. You may make the passwords whatever you like, but you will need to remember them. +``` +Example: ivp +``` +You will also be prompted to create a V2X Hub username and password. You may make these whatever you’d like, but will need to use them to log into the web UI. Example: +``` +Username: v2xadmin + +Password: V2xHub#321 +``` +You will then need to enter the mysql_password you created in step 5a: +``` +Example: ivp +``` +After installation is complete, the script will automatically open a web browser with two tabs. + +Navigate to the tab labeled as “Privacy Error” and select the “Advanced” button. + +Click on “proceed to 127.0.0.1 (unsafe)” + +Note: This page will not do anything when clicking proceed + +Close the Privacy Error tab and wait for the initial V2X Hub tab to finish loading + +Enter the login credentials you created in step 5b and login. + +Installation complete! diff --git a/configuration/amd64/initialization.sh b/configuration/amd64/initialization.sh index eea35fc48..b24b9b4d3 100755 --- a/configuration/amd64/initialization.sh +++ b/configuration/amd64/initialization.sh @@ -35,6 +35,7 @@ else #remove endline characters from password files tr -d '\n' mysql_password.txt && rm sql_pass.txt fi +# TODO VH-1303 Allow for version and configuration selection in initialization script #AMD64 initialzation cd $directory diff --git a/configuration/arm64/initialization.sh b/configuration/arm64/initialization.sh index 7769004df..b4da293b7 100755 --- a/configuration/arm64/initialization.sh +++ b/configuration/arm64/initialization.sh @@ -35,6 +35,7 @@ else #remove endline characters from password files tr -d '\n' mysql_password.txt && rm sql_pass.txt fi +# TODO VH-1303 Allow for version and configuration selection in initialization script #ARM initialization cd $directory