diff --git a/README.md b/README.md index cebe3dd..9268913 100644 --- a/README.md +++ b/README.md @@ -110,7 +110,7 @@ To start using OSINTBuddy, follow these simple installation steps: cd osintbuddy ``` -2. Install Docker +2. Install Docker & Compose - [Install Guide for Mac](https://docs.docker.com/desktop/install/mac-install/) - [Install Guide for Windows](https://docs.docker.com/desktop/install/windows-install/) - [Install Guide for Linux](https://docs.docker.com/desktop/install/linux-install/) diff --git a/launcher b/launcher index b30c94c..b035ea5 100755 --- a/launcher +++ b/launcher @@ -45,13 +45,13 @@ usage () { echo -e " $(c YsB)build$(c): Build the OSINTBuddy app (or a specific container ./launcher build ui)." echo -e " $(c YsB)restart$(c): Restart the app (or a specific container: ./launcher restart janus)." echo -e " $(c YsB)api:gen$(c): Generate API client SDK from the backend OpenAPI spec; launch the UI outside of the container" - echo -e " $(c YsB)setup:dev$(c): Create python venv and install dev dependencies" + echo -e " $(c YsB)setup:dev$(c): Create python3 venv and install dev dependencies" echo -e " $(c YsB)bootstrap$(c): Initialize and download dependencies and check for environment misconfigurations" echo -e " $(c YsB)debug:send$(c): Upload all logs to https://paste.c-net.org for help with debugging" echo -e " $(c YsB)cleanup$(c): Remove docker volumes." echo -e " $(c YsB)exec$(c): Execute commands for a container." echo -e " $(c YsB)migrate$(c): Generate a migration." - echo -e " $(c YsB)python$(c): Open a python shell on the backend." + echo -e " $(c YsB)python$(c): Open a python3 shell on the backend." echo -e " $(c YsB)ui$(c): Stop the UI container and launch the frontend locally." echo -e " $(c YsB)kill$(c): Kill containers; down the stack." echo -e " $(c YsB)containers$(c): List the names you can access the containers by" diff --git a/ob/cmd/bootstrap b/ob/cmd/bootstrap index 47c6c41..0a2546b 100755 --- a/ob/cmd/bootstrap +++ b/ob/cmd/bootstrap @@ -120,13 +120,20 @@ check_prereqs() { exit 1 fi - # 3. running recommended node version + # 3. has node and running recommended node version + if [ -z "$(which node)" ]; then + warning "Node environment not detected! We recommend installing Node 18.18.2 for this project." + warning "Some ./launcher commands may not work without a node environment." + heading "Attempting to start the OSINTBuddy stack without Node." + fi + test=($(node --version)) test=${test[0]//v/} # Get version alone and strip the prefixed v + + if compare_version "${node_min_version}" "${test}"; then - echo "ERROR: Node version ${test} not supported, please upgrade to at least ${node_min_version}, or recommended ${node_rec_version}" - exit 1 + echo "WARNING: Node version ${test} not supported, please upgrade to at least ${node_min_version}, or recommended ${node_rec_version}" fi # Recommend best Node version @@ -135,12 +142,11 @@ check_prereqs() { fi # 4. running recommended Python version - test=($(python --version)) + test=($(python3 --version)) test=${test[1]///} # Get version alone and strip the prefixed v if compare_version "${python_min_version}" "${test}"; then - echo "ERROR: Python version ${test} not supported, please upgrade to at least ${python_min_version}, or recommended ${python_rec_version}" - exit 1 + warning "WARNING: Python version ${test} not supported, please upgrade to at least ${python_min_version}, or recommended ${python_rec_version}" fi # Recommend best Python version