Merge pull request #7612 from nocodb/chore/bash-script-for-gen-docker-compose

NocoDB docker-compose init script
9 months ago · f1a013e82d
1 changed files with 512 additions and 0 deletions
--- a/docker-compose/setup-script/noco.sh
+++ b/docker-compose/setup-script/noco.sh
@ -0,0 +1,512 @@
+#!/bin/bash
+# set -x
+
+# ******************************************************************************
+# *****************    HELPER FUNCTIONS START  *********************************
+
+# Function to URL encode special characters in a string
+urlencode() {
+  local string="$1"
+  local strlen=${#string}
+  local encoded=""
+  local pos c o
+
+  for (( pos=0 ; pos<strlen ; pos++ )); do
+    c=${string:$pos:1}
+    case "$c" in
+      [-_.~a-zA-Z0-9] ) o="$c" ;;
+      * )               printf -v o '%%%02X' "'$c"
+    esac
+    encoded+="$o"
+  done
+  echo "$encoded"
+}
+
+# function to print a message in a box
+print_box_message() {
+    message=("$@")  # Store all arguments in the array "message"
+    edge="======================================"
+    padding="  "
+
+    echo "$edge"
+    for element in "${message[@]}"; do
+        echo "${padding}${element}"
+    done
+    echo "$edge"
+}
+
+# check command exists
+command_exists() {
+  command -v "$1" >/dev/null 2>&1
+}
+
+# install package based on platform
+install_package() {
+  if command_exists yum; then
+    sudo yum install -y "$1"
+  elif command_exists apt; then
+    sudo apt install -y "$1"
+  elif command_exists brew; then
+    brew install "$1"
+  else
+    echo "Package manager not found. Please install $1 manually."
+  fi
+}
+
+# Function to check if sudo is required for Docker Compose command
+check_for_docker_compose_sudo() {
+    if docker-compose ps >/dev/null 2>&1; then
+        echo "n"
+    else
+        echo "y"
+    fi
+}
+
+# *****************    HELPER FUNCTIONS END  ***********************************
+# ******************************************************************************
+
+
+
+# ******************************************************************************
+# ******************** SYSTEM REQUIREMENTS CHECK START  *************************
+
+# Check if the following requirements are met:
+# a. docker, docker-compose, jq installed
+# b. port mapping check : 80,443 are free or being used by nginx container
+
+REQUIRED_PORTS=(80 443)
+
+echo "** Performing nocodb system check and setup. This step may require sudo permissions"
+
+# pre install wget if not found
+if ! command_exists wget; then
+  echo "wget is not installed. Setting up for installation..."
+  install_package wget
+fi
+
+# d. Check if required tools are installed
+echo " | Checking if required tools (docker, docker-compose, lsof) are installed..."
+for tool in docker docker-compose lsof openssl; do
+  if ! command_exists "$tool"; then
+    echo "$tool is not installed. Setting up for installation..."
+    if [ "$tool" = "docker-compose" ]; then
+      sudo -E curl -L https://github.com/docker/compose/releases/download/1.29.0/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
+      sudo chmod +x /usr/local/bin/docker-compose
+    elif [ "$tool" = "docker" ]; then
+      wget -qO- https://get.docker.com/ | sh
+    elif [ "$tool" = "lsof" ]; then
+         install_package lsof
+    fi
+  fi
+done
+
+# e. Check if NocoDB is already installed and its expected version
+# echo "Checking if NocoDB is already installed and its expected version..."
+# Replace the following command with the actual command to check NocoDB installation and version
+# Example: nocodb_version=$(command_to_get_nocodb_version)
+# echo "NocoDB version: $nocodb_install_version"
+
+# f. Port mapping check
+echo " | Checking port accessibility..."
+for port in "${REQUIRED_PORTS[@]}"; do
+  if lsof -Pi :$port -sTCP:LISTEN -t >/dev/null; then
+    echo " | WARNING: Port $port is in use. Please make sure it is free." >&2
+  else
+    echo " | Port $port is free."
+  fi
+done
+
+echo "** System check completed successfully. **"
+
+
+# Define an array to store the messages to be printed at the end
+message_arr=()
+
+# extract public ip address
+PUBLIC_IP=$(dig +short myip.opendns.com @resolver1.opendns.com)
+
+# generate a folder for the docker-compose file which is not existing and do the setup within the folder
+# Define the folder name
+FOLDER_NAME="nocodb_$(date +"%Y%m%d_%H%M%S")"
+
+# prompt for custom folder name and if left empty skip
+#echo "Enter a custom folder name or press Enter to use the default folder name ($FOLDER_NAME): "
+#read CUSTOM_FOLDER_NAME
+
+message_arr+=("Setup folder: $FOLDER_NAME")
+
+if [ -n "$CUSTOM_FOLDER_NAME" ]; then
+    FOLDER_NAME="$CUSTOM_FOLDER_NAME"
+fi
+
+
+# Create the folder
+mkdir -p "$FOLDER_NAME"
+
+# Navigate into the folder
+cd "$FOLDER_NAME" || exit
+
+# ******************** SYSTEM REQUIREMENTS CHECK END  **************************
+# ******************************************************************************
+
+
+
+# ******************** INPUTS FROM USER START  ********************************
+# ******************************************************************************
+
+echo "Choose Community or Enterprise Edition [CE/EE] (default: CE): "
+read EDITION
+
+echo "Do you want to configure SSL [Y/N] (default: N): "
+read SSL_ENABLED
+
+
+if [ -n "$SSL_ENABLED" ] && { [ "$SSL_ENABLED" = "Y" ] || [ "$SSL_ENABLED" = "y" ]; }; then
+    SSL_ENABLED='y'
+    echo "Enter the domain name for the SSL certificate: "
+    read DOMAIN_NAME
+    if [ -z "$DOMAIN_NAME" ]; then
+        echo "Domain name is required for SSL configuration"
+        exit 1
+    fi
+    message_arr+=("Domain: $DOMAIN_NAME")
+else
+    #  prompt for ip address and if left empty use extracted public ip
+    echo "Enter the IP address or domain name for the NocoDB instance (default: $PUBLIC_IP): "
+    read DOMAIN_NAME
+    if [ -z "$DOMAIN_NAME" ]; then
+        DOMAIN_NAME="$PUBLIC_IP"
+    fi
+fi
+
+if [ -n "$EDITION" ] && { [ "$EDITION" = "EE" ] || [ "$EDITION" = "ee" ]; }; then
+    echo "Enter the NocoDB license key: "
+    read LICENSE_KEY
+    if [ -z "$LICENSE_KEY" ]; then
+        echo "License key is required for Enterprise Edition installation"
+        exit 1
+    fi
+fi
+
+echo "Do you want to enabled Watchtower for automatic updates [Y/N] (default: Y): "
+read WATCHTOWER_ENABLED
+
+if [ -z "$WATCHTOWER_ENABLED" ] || { [ "$WATCHTOWER_ENABLED" != "N" ] && [ "$WATCHTOWER_ENABLED" != "n" ]; }; then
+    message_arr+=("Watchtower: Enabled")
+else
+    message_arr+=("Watchtower: Disabled")
+fi
+
+
+# ******************************************************************************
+# *********************** INPUTS FROM USER END  ********************************
+
+
+# ******************************************************************************
+# *************************** SETUP START  *************************************
+
+# Generate a strong random password for PostgreSQL
+STRONG_PASSWORD=$(openssl rand -base64 48 | tr -dc 'a-zA-Z0-9!@#$%^&*()-_+=' | head -c 32)
+# Encode special characters in the password for JDBC URL usage
+ENCODED_PASSWORD=$(urlencode "$STRONG_PASSWORD")
+
+IMAGE="nocodb/nocodb:latest";
+
+# Determine the Docker image to use based on the edition
+if [ -n "$EDITION" ] && { [ "$EDITION" = "EE" ] || [ "$EDITION" = "ee" ]; }; then
+  IMAGE="nocodb/nocodb-ee:latest"
+  DATABASE_URL="DATABASE_URL=postgres://postgres:${ENCODED_PASSWORD}@db:5432/nocodb"
+
+  # read SMTP details
+  echo "Enter the SMTP from email address: "
+  read NC_SMTP_FROM
+
+  echo "Enter the SMTP host: "
+  read NC_SMTP_HOST
+
+  echo "Enter the SMTP port: "
+  read NC_SMTP_PORT
+
+  echo "Enter the SMTP username: "
+  read NC_SMTP_USERNAME
+
+  echo "Enter the SMTP password: "
+  read NC_SMTP_PASSWORD
+
+  echo "Enter the SMTP secure [Y/N] (default: N):"
+  read NC_SMTP_SECURE
+
+  echo "Enter the SMTP ignoreTLS [Y/N] (default: N):"
+  read NC_SMTP_IGNORE_TLS
+
+  # if yes then convert it to true
+  if [ -n "$NC_SMTP_SECURE" ] && { [ "$NC_SMTP_SECURE" = "Y" ] || [ "$NC_SMTP_SECURE" = "y" ]; }; then
+    NC_SMTP_SECURE='true'
+  else
+    NC_SMTP_SECURE='false'
+  fi
+
+  if [ -n "$NC_SMTP_IGNORE_TLS" ] && { [ "$NC_SMTP_IGNORE_TLS" = "Y" ] || [ "$NC_SMTP_IGNORE_TLS" = "y" ]; }; then
+    NC_SMTP_IGNORE_TLS='true'
+  else
+    NC_SMTP_IGNORE_TLS='false'
+  fi
+
+else
+  # use NC_DB url until the issue with DATABASE_URL is resolved(encoding)
+  DATABASE_URL="NC_DB=pg://db:5432?d=nocodb&user=postgres&password=${ENCODED_PASSWORD}"
+fi
+
+
+message_arr+=("Docker image: $IMAGE")
+
+# Write the Docker Compose file with the updated password
+cat <<EOF > docker-compose.yml
+version: '3'
+
+services:
+  nocodb:
+    image: ${IMAGE}
+    env_file: docker.env
+    depends_on:
+      - db
+    restart: unless-stopped
+    volumes:
+      - ./nocodb:/usr/app/data
+    labels:
+      - "com.centurylinklabs.watchtower.enable=true"
+  db:
+    image: postgres:16.1
+    env_file: docker.env
+    volumes:
+      - ./postgres:/var/lib/postgresql/data
+    restart: unless-stopped
+    healthcheck:
+      interval: 10s
+      retries: 10
+      test: "pg_isready -U \"$$POSTGRES_USER\" -d \"$$POSTGRES_DB\""
+      timeout: 2s
+
+  nginx:
+    image: nginx:latest
+    volumes:
+      - ./nginx:/etc/nginx/conf.d
+EOF
+
+if [ "$SSL_ENABLED" = 'y' ] || [ "$SSL_ENABLED" = 'Y' ]; then
+    cat <<EOF >> docker-compose.yml
+      - webroot:/var/www/certbot
+      - ./letsencrypt:/etc/letsencrypt
+      - letsencrypt-lib:/var/lib/letsencrypt
+EOF
+fi
+cat <<EOF >> docker-compose.yml
+    ports:
+      - "80:80"
+      - "443:443"
+    depends_on:
+      - nocodb
+    restart: unless-stopped
+EOF
+
+if [ "$SSL_ENABLED" = 'y' ] || [ "$SSL_ENABLED" = 'Y' ]; then
+    cat <<EOF >> docker-compose.yml
+  certbot:
+    image: certbot/certbot
+    volumes:
+      - ./letsencrypt:/etc/letsencrypt
+      - letsencrypt-lib:/var/lib/letsencrypt
+      - webroot:/var/www/certbot
+    entrypoint: "/bin/sh -c 'trap exit TERM; while :; do certbot renew; sleep 12h & wait \$\${!}; done;'"
+    depends_on:
+      - nginx
+    restart: unless-stopped
+EOF
+fi
+
+if [ -z "$WATCHTOWER_ENABLED" ] || { [ "$WATCHTOWER_ENABLED" != "N" ] && [ "$WATCHTOWER_ENABLED" != "n" ]; }; then
+cat <<EOF >> docker-compose.yml
+  watchtower:
+    image: containrrr/watchtower
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock
+    command: --schedule "0 2 * * 6" --cleanup
+    restart: unless-stopped
+EOF
+fi
+
+if [ "$SSL_ENABLED" = 'y' ] || [ "$SSL_ENABLED" = 'Y' ]; then
+    cat <<EOF >> docker-compose.yml
+volumes:
+  letsencrypt-lib:
+  webroot:
+EOF
+fi
+
+# Write the docker.env file
+cat <<EOF > docker.env
+POSTGRES_DB=nocodb
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=${STRONG_PASSWORD}
+$DATABASE_URL
+NC_LICENSE_KEY=${LICENSE_KEY}
+EOF
+
+# if EE then add the SMTP configuration
+if [ "$EDITION" = 'ee' ] || [ "$EDITION" = 'EE' ]; then
+  cat <<EOF >> docker.env
+NC_SMTP_HOST=${NC_SMTP_HOST}
+NC_SMTP_PORT=${NC_SMTP_PORT}
+NC_SMTP_USERNAME=${NC_SMTP_USERNAME}
+NC_SMTP_PASSWORD=${NC_SMTP_PASSWORD}
+NC_SMTP_SECURE=${NC_SMTP_SECURE}
+NC_SMTP_IGNORE_TLS=${NC_SMTP_IGNORE_TLS}
+EOF
+fi
+
+mkdir -p ./nginx
+
+# Create nginx config with the provided domain name
+cat > ./nginx/default.conf <<EOF
+server {
+    listen 80;
+EOF
+
+if [ "$SSL_ENABLED" = 'y' ] || [ "$SSL_ENABLED" = 'Y' ]; then
+cat >> ./nginx/default.conf <<EOF
+    server_name $DOMAIN_NAME;
+EOF
+fi
+
+cat >> ./nginx/default.conf <<EOF
+    location / {
+        proxy_pass http://nocodb:8080;
+        proxy_set_header Host \$host;
+        proxy_set_header X-Real-IP \$remote_addr;
+        proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto \$scheme;
+    }
+EOF
+
+if [ "$SSL_ENABLED" = 'y' ] || [ "$SSL_ENABLED" = 'Y' ]; then
+cat >> ./nginx/default.conf <<EOF
+    location /.well-known/acme-challenge/ {
+        root /var/www/certbot;
+    }
+EOF
+fi
+cat >> ./nginx/default.conf <<EOF
+}
+EOF
+
+if [ "$SSL_ENABLED" = 'y' ] || [ "$SSL_ENABLED" = 'Y' ]; then
+
+mkdir -p ./nginx-post-config
+
+# Create nginx config with the provided domain name
+cat > ./nginx-post-config/default.conf <<EOF
+server {
+    listen 80;
+    server_name $DOMAIN_NAME;
+
+    location / {
+        return 301 https://\$host\$request_uri;
+    }
+
+    location /.well-known/acme-challenge/ {
+        root /var/www/certbot;
+    }
+}
+
+
+server {
+    listen 443 ssl;
+    server_name $DOMAIN_NAME;
+
+    ssl_certificate /etc/letsencrypt/live/$DOMAIN_NAME/fullchain.pem;
+    ssl_certificate_key /etc/letsencrypt/live/$DOMAIN_NAME/privkey.pem;
+
+    location / {
+        proxy_pass http://nocodb:8080;
+        proxy_set_header Host \$host;
+        proxy_set_header X-Real-IP \$remote_addr;
+        proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto \$scheme;
+    }
+}
+
+EOF
+fi
+
+IS_DOCKER_COMPOSE_REQUIRE_SUDO=$(check_for_docker_compose_sudo)
+
+
+# Generate the update.sh file for upgrading images
+if [ "$IS_DOCKER_COMPOSE_REQUIRE_SUDO" = "y" ]; then
+  cat > ./update.sh <<EOF
+sudo docker-compose pull
+sudo docker-compose up -d --force-recreate
+sudo docker image prune -a -f
+EOF
+else
+  cat > ./update.sh <<EOF
+docker-compose pull
+docker-compose up -d --force-recreate
+docker image prune -a -f
+EOF
+fi
+
+
+message_arr+=("Update script: update.sh")
+
+# Pull latest images and start the docker-compose setup
+if [ "$IS_DOCKER_COMPOSE_REQUIRE_SUDO" = "y" ]; then
+  echo "Docker compose requires sudo. Running the docker-compose setup with sudo."
+  sudo docker-compose pull
+  sudo docker-compose up -d
+else
+  docker-compose pull
+  docker-compose up -d
+fi
+
+
+echo 'Waiting for Nginx to start...';
+
+sleep 5
+
+if [ "$SSL_ENABLED" = 'y' ] || [ "$SSL_ENABLED" = 'Y' ]; then
+  echo 'Starting Letsencrypt certificate request...';
+
+  if [ "$IS_DOCKER_COMPOSE_REQUIRE_SUDO" = "y" ]; then
+    sudo docker-compose exec certbot certbot certonly --webroot --webroot-path=/var/www/certbot -d $DOMAIN_NAME --email contact@$DOMAIN_NAME --agree-tos --no-eff-email && echo "Certificate request successful" || echo "Certificate request failed"
+  else
+    docker-compose exec certbot certbot certonly --webroot --webroot-path=/var/www/certbot -d $DOMAIN_NAME --email contact@$DOMAIN_NAME --agree-tos --no-eff-email && echo "Certificate request successful" || echo "Certificate request failed"
+  fi
+  # Initial Let's Encrypt certificate request
+
+  # Update the nginx config to use the new certificates
+  rm -rf ./nginx/default.conf
+  mv ./nginx-post-config/default.conf ./nginx/
+  rm -r ./nginx-post-config
+
+  echo "Restarting nginx to apply the new certificates"
+  # Reload nginx to apply the new certificates
+  if [ "$IS_DOCKER_COMPOSE_REQUIRE_SUDO" = "y" ]; then
+    sudo docker-compose exec nginx nginx -s reload
+  else
+    docker-compose exec nginx nginx -s reload
+  fi
+
+
+  message_arr+=("NocoDB is now available at https://$DOMAIN_NAME")
+
+elif [ -n "$DOMAIN_NAME" ]; then
+  message_arr+=("NocoDB is now available at http://$DOMAIN_NAME")
+else
+  message_arr+=("NocoDB is now available at http://localhost")
+fi
+
+print_box_message "${message_arr[@]}"
+
+# *************************** SETUP END  *************************************
+# ******************************************************************************