Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

#171 issue : Update script.sh #175

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

#171 issue : Update script.sh #175

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23eab1a
Merge pull request #170 from camicroscope/develop
birm May 2, 2024
a39ce38
#171 issue : Update script.sh
AllMightLegend Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
151 changes: 64 additions & 87 deletions setup_script.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,182 +1,159 @@
#!/bin/bash

###
## ensure that required params are passed into script
## Ensure that required parameters are passed into the script
###
if [ -n "$1" ]; then
HOST=$1
else
echo "[ database ] : name not passed, set to default value (127.0.0.1)"
echo "[ database ] : Host not passed, set to default value (127.0.0.1)"
HOST="127.0.0.1"
fi

###
## specify which database to operate on, if not specified, set default to camic
## Specify which database to operate on, if not specified, set default to camic
###
if [ -n "$2" ]; then
DB_NAME=$2
echo "[ database ] : name set as ${DB_NAME}"
echo "[ database ] : Database name set as ${DB_NAME}"
else
echo "[ database ] : name not passed, set to default value (camic)"
echo "[ database ] : Database name not passed, set to default value (camic)"
DB_NAME="camic"
fi

###
## check if the system has required services installed
## Check if the system has required services installed
###
if command -v "mongo" &>/dev/null; then
MONGO="mongo"
elif command -v "mongosh" &>/dev/null; then
MONGO="mongosh"
else
echo "mongo or mongo could not be found on path. Please ensure that mongo is installed and is on PATH"
echo "Neither mongo nor mongosh could be found. Please ensure that MongoDB is installed and available in the PATH."
exit 1
fi

if ! command -v "node" &>/dev/null; then
echo "node could not be found on path. Please ensure that node is installed and is on PATH"
exit
echo "Node.js could not be found on path. Please ensure that Node.js is installed and is on PATH."
exit 1
fi

###
# check for the existence of required files in the Distro and camicroscope repository
# Check for the existence of required files in the caracal repository
###
echo "Checking for required files"

#if [[ ! -d ../Distro/db ]]
#then echo "../Distro/db does not exist"
# exit
#fi
echo "Checking for required files..."

if [[ ! -d ../Distro/config ]]
then echo "../Distro/config does not exist"
exit
if [[ ! -d ../caracal/config ]]; then
echo "../caracal/config does not exist"
exit 1
fi

if [[ ! -d ../Distro/jwt_keys ]]
then echo "../Distro/jwt_keys does not exist"
exit
if [[ ! -d ../caracal/jwt_keys ]]; then
echo "../caracal/jwt_keys does not exist"
exit 1
Comment on lines +46 to +53
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you've misunderstood this context. This assumes you're deploying the caMicroscope stack without docker. So we assume you have relevant config from Distro.

This could be made more independent by copying/renaming the required files (e.g. make an empty jwt_keys dir, copy routes.json from an example, etc)

I'm not sure how useful this is in practice; I'm not aware of anyone deploying caracal this way currently.

Please let me know if you want help with this.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be grateful if you help me a bit.I am new to open source contribution so I would appreciate your help very much

fi

if [[ ! -d ../caMicroscope ]]
then echo "../caMicroscope does not exist"
exit
if [[ ! -d ../caMicroscope ]]; then
echo "../caMicroscope does not exist"
exit 1
fi

echo "Required files exist."

echo "Copying files..."
echo "Copying files..."

#if [[ ! -d ../data ]]
#then
# mkdir ../data
# cp -r ../Distro/db ../data/
#fi

if [[ ! -d ../config ]]
then
if [[ ! -d ../config ]]; then
mkdir ../config
cp -r ../Distro/config ../config/
cp -r ../caracal/config ../config/
fi

if [[ ! -d ./static ]]
then
if [[ ! -d ./static ]]; then
mkdir ./static
cp ../Distro/config/login.html ./static/login.html
cp ../caracal/config/login.html ./static/login.html
fi

if [[ ! -d ./keys/jwt_keys ]]
then
cp -r ../Distro/jwt_keys ./keys/
if [[ ! -d ./keys/jwt_keys ]]; then
cp -r ../caracal/jwt_keys ./keys/
fi

if [[ ! -f ./contentSecurityPolicy.json ]]
then
cp ../Distro/config/contentSecurityPolicy.json ./contentSecurityPolicy.json
if [[ ! -f ./contentSecurityPolicy.json ]]; then
cp ../caracal/config/contentSecurityPolicy.json ./contentSecurityPolicy.json
fi

if [[ ! -f ./static/additional_links.json ]]
then
cp ../Distro/config/additional_links.json ./static/additional_links.json
if [[ ! -f ./static/additional_links.json ]]; then
cp ../caracal/config/additional_links.json ./static/additional_links.json
fi

if [[ ! -d ./camicroscope ]]
then
if [[ ! -d ./camicroscope ]]; then
cp -r ../caMicroscope ./camicroscope
fi

echo "Copying files complete!"




###
## try connecting to mongodb instance
## Try connecting to MongoDB instance
###
until $MONGO --host "${HOST}" --eval "print(\"Connected!\")" >/dev/null; do
sleep 2
done
echo "[ database ] : connection established"
echo "[ database ] : Connection established"

