refactor to aio and add all env variables prompt

docker-compose/aio/advanced.md

@@ -0,0 +1,46 @@
+# Advanced operations 
+
+## Restarting containers 
+There are atleast 4 main containers which are running as part of this installation through same docker-compose. The same docker-compose can be leveraged to restart any or all of these containers. 
+
+Use below command to restart all containers\ 
+``` docker compose restart ```
+
+To restart individual containers with name ( names:  nocodb, nginx, postgres, redis)\
+ex: to restart nginx\
+``` docker compose restart nginx ```
+
+## reload nginx 
+use utility script at [./bin/nginx_reload.sh](./bin/nginx_reload.sh)
+
+## Upgrade nocodb instance 
+
+## Enable SSL
+To enable SSL for incoming https requests, nginx should be configured with combination of a public certificate and a private key. The SSL private key is kept secret on the server. It will be used to encrypt content sent to clients. 
+Below are different approaches to get and configure certificates. Make your choice
+### letsencrypt for generating certificates 
+Certificates/key can be obtained by trusted CA (Certificate Authorities), there are many paid vendors found online or you can also use [letsencrypt](https://letsencrypt.org/) a non profit certificate provider for free however we recommend [https://www.abetterinternet.org/donate/](donate) for their service. 
+
+### Bring your own certificates 
+If you already have the certificates, either self signed or generated by any other means, you will need to configure them with nginx. Below are the steps
+TBD
+### self signed certificates 
+One of the pre-requisite is that your server should be associated with the domain name. In the absence of that you could use self signed certificates which does ecrypt but browsers show warning.
+
+## Database password rotation 
+As a security measure, It is best practice to rotate the database credentials periodically. Assuming you would have created new credentials in postgres database. The db credentials are persisted on filesystem as part of initial install and it will be available at 
+[./conf/nc_properties.env](./conf/nc_properties.env)\
+update properties POSTGRES_USER, POSTGRES_PASSWORD with new credentials and [restarting nocodb](#restarting-containers) with\
+```docker compose restart nocodb```
+
+## nginx configurations 
+There are two main directories where nginx configurations are maintained 
+- nocodb team managed configurations at [nginx/conf.d](./conf/nginx/conf.d).
+- self managed (you) [conf/nginx/conf.d](./conf/nginx/conf.d) 
+
+
+## Add Node 
+
+## Minio integration for resources
+
+## Enable scheduled backups to run nightly on all your instances.

docker-compose/aio/bin/nginx_reload.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+docker exec -it nginx /etc/init.d/nginx reload

docker-compose/aio/conf/nc_properties.env

@@ -0,0 +1,16 @@
+# Environment Variables
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=test123
+POSTGRES_DB=nocodb
+NC_REDIS_URL=redis://redis:6379/4
+NC_DB=pg://postgres:5432?u=postgres&password=${POSTGRES_PASSWORD:-nocodb}&d=postgres
+NC_PUBLIC_URL=rajanishs-MacBook-Pro.local
+NC_CONNECT_TO_EXTERNAL_DB_DISABLED=false
+NC_INVITE_ONLY_SIGNUP=false
+NC_ADMIN_EMAIL=false
+NC_ADMIN_PASSWORD=false
+NC_S3_BUCKET_NAME=asdf
+NC_S3_REGION=asd
+NC_S3_ACCESS_KEY=sda
+NC_S3_ACCESS_SECRET=adsfa
+

docker-compose/aio/docker-compose.yml

@@ -35,6 +35,11 @@ services:
       - ${NC_INSTALL_ROOT:-/opt/nocodb}/data/postgres:/var/lib/postgresql/data    
     networks:
       - nocodb-001
+    healthcheck: 
+      interval: 10s
+      retries: 10
+      test: "pg_isready -U ${POSTGRES_USER} -d ${POSTGRES_DB}"
+      timeout: 2s      
     deploy:
       resources:
         limits:

docker-compose/aio/prepare_env.sh

@@ -0,0 +1,70 @@
+#!/bin/bash
+# prepares env file with all the required env variables.
+# 
+
+# -- main line code starts here --
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+source ${SCRIPT_DIR}/sbin/util.sh
+source ${SCRIPT_DIR}/sbin/install_vars.sh
+
+ENV_FILE=${SCRIPT_DIR}/conf/nc_properties.env
+bkp_file=${ENV_FILE}-$(date +%s).bak
+# Source existing nc_envs.env file to get current values
+if [ -f ${ENV_FILE} ]; then
+    source ${ENV_FILE}
+    echo "backing up previous ${ENV_FILE} file to ${bkp_file}"
+    cp ${ENV_FILE} ${bkp_file}
+fi
+
+function acceptProperty(){
+    local varDetail="$1"
+    prompt=$(echo "$varDetail" | cut -d '|' -f1)    
+    prop=$(echo "$varDetail" | cut -d '|' -f2)
+    key=$(echo "$prop" | cut -d'=' -f1)
+    default_value="${prop#*=}"
+    prev_value_or_default=${!key:-${default_value}}
+
+    # echo prompt: ${prompt}
+    # echo prop: ${prop}
+    # echo key: ${key}
+    # echo default_value: ${default_value}
+    
+    read -p "Enter value for $key (default: ${prev_value_or_default}): " user_input
+
+    # Use user input or default value if empty
+    value=${user_input:-$prev_value_or_default}
+
+    # Store key-value pair in a variable
+    userValues="${userValues}${key}=${value}\n"
+}
+# Iterate over the properties array and prompt user for input
+echo basic_properties : "${basic_properties[@]}"
+for multi_property_array in basic_properties invite_only_signup_priorities google_login_properties email_properties s3_attachment_properties ; do
+    array_name="$multi_property_array[@]"  # Name of the array to process
+    array=("${!array_name}")  
+    # array=("${!multi_property_array}")   
+    echo array : "${array[@]}"
+    for varDetail in "${array[@]}"; do
+        echo varDetail : ${varDetail}
+        prompt=$(echo "$varDetail" | cut -d '|' -f1)    
+        prop=$(echo "$varDetail" | cut -d '|' -f2)
+        if [[ ${prompt} == "main" ]]
+        then
+            echo $prop
+            if asksure; then 
+                continue
+            else
+                break
+            fi
+        fi   
+        acceptProperty "${varDetail}"
+    done
+done
+
+# Write key-value pairs to nc_envs.env file
+echo -e "# Environment Variables\n$userValues" > ${ENV_FILE}
+
+echo "Environment variables written to ${ENV_FILE} file."
+
+# echo "creating data conf, data and log directories"
+# mkdir -p ${INSTALL_ROOT}/conf ${INSTALL_ROOT}/data ${INSTALL_ROOT}/logs

docker-compose/aio/sbin/install_vars.sh

@@ -0,0 +1,15 @@
+nocodb_install_version="1.0.0"  # Replace with actual version
+REQUIRED_PORTS=(80 443)
+DOCKER_IMAGES=("redis:latest" "postgres:14.7" "nocodb/nocodb:latest" "nginx" "certbot/certbot:latest" )
+
+# Array of properties with default values
+basic_properties=("main|basic configurations, customise ?" "Username for postgres database|POSTGRES_USER=postgres" "|POSTGRES_PASSWORD=test123" "|POSTGRES_DB=nocodb" "|NC_REDIS_URL=redis://redis:6379/4" '|NC_DB=pg://postgres:5432?u=postgres&password=${POSTGRES_PASSWORD:-nocodb}&d=postgres' "Are you using custom DNS, configure NC_PUBLIC_URL to reflect in the invite emails?|NC_PUBLIC_URL=$(hostname)" "Disable connecting to external db?|NC_CONNECT_TO_EXTERNAL_DB_DISABLED=false")
+invite_only_signup_priorities=("main|Allow invite only sign-up" "invite only signup?|NC_INVITE_ONLY_SIGNUP=false" "|NC_ADMIN_EMAIL=false" "|NC_ADMIN_PASSWORD=false")
+google_login_properties=("main|Configure google login" "Enter Client ID|NC_GOOGLE_CLIENT_ID=" "Enter Client ID|NC_GOOGLE_CLIENT_SECRET=")
+email_properties=("main|Configure smtp properties" "|NC_SMTP_FROM=" "|NC_SMTP_HOST=" "|NC_SMTP_PORT="  "|NC_SMTP_USERNAME="  "|NC_SMTP_PASSWORD="  "|NC_SMTP_SECURE="  "|NC_SMTP_IGNORE_TLS=" )
+s3_attachment_properties=("main|Do you want to configure s3 for attachements?" "|NC_S3_BUCKET_NAME=nocodb-attachements" "|NC_S3_REGION=" "|NC_S3_ACCESS_KEY=" "|NC_S3_ACCESS_SECRET=" )
+
+multi_property_array=(basic_properties invite_only_signup_priorities google_login_properties email_properties s3_attachment_properties)
+
+
+

docker-compose/full-install/advanced.md

@@ -1,23 +0,0 @@
-# Advanced operations 
-
-
-## Restarting containers 
-
-## Upgrade nocodb instance 
-
-## Enable SSL
-In order to enable SSL for incoming https requests, you will need to have certs which is
-private-key public-key pair
-### letsencrypt for generating certificates 
-### Bring your own certificates 
-### self signed certificates 
-
-## Database pasword rotation 
-
-## nginx configurations 
-
-## Add Node 
-
-## Minio integration for resources
-
-## Enable scheduled backups to run nightly on all your instances.

docker-compose/full-install/bin/nginx_reload.sh

@@ -1 +0,0 @@
-docker exec -it nginx /etc/init.d/nginx reload

docker-compose/full-install/prepare_env.sh

@@ -1,41 +0,0 @@
-#!/bin/bash
-# prepares env file with all the required env variables.
-# 
-
-# -- main line code starts here --
-SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
-source ${SCRIPT_DIR}/sbin/util.sh
-source ${SCRIPT_DIR}/sbin/install_vars.sh
-
-ENV_FILE=${SCRIPT_DIR}/conf/nc_properties.env
-bkp_file=${ENV_FILE}-$(date +%s).bak
-# Source existing nc_envs.env file to get current values
-if [ -f ${ENV_FILE} ]; then
-    source ${ENV_FILE}
-    echo "backing up previous ${ENV_FILE} file to ${bkp_file}"
-    cp ${ENV_FILE} ${bkp_file}
-fi
-
-echo "Update or confirm the values to be set"
-# Iterate over the properties array and prompt user for input
-for prop in "${properties[@]}"; do
-    key=$(echo "$prop" | cut -d'=' -f1)
-    default_value="${prop#*=}"
-    prev_value_or_default=${!key:-${default_value}}
-    
-    read -p "Enter value for $key (default: ${prev_value_or_default}): " user_input
-
-    # Use user input or default value if empty
-    value=${user_input:-$prev_value_or_default}
-
-    # Store key-value pair in a variable
-    userValues="${userValues}${key}=${value}\n"
-done
-
-# Write key-value pairs to nc_envs.env file
-echo -e "# Environment Variables\n$userValues" > ${ENV_FILE}
-
-echo "Environment variables written to ${ENV_FILE} file."
-
-echo "creating data conf, data and log directories"
-mkdir -p ${INSTALL_ROOT}/conf ${INSTALL_ROOT}/data ${INSTALL_ROOT}/logs

docker-compose/full-install/sbin/install_vars.sh

@@ -1,7 +0,0 @@
-nocodb_install_version="1.0.0"  # Replace with actual version
-REQUIRED_PORTS=(80 443)
-DOCKER_IMAGES=("redis:latest" "postgres:14.7" "nocodb/nocodb:latest" "nginx" "certbot/certbot:latest" )
-
-# Array of properties with default values
-properties=( "POSTGRES_USER=postgres" "POSTGRES_PASSWORD=test123" "POSTGRES_DB=nocodb" "NC_REDIS_URL=redis://redis:6379/4" 'NC_DB=pg://postgres:5432?u=postgres&password=${POSTGRES_PASSWORD:-nocodb}&d=postgres' )
-# "NC_INSTALL_ROOT=${SCRIPT_DIR}" "MINIO_ROOT_USER=minioadmin" "MINIO_ROOT_PASSWORD=minioadmin"