1
0
mirror of https://github.com/LaCasemate/fab-manager.git synced 2024-12-11 22:24:21 +01:00
fab-manager/setup/setup.sh

363 lines
14 KiB
Bash
Raw Normal View History

2017-12-14 11:58:23 +01:00
#!/bin/bash
2019-12-30 17:34:15 +01:00
DOMAINS=()
welcome_message()
{
2020-01-06 16:44:18 +01:00
clear
echo "#======================================================================#"
echo -e "#\e[31m ____ __ ____ _ _ __ __ _ __ ___ ____ ____ \e[0m#"
2020-01-07 10:12:02 +01:00
echo -e "#\e[31m ( __)/ _\ ( _ \ ___ ( \/ ) / _\ ( ( \ / _\ / __)( __)( _ \ \e[0m#"
2020-01-06 16:44:18 +01:00
echo -e "#\e[31m ) _)/ \ ) _ ((___)/ \/ \/ \/ // \( (_ \ ) _) ) / \e[0m#"
echo -e "#\e[31m (__) \_/\_/(____/ \_)(_/\_/\_/\_)__)\_/\_/ \___/(____)(__\_) \e[0m#"
echo "# #"
echo "#======================================================================#"
2020-02-26 10:19:43 +01:00
printf "\n Welcome to Fab-manager's setup assistant\n\n\n"
echo "Thank you for installing Fab-manager."
printf "This script will guide you through the installation process of Fab-manager\n\n"
echo -e "Please report any \e[1mfeedback or improvement request\e[21m on https://feedback.fab-manager.com/"
echo -e "For \e[1mbug reports\e[21m, please open a new issue on https://github.com/sleede/fab-manager/issues"
echo -e "You can call for \e[1mcommunity assistance\e[21m on https://forum.fab-manager.com/"
printf "\nYou can interrupt this installation at any time by pressing Ctrl+C\n"
2019-12-31 11:21:34 +01:00
printf "If you do not feel confortable with this installation, you can \e[4msubscribe to our hosting plan\e[24m: contact@fab-manager.com\n\n"
read -rp "Continue? (Y/n) " confirm </dev/tty
if [[ "$confirm" = "n" ]]; then exit 1; fi
}
2019-12-30 17:34:15 +01:00
system_requirements()
{
if [ "$(whoami)" = "root" ]; then
echo "It is not recommended to run this script as root. As a normal user, elevation will be prompted if needed."
read -rp "Continue anyway? (Y/n) " confirm </dev/tty
if [[ "$confirm" = "n" ]]; then exit 1; fi
else
local _groups=("sudo" "docker")
for _group in "${_groups[@]}"; do
2020-01-06 16:44:18 +01:00
echo -e "detecting group $_group for current user..."
2019-12-30 17:34:15 +01:00
if ! groups | grep "$_group"; then
echo "Please add your current user to the $_group group."
echo "You can run the following as root: \"usermod -aG $_group $(whoami)\", then logout and login again"
2020-01-06 16:44:18 +01:00
echo -e "\e[91m[ ❌ ] current user is misconfigured, exiting...\e[39m" && exit 1
2019-12-30 17:34:15 +01:00
fi
done
fi
2019-12-31 15:27:44 +01:00
local _commands=("sudo" "curl" "sed" "openssl" "docker" "docker-compose" "systemctl")
2019-12-30 17:34:15 +01:00
for _command in "${_commands[@]}"; do
echo "detecting $_command..."
if ! command -v "$_command"
then
echo "Please install $_command before running this script."
2020-01-06 16:44:18 +01:00
echo -e "\e[91m[ ❌ ] $_command was not found, exiting...\e[39m" && exit 1
2019-12-30 17:34:15 +01:00
fi
done
2020-01-06 16:44:18 +01:00
printf "\e[92m[ ✔ ] All requirements successfully checked.\e[39m \n\n"
2019-12-30 17:34:15 +01:00
}
2019-12-31 12:30:31 +01:00
read_email()
{
local email
read -rp "Please input a valid email address > " email </dev/tty
if [[ "$email" == *"@"*"."* ]]; then
EMAIL="$email"
else
read_email
fi
}
2019-12-30 17:34:15 +01:00
config()
{
2020-02-26 10:19:43 +01:00
echo 'We recommend nginx to serve the application over the network (internet). You can use your own solution or let this script install and configure nginx for Fab-manager.'
2019-12-30 17:34:15 +01:00
read -rp 'Do you want install nginx? (Y/n) ' NGINX </dev/tty
if [ "$NGINX" != "n" ]; then
# if the user doesn't want nginx, let him use its own solution for HTTPS
2020-02-26 10:19:43 +01:00
printf "\n\nWe recommend let's encrypt to secure the application with HTTPS. You can use your own certificate or let this script install and configure let's encrypt for Fab-manager.\n"
2019-12-30 17:34:15 +01:00
read -rp "Do you want install let's encrypt? (Y/n) " LETSENCRYPT </dev/tty
if [ "$LETSENCRYPT" != "n" ]; then
2020-01-06 16:44:18 +01:00
printf "\n\nLet's encrypt requires an email address to receive notifications about certificate expiration.\n"
2019-12-31 12:30:31 +01:00
read_email
2019-12-30 17:34:15 +01:00
fi
# if the user doesn't want nginx, let him configure his own solution
2020-01-06 16:44:18 +01:00
printf "\n\nWhat's the domain name where the instance will be active (eg. fab-manager.com)?\n"
2019-12-30 17:34:15 +01:00
read_domain
MAIN_DOMAIN=("${DOMAINS[0]}")
OTHER_DOMAINS=${DOMAINS[*]/$MAIN_DOMAIN}
else
LETSENCRYPT="n"
2019-12-30 17:34:15 +01:00
fi
}
read_domain()
{
read -rp 'Please input the domain name > ' domain </dev/tty
2019-12-31 12:30:31 +01:00
if [[ "$domain" == *"."* ]]; then
DOMAINS+=("$domain")
else
echo "The domain name entered is invalid"
read_domain
return
fi
2019-12-31 11:21:34 +01:00
read -rp 'Do you have any other domain (eg. www.fab-manager.com)? (y/N) ' confirm </dev/tty
2019-12-30 17:34:15 +01:00
if [ "$confirm" == "y" ]; then
read_domain
fi
}
prepare_files()
2017-12-14 11:58:23 +01:00
{
2017-12-14 12:02:50 +01:00
FABMANAGER_PATH=${1:-/apps/fabmanager}
2017-12-14 11:58:23 +01:00
echo -e "Fab-Manager will be installed in \e[31m$FABMANAGER_PATH\e[0m"
read -rp "Continue? (Y/n) " confirm </dev/tty
if [[ "$confirm" = "n" ]]; then exit 1; fi
2019-12-31 17:55:41 +01:00
sudo mkdir -p "$FABMANAGER_PATH/config"
2019-12-31 11:21:34 +01:00
sudo chown -R "$(whoami)" "$FABMANAGER_PATH"
mkdir -p "$FABMANAGER_PATH/elasticsearch/config"
2017-12-14 11:58:23 +01:00
2020-02-26 10:19:43 +01:00
# Fab-manager environment variables
2019-12-24 16:19:44 +01:00
\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/setup/env.example > "$FABMANAGER_PATH/config/env"
2017-12-14 11:58:23 +01:00
# nginx configuration
2019-12-31 17:55:41 +01:00
if [ "$NGINX" != "n" ]; then
2019-12-30 17:34:15 +01:00
mkdir -p "$FABMANAGER_PATH/config/nginx"
\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/setup/nginx_with_ssl.conf.example > "$FABMANAGER_PATH/config/nginx/fabmanager.conf.ssl"
\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/setup/nginx.conf.example > "$FABMANAGER_PATH/config/nginx/fabmanager.conf"
fi
2017-12-14 11:58:23 +01:00
# let's encrypt configuration
2019-12-31 17:55:41 +01:00
if [ "$LETSENCRYPT" != "n" ]; then
2020-01-06 16:44:18 +01:00
mkdir -p "$FABMANAGER_PATH/letsencrypt/etc/config"
2019-12-30 17:34:15 +01:00
mkdir -p "$FABMANAGER_PATH/letsencrypt/systemd"
mkdir -p "$FABMANAGER_PATH/letsencrypt/etc/webrootauth"
2020-01-06 16:44:18 +01:00
\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/setup/webroot.ini.example > "$FABMANAGER_PATH/letsencrypt/etc/config/webroot.ini"
2019-12-30 17:34:15 +01:00
# temp systemd files
\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/setup/letsencrypt.service > "$FABMANAGER_PATH/letsencrypt/systemd/letsencrypt.service"
\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/setup/letsencrypt.timer > "$FABMANAGER_PATH/letsencrypt/systemd/letsencrypt.timer"
fi
2017-12-14 11:58:23 +01:00
# ElasticSearch configuration files
2019-12-24 16:19:44 +01:00
\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/setup/elasticsearch.yml > "$FABMANAGER_PATH/elasticsearch/config/elasticsearch.yml"
\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/setup/log4j2.properties > "$FABMANAGER_PATH/elasticsearch/config/log4j2.properties"
2017-12-14 11:58:23 +01:00
# docker-compose
2019-12-24 16:19:44 +01:00
\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/setup/docker-compose.yml > "$FABMANAGER_PATH/docker-compose.yml"
2017-12-14 11:58:23 +01:00
}
yq() {
docker run --rm -i -v "${FABMANAGER_PATH}:/workdir" mikefarah/yq yq "$@"
}
2019-12-30 17:34:15 +01:00
prepare_nginx()
{
if [ "$NGINX" != "n" ]; then
sed -i.bak "s/MAIN_DOMAIN/${MAIN_DOMAIN[0]}/g" "$FABMANAGER_PATH/config/nginx/fabmanager.conf"
sed -i.bak "s/MAIN_DOMAIN/${MAIN_DOMAIN[0]}/g" "$FABMANAGER_PATH/config/nginx/fabmanager.conf.ssl"
sed -i.bak "s/ANOTHER_DOMAIN_1/$OTHER_DOMAINS/g" "$FABMANAGER_PATH/config/nginx/fabmanager.conf.ssl"
2019-12-31 11:21:34 +01:00
sed -i.bak "s/URL_WITH_PROTOCOL_HTTPS/https:\/\/${MAIN_DOMAIN[0]}/g" "$FABMANAGER_PATH/config/nginx/fabmanager.conf.ssl"
else
# if nginx is not installed, remove its associated block from docker-compose.yml
echo "Removing nginx..."
yq d -i docker-compose.yml services.nginx
read -rp "Do you want to map the Fab-manager's service to an external network? (Y/n) " confirm </dev/tty
if [ "$confirm" != "n" ]; then
echo "Adding a network configuration to the docker-compose.yml file..."
yq w -i docker-compose.yml networks.web.external true
yq w -i docker-compose.yml networks.db ''
yq w -i docker-compose.yml services.fabmanager.networks[+] web
yq w -i docker-compose.yml services.fabmanager.networks[+] db
yq w -i docker-compose.yml services.postgres.networks[+] db
yq w -i docker-compose.yml services.redis.networks[+] db
fi
2019-12-30 17:34:15 +01:00
fi
}
2019-12-31 17:55:41 +01:00
function join_by { local IFS="$1"; shift; echo "$*"; }
2019-12-30 17:34:15 +01:00
prepare_letsencrypt()
{
2019-12-31 17:55:41 +01:00
if [ "$LETSENCRYPT" != "n" ]; then
2020-01-07 10:12:02 +01:00
if ! openssl dhparam -in "$FABMANAGER_PATH/config/nginx/ssl/dhparam.pem" -check; then
2020-01-06 16:44:18 +01:00
mkdir -p "$FABMANAGER_PATH/config/nginx/ssl"
printf "\n\nNow, we will generate a Diffie-Hellman (DH) 4096 bits encryption key, to encrypt connections. This will take a moment, please wait...\n"
openssl dhparam -out "$FABMANAGER_PATH/config/nginx/ssl/dhparam.pem" 4096
fi
sed -i.bak "s/REPLACE_WITH_YOUR@EMAIL.COM/$EMAIL/g" "$FABMANAGER_PATH/letsencrypt/etc/config/webroot.ini"
sed -i.bak "s/MAIN_DOMAIN, ANOTHER_DOMAIN_1/$(join_by , "${DOMAINS[@]}")/g" "$FABMANAGER_PATH/letsencrypt/etc/config/webroot.ini"
echo "Now downloading and configuring the certificate signing bot..."
2019-12-30 17:34:15 +01:00
docker pull certbot/certbot:latest
sed -i.bak "s:/apps/fabmanager:$FABMANAGER_PATH:g" "$FABMANAGER_PATH/letsencrypt/systemd/letsencrypt.service"
sudo cp "$FABMANAGER_PATH/letsencrypt/systemd/letsencrypt.service" /etc/systemd/system/letsencrypt.service
sudo cp "$FABMANAGER_PATH/letsencrypt/systemd/letsencrypt.timer" /etc/systemd/system/letsencrypt.timer
sudo systemctl daemon-reload
fi
2019-12-30 17:34:15 +01:00
}
prepare_docker()
{
2020-01-06 16:44:18 +01:00
if [ "$(docker ps | wc -l)" -gt 1 ]; then
printf "\n\nIf you have previously interrupted the installer, it is recommended to stop any existing docker container before continuing.\n"
echo "Here's a list of all existing containers:"
docker ps -a
read -rp "Force remove all containers? (y/N) " confirm </dev/tty
if [ "$confirm" = "y" ]; then
# shellcheck disable=SC2046
docker rm -f $(docker ps -q)
fi
fi
2019-12-30 17:34:15 +01:00
cd "$FABMANAGER_PATH" && docker-compose pull
}
get_md_anchor()
{
local md_file="$1"
local anchor="$2"
2019-12-31 12:30:31 +01:00
local section lastline
2019-12-30 17:34:15 +01:00
section=$(echo "$md_file" | sed -n "/<a name=\"$anchor/,/<a name=/p" | tail -n +2)
2019-12-31 12:30:31 +01:00
lastline=$(echo "$section" | tail -n -1)
if [[ "$lastline" == *"<a name="* ]]; then
section=$(echo "$section" | head -n -1)
2019-12-30 17:34:15 +01:00
fi
echo "$section"
}
configure_env_file()
{
2020-01-06 16:44:18 +01:00
printf "\n\nWe will now configure the environment variables.\n"
2020-02-26 10:19:43 +01:00
echo "This allows you to customize Fab-manager's appearance and behavior."
2019-12-31 12:30:31 +01:00
read -rp "Proceed? (Y/n) " confirm </dev/tty
2019-12-30 17:34:15 +01:00
if [ "$confirm" = "n" ]; then return; fi
2019-12-31 11:21:34 +01:00
local doc variables secret
2019-12-30 17:34:15 +01:00
doc=$(\curl -sSL https://raw.githubusercontent.com/sleede/fab-manager/master/doc/environment.md)
2020-06-15 12:44:43 +02:00
variables=(DEFAULT_HOST DEFAULT_PROTOCOL DELIVERY_METHOD SMTP_ADDRESS SMTP_PORT SMTP_USER_NAME SMTP_PASSWORD SMTP_AUTHENTICATION \
SMTP_ENABLE_STARTTLS_AUTO SMTP_OPENSSL_VERIFY_MODE SMTP_TLS LOG_LEVEL MAX_IMAGE_SIZE MAX_CAO_SIZE MAX_IMPORT_SIZE DISK_SPACE_MB_ALERT \
SUPERADMIN_EMAIL APP_LOCALE RAILS_LOCALE MOMENT_LOCALE SUMMERNOTE_LOCALE ANGULAR_LOCALE FULLCALENDAR_LOCALE ELASTICSEARCH_LANGUAGE_ANALYZER TIME_ZONE \
2020-06-08 16:15:44 +02:00
WEEK_STARTING_DAY D3_DATE_FORMAT UIB_DATE_FORMAT EXCEL_DATE_FORMAT)
2019-12-30 17:34:15 +01:00
for variable in "${variables[@]}"; do
2019-12-31 11:21:34 +01:00
local var_doc current
2019-12-30 17:34:15 +01:00
var_doc=$(get_md_anchor "$doc" "$variable")
2020-01-06 16:44:18 +01:00
current=$(grep "$variable=" "$FABMANAGER_PATH/config/env")
2019-12-31 12:30:31 +01:00
printf "\n\n\n==== \e[4m%s\e[24m ====\n" "$variable"
printf "**** \e[1mDocumentation:\e[21m ****\n"
2019-12-30 17:34:15 +01:00
echo "$var_doc"
2019-12-31 12:30:31 +01:00
printf "=======================\n- \e[1mCurrent value: %s\e[21m\n- New value? (leave empty to keep current value)\n" "$current"
read -rp " > " value </dev/tty
echo "======================="
2019-12-30 17:34:15 +01:00
if [ "$value" != "" ]; then
sed -i.bak "s/$current/$variable=$value/g" "$FABMANAGER_PATH/config/env"
fi
done
# we automatically generate the SECRET_KEY_BASE
secret=$(cd "$FABMANAGER_PATH" && docker-compose run --rm fabmanager bundle exec rake secret)
2019-12-31 17:55:41 +01:00
sed -i.bak "s/SECRET_KEY_BASE=/SECRET_KEY_BASE=$secret/g" "$FABMANAGER_PATH/config/env"
2019-12-30 17:34:15 +01:00
}
read_password()
{
2019-12-31 11:21:34 +01:00
local password confirmation
2019-12-31 17:55:41 +01:00
>&2 echo "Please input a password for this administrator's account"
2019-12-31 12:30:31 +01:00
read -rsp " > " password </dev/tty
if [ ${#password} -lt 8 ]; then
>&2 printf "\nError: password is too short (minimal length: 8 characters)\n"
password=$(read_password 'no-confirm')
fi
if [ "$1" != 'no-confirm' ]; then
>&2 printf "\nConfirm the password\n"
read -rsp " > " confirmation </dev/tty
if [ "$password" != "$confirmation" ]; then
>&2 printf "\nError: passwords mismatch\n"
password=$(read_password)
fi
2019-12-30 17:34:15 +01:00
fi
echo "$password"
}
setup_assets_and_databases()
{
2020-01-06 16:44:18 +01:00
printf "\n\nWe will now setup the database.\n"
2019-12-31 17:55:41 +01:00
read -rp "Continue? (Y/n) " confirm </dev/tty
2019-12-30 17:34:15 +01:00
if [ "$confirm" = "n" ]; then return; fi
cd "$FABMANAGER_PATH" && docker-compose run --rm fabmanager bundle exec rake db:create # create the database
cd "$FABMANAGER_PATH" && docker-compose run --rm fabmanager bundle exec rake db:migrate # run all the migrations
# prompt default admin email/password
2020-02-26 10:19:43 +01:00
printf "\n\nWe will now create the default administrator of Fab-manager.\n"
2019-12-31 12:30:31 +01:00
read_email
2019-12-30 17:34:15 +01:00
PASSWORD=$(read_password)
2020-04-07 10:39:43 +02:00
printf "\nOK. We will fulfill the database now...\n"
2019-12-30 17:34:15 +01:00
cd "$FABMANAGER_PATH" && docker-compose run --rm -e ADMIN_EMAIL="$EMAIL" -e ADMIN_PASSWORD="$PASSWORD" fabmanager bundle exec rake db:seed # seed the database
# now build the assets
cd "$FABMANAGER_PATH" && docker-compose run --rm fabmanager bundle exec rake assets:precompile
# and prepare elasticsearch
cd "$FABMANAGER_PATH" && docker-compose run --rm fabmanager bundle exec rake fablab:es:build_stats
}
stop()
{
cd "$FABMANAGER_PATH" && docker-compose down
}
2019-12-30 17:34:15 +01:00
start()
{
cd "$FABMANAGER_PATH" && docker-compose up -d
}
enable_ssl()
{
2019-12-31 17:55:41 +01:00
if [ "$LETSENCRYPT" != "n" ]; then
# generate certificate
sudo systemctl start letsencrypt.service
# serve http content over ssl
mv "$FABMANAGER_PATH/config/nginx/fabmanager.conf" "$FABMANAGER_PATH/config/nginx/fabmanager.conf.nossl"
mv "$FABMANAGER_PATH/config/nginx/fabmanager.conf.ssl" "$FABMANAGER_PATH/config/nginx/fabmanager.conf"
stop
start
sudo systemctl enable letsencrypt.timer
sudo systemctl start letsencrypt.timer
fi
}
final_message()
{
2020-01-06 16:44:18 +01:00
printf "\n\e[92m[ ✔ ] Installation process in now complete.\e[39m \n\n"
echo "#========================#"
echo -e "#\e[5m 🥳 Congratulations! 🎉 \e[25m#"
echo "#========================#"
printf "\n\n"
echo -e "Please \e[1mkeep track of the logs\e[21m produced by this script and check that everything is running correctly."
echo "You can call for the community assistance on https://forum.fab-manager.com"
2020-02-26 10:19:43 +01:00
echo -e "We wish you a pleasant use of \e[31mFab-manager\e[0m"
}
2019-12-24 16:19:44 +01:00
function trap_ctrlc()
{
echo "Ctrl^C, exiting..."
exit 2
}
2019-12-30 17:34:15 +01:00
setup()
{
trap "trap_ctrlc" 2 # SIGINT
welcome_message
2019-12-30 17:34:15 +01:00
system_requirements
config
prepare_files "$@"
prepare_nginx
prepare_letsencrypt
prepare_docker
configure_env_file
setup_assets_and_databases
start
enable_ssl
final_message
2019-12-30 17:34:15 +01:00
}
setup "$@"