###
## check if database exists
## Check if the database exists
###
QUERY="db.getMongo().getDBNames().indexOf(\"${DB_NAME}\")"
COMMAND="${MONGO} ${HOST} --eval '${QUERY}' --quiet"
if [ $(${MONGO} ${HOST} --eval ${QUERY} --quiet) -lt 0 ]; then
echo "[ database ] : does not exist"
if [ $(${MONGO} --host "${HOST}" --eval "${QUERY}" --quiet) -lt 0 ]; then
echo "[ database ] : Database does not exist"
exit 1
else
echo "[ database ] : database named ${DB_NAME} found"
echo "[ database ] : Database named ${DB_NAME} found"
fi

###
## ask developer if they wish to seed the database
## Ask developer if they wish to seed the database
###
read -p "[ resource ] : Do you wish to initialize the database with indexes and configs? (y/n) : " yn
case $yn in
[Yy]*)
###
## Download the files from github and save to local directory
## Download the files from GitHub and save to local directory
###
echo "[ resource ] : downloading seeding files"
echo "[ resource ] : Downloading seeding files"

# resource targets
# Resource targets
RESOURCE_IDX="https://raw.githubusercontent.com/camicroscope/Distro/master/config/mongo_idx.js"
RESOURCE_COLLECTION="https://raw.githubusercontent.com/camicroscope/Distro/master/config/mongo_collections.js"
RESOURCE_DEFAULT_DATA="https://raw.githubusercontent.com/camicroscope/Distro/master/config/default_data.js"

# get data from resource targets
wget -q RESOURCE_IDX -O .seeder.idx.js
wget -q RESOURCE_DEFAULT_DATA -O .seeder.default.js
wget -q RESOURCE_COLLECTION -O .seeder.collection.js
# Get data from resource targets
wget -q $RESOURCE_IDX -O .seeder.idx.js
wget -q $RESOURCE_DEFAULT_DATA -O .seeder.default.js
wget -q $RESOURCE_COLLECTION -O .seeder.collection.js

echo "[ resource ] : clearing old configurations"
echo "[ resource ] : seeding collections"
echo "[ resource ] : Clearing old configurations"
echo "[ resource ] : Seeding collections"
$MONGO --quiet --host $HOST $DB_NAME .seeder.collection.js
echo "[ resource ] : seeding indexes"
echo "[ resource ] : Seeding indexes"
$MONGO --quiet --host $HOST $DB_NAME .seeder.idx.js
echo "[ resource ] : seeding configurations"
echo "[ resource ] : Seeding configurations"
$MONGO --quiet --host $HOST $DB_NAME .seeder.default.js

###
## ask the user if they want to remove the seeding files
## Ask the user if they want to remove the seeding files
###
read -p "[ resource ] : Do you wish to keep the seeding files generated ? (y/n) :" yn
read -p "[ resource ] : Do you wish to keep the seeding files generated? (y/n) :" yn
case $yn in
[Yy]*) echo "[ resource ] : The seeder files are present in current directory with name : .seeder.*.js" ;;
[Yy]*) echo "[ resource ] : The seeder files are present in the current directory with the name: .seeder.*.js" ;;
[Nn]*) rm .seeder.* ;;
*) echo "[ resource ] : Please answer y/n." ;;
esac
;;
### seeder file cleanup ends here

[Nn]*) echo "[ resource ] : database initialization skipped" ;;
*) echo "[ resource ] : skipped" ;;
[Nn]*) echo "[ resource ] : Database initialization skipped" ;;
*) echo "[ resource ] : Skipped" ;;
esac
### seeder prompt ends here

###
## load the default routes.json file if it does not exist in the file system
## Load the default routes.json file if it does not exist in the file system
###
if [ -f "routes.json" ]; then
echo "[ routes ] : routes.json file already exists"
Expand All @@ -186,24 +163,24 @@ else
fi

if [ -f "keys/key" ] && [ -f "keys/key.pub" ]; then
echo "[ keys ] : public and private keys already exist"
echo "[ keys ] : Public and private keys already exist"
else
bash ./keys/make_key.sh
echo "[ routes ] : routes.json file generated from routes.json.example"
echo "[ keys ] : Key files generated"
fi

###
## install the packages if not done already
## Install the packages if not done already
###
if [ ! -d "node_modules" ]; then
echo "[ modules ] : packages not installed, running : npm install"
echo "[ modules ] : Packages not installed, running: npm install"
npm install
else
echo "[ modules ] : packages directory already exist, to reinstall, delete the node_modules folder and run npm install"
echo "[ modules ] : Packages directory already exists. To reinstall, delete the node_modules folder and run npm install"
fi

###
## initialize the environment variable configs
## Initialize the environment variable configs
###
if [ ! -f ".env" ]; then
echo "[ env ] : .env file not found"
Expand All @@ -213,4 +190,4 @@ else
fi

echo ""
echo "If you face issues due to permissions and login handlers, setting the DISABLE_SEC to false in .env file might help."
echo "If you face issues due to permissions and login handlers, setting the DISABLE_SEC to false in the .env file might help."