1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/snserver_ynh.git synced 2024-09-03 20:26:22 +02:00
snserver_ynh/scripts/install

339 lines
14 KiB
Text
Raw Normal View History

2020-01-18 10:28:47 +01:00
#!/bin/bash
#=================================================
# GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
source _common.sh
2021-05-01 21:37:41 +02:00
source ynh_install_ruby__2
2021-03-06 21:39:49 +01:00
source ynh_redis
2020-01-18 10:28:47 +01:00
source /usr/share/yunohost/helpers
#=================================================
# MANAGE SCRIPT FAILURE
#=================================================
ynh_clean_setup () {
2020-12-27 23:18:55 +01:00
ynh_clean_check_starting
2020-01-18 10:28:47 +01:00
}
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors
#=================================================
# RETRIEVE ARGUMENTS FROM THE MANIFEST
#=================================================
domain=$YNH_APP_ARG_DOMAIN
2020-12-24 12:11:42 +01:00
path_url=$YNH_APP_ARG_PATH
2020-01-18 10:28:47 +01:00
is_public=$YNH_APP_ARG_IS_PUBLIC
app=$YNH_APP_INSTANCE_NAME
access_domain=$YNH_APP_ARG_ACCESS_DOMAIN
if [ -z "$access_domain" ]
2021-01-08 19:44:37 +01:00
then
access_domain=$domain
fi
2021-02-06 20:01:03 +01:00
mail="$app@$domain"
2020-01-18 10:28:47 +01:00
#=================================================
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
#=================================================
2020-12-20 14:22:36 +01:00
final_path=/opt/yunohost/$app
2020-01-18 10:28:47 +01:00
test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
# Register (book) web path
ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
#=================================================
# STORE SETTINGS FROM MANIFEST
#=================================================
2020-12-20 01:26:25 +01:00
ynh_script_progression --message="Storing installation settings..." --weight=3
2020-01-18 10:28:47 +01:00
ynh_app_setting_set --app=$app --key=domain --value=$domain
ynh_app_setting_set --app=$app --key=path --value=$path_url
2021-01-08 19:44:37 +01:00
ynh_app_setting_set --app=$app --key=access_domain --value=$access_domain
2021-02-06 01:44:31 +01:00
ynh_app_setting_set --app=$app --key=mail --value=$mail
2021-03-06 21:39:49 +01:00
redis_db=$(ynh_redis_get_free_db)
ynh_app_setting_set --app=$app --key=redis_db --value="$redis_db"
2020-01-18 10:28:47 +01:00
#=================================================
# STANDARD MODIFICATIONS
#=================================================
# FIND AND OPEN A PORT
#=================================================
ynh_script_progression --message="Finding an available port..." --weight=1
2020-01-18 10:28:47 +01:00
# Find an available port
2020-12-24 12:11:42 +01:00
port=$(ynh_find_port --port=3000)
2020-01-18 10:28:47 +01:00
# Open the port
2020-12-24 12:11:42 +01:00
ynh_app_setting_set --app=$app --key=port --value=$port
2020-01-18 10:28:47 +01:00
#=================================================
# INSTALL DEPENDENCIES
#=================================================
2020-12-20 01:26:25 +01:00
ynh_script_progression --message="Installing dependencies..." --weight=17
2020-01-18 10:28:47 +01:00
ynh_install_app_dependencies $pkg_dependencies
2021-05-01 21:37:41 +02:00
ynh_install_ruby --ruby_version=$RUBY_VERSION
2020-01-18 10:28:47 +01:00
#=================================================
# CREATE A MYSQL DATABASE
#=================================================
2020-12-20 01:26:25 +01:00
ynh_script_progression --message="Creating a MySQL database..." --weight=2
2020-01-18 10:28:47 +01:00
db_name=$(ynh_sanitize_dbid --db_name=$app)
db_user=$db_name
ynh_app_setting_set --app=$app --key=db_name --value=$db_name
ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
2020-12-20 01:26:25 +01:00
ynh_script_progression --message="Setting up source files..." --weight=2
2020-01-18 10:28:47 +01:00
ynh_app_setting_set --app=$app --key=final_path --value=$final_path
# Download, check integrity, uncompress and patch the source from app.src
2020-12-24 12:11:42 +01:00
mkdir -p $final_path
2020-01-18 10:28:47 +01:00
ynh_setup_source --dest_dir="$final_path/live"
#=================================================
# NGINX CONFIGURATION
#=================================================
2020-12-20 01:26:25 +01:00
ynh_script_progression --message="Configuring nginx web server..." --weight=3
2020-01-18 10:28:47 +01:00
# Create a dedicated nginx config
2021-05-01 22:39:00 +02:00
ynh_add_nginx_config "\
port \
access_domain \
"
2020-01-18 10:28:47 +01:00
#=================================================
# CREATE DEDICATED USER
#=================================================
2020-12-20 01:26:25 +01:00
ynh_script_progression --message="Configuring system user..." --weight=1
2020-01-18 10:28:47 +01:00
# Create a system user
ynh_system_user_create --username=$app --home_dir=$final_path
#=================================================
# SPECIFIC SETUP
#=================================================
2020-12-24 12:11:42 +01:00
# INSTALLING RUBY
2020-01-18 10:28:47 +01:00
#=================================================
2020-12-27 23:18:55 +01:00
ynh_script_progression --message="Installing Ruby...( This may take a while... )" --weight=100 #331
2020-01-18 10:28:47 +01:00
2021-05-01 21:37:41 +02:00
pushd "$final_path/live"
ynh_use_ruby
ynh_gem update --system --no-document
ynh_gem install bundler --no-document
popd
2020-01-18 10:28:47 +01:00
#=================================================
# Setup
#=================================================
#=================================================
# MODIFY A CONFIG FILE
#=================================================
2020-12-20 01:26:25 +01:00
ynh_script_progression --message="Modifying a config file..." --weight=2
2020-01-18 10:28:47 +01:00
config_file="$final_path/live/.env"
2020-12-20 14:22:36 +01:00
cp -f ../conf/env.sample $config_file
2021-02-06 02:44:33 +01:00
ynh_replace_string --match_string="EXPOSED_PORT=.*$" --replace_string="EXPOSED_PORT=$port" --target_file="$config_file"
2020-01-18 10:28:47 +01:00
secret_key=$(ynh_string_random --length=48 | base64)
2021-02-06 02:44:33 +01:00
ynh_replace_string --match_string="SECRET_KEY_BASE=.*$" --replace_string="SECRET_KEY_BASE=$secret_key" --target_file="$config_file"
2020-12-20 00:27:44 +01:00
pseudo_key=$(ynh_string_random --length=48 | base64)
2021-02-06 02:44:33 +01:00
ynh_replace_string --match_string="PSEUDO_KEY_PARAMS_KEY=.*$" --replace_string="PSEUDO_KEY_PARAMS_KEY=$pseudo_key" --target_file="$config_file"
ynh_replace_string --match_string="RAILS_ENV=.*$" --replace_string="RAILS_ENV=production" --target_file="$config_file"
ynh_replace_string --match_string="DB_DATABASE=.*$" --replace_string="DB_DATABASE=$db_name" --target_file="$config_file"
ynh_replace_string --match_string="DB_USERNAME=.*$" --replace_string="DB_USERNAME=$db_user" --target_file="$config_file"
ynh_replace_string --match_string="DB_PASSWORD=.*$" --replace_string="DB_PASSWORD=$db_pwd" --target_file="$config_file"
ynh_replace_string --match_string="RAILS_RELATIVE_URL_ROOT=.*$" --replace_string="RAILS_RELATIVE_URL_ROOT=$path_url" --target_file="$config_file"
2021-02-06 01:44:31 +01:00
ynh_replace_string --match_string="SMTP_HOST=.*$" --replace_string="SMTP_HOST=localhost" --target_file="$config_file"
ynh_replace_string --match_string="SMTP_PORT=.*$" --replace_string="SMTP_PORT=25" --target_file="$config_file"
2021-02-06 20:01:03 +01:00
ynh_replace_string --match_string="SMTP_DOMAIN=.*$" --replace_string="SMTP_DOMAIN=localhost" --target_file="$config_file"
2021-02-06 21:54:14 +01:00
ynh_replace_string --match_string="SMTP_STARTTLS=.*$" --replace_string="SMTP_STARTTLS=" --target_file="$config_file"
2021-02-06 02:44:33 +01:00
ynh_replace_string --match_string="RAILS_SERVE_STATIC_FILES=.*$" --replace_string="RAILS_SERVE_STATIC_FILES=true" --target_file="$config_file"
2021-03-06 21:39:49 +01:00
ynh_replace_string --match_string="REDIS_URL.*$" --replace_string="REDIS_URL=redis://localhost:6379/$redis_db" --target_file="$config_file"
2021-02-06 01:44:31 +01:00
ynh_replace_string --match_string="__MAIL__" --replace_string="$mail" --target_file="$final_path/live/app/mailers/application_mailer.rb"
ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$final_path/live/app/views/user_mailer/welcome.html.erb"
ynh_replace_string --match_string="__PATH__" --replace_string="$path_url" --target_file="$final_path/live/app/views/user_mailer/welcome.html.erb"
2020-01-18 10:28:47 +01:00
#=================================================
2021-05-01 21:48:58 +02:00
# INSTALLING Standard Notes - Syncing Server
2020-01-18 10:28:47 +01:00
#=================================================
2021-05-01 21:48:58 +02:00
ynh_script_progression --message="Installing Standard Notes - Syncing Server..." --weight=93
2020-01-18 10:28:47 +01:00
2021-03-20 13:48:42 +01:00
chown -R $app: "$final_path"
2020-01-18 10:28:47 +01:00
pushd "$final_path/live"
2021-05-01 21:37:41 +02:00
exec_as $app $ynh_ruby_load_path bin/bundle config set --local path 'vendor/bundle'
exec_as $app $ynh_ruby_load_path bin/bundle config set with 'development'
exec_as $app $ynh_ruby_load_path bin/bundle install -j$(getconf _NPROCESSORS_ONLN)
exec_as $app RAILS_ENV=production $ynh_ruby_load_path bin/bundle exec rails db:migrate --quiet
exec_as $app RAILS_ENV=production $ynh_ruby_load_path bin/bundle exec rails db:seed --quiet
# exec_as $app RAILS_ENV=production $ynh_ruby_load_path bin/bundle exec rails assets:precompile --quiet
2020-01-18 10:28:47 +01:00
popd
2021-01-08 19:44:37 +01:00
#=================================================
# INSTALLING Standard Notes - Extensions
#=================================================
ynh_script_progression --message="Installing Standard Notes - Extensions..." --weight=1
2021-01-08 19:44:37 +01:00
2021-01-14 20:32:33 +01:00
if [ $path_url = "/" ]
then
path=""
else
path=$path_url
fi
2021-01-14 20:32:33 +01:00
ynh_replace_string --match_string="__DOMAIN__PATH__" --replace_string="$domain$path" --target_file="$final_path/live/public/extensions/repo.json"
2021-01-30 12:57:24 +01:00
find "$final_path/live/public/extensions/src/" -name "*.json" -print0 | while read -d $'\0' file
do
ynh_replace_string --match_string="__DOMAIN__PATH__" --replace_string="$domain$path" --target_file="$file"
done
2021-01-11 22:23:08 +01:00
find "../conf/" -name "ext_*.src" -print0 | while read -d $'\0' file
do
basename=$(basename -as .src $file)
ynh_setup_source --dest_dir="$final_path/live/public/extensions/src/${basename#'ext_'}" --source_id="$basename"
done
2020-01-18 10:28:47 +01:00
#=================================================
# SETUP SYSTEMD
#=================================================
2020-12-20 01:26:25 +01:00
ynh_script_progression --message="Configuring a systemd service..." --weight=4
2020-01-18 10:28:47 +01:00
# Create a dedicated systemd config
2021-05-01 22:39:00 +02:00
ynh_add_systemd_config --others_var="\
port \
2021-05-01 22:47:12 +02:00
RBENV_ROOT \
2021-05-01 22:39:00 +02:00
"
2020-01-18 10:28:47 +01:00
#=================================================
# STORE THE CONFIG FILE CHECKSUM
#=================================================
2020-12-24 12:11:42 +01:00
ynh_script_progression --message="Storing the config file checksum..." --weight=1
2020-01-18 10:28:47 +01:00
# Calculate and store the config file checksum into the app settings
ynh_store_file_checksum --file="$config_file"
2020-12-20 14:22:36 +01:00
ynh_store_file_checksum --file="/etc/nginx/conf.d/$domain.d/$app.conf"
2020-01-18 10:28:47 +01:00
#=================================================
# GENERIC FINALIZATION
#=================================================
2020-12-20 14:22:36 +01:00
#=================================================
2020-01-18 10:28:47 +01:00
# SECURE FILES AND DIRECTORIES
#=================================================
2020-12-24 12:11:42 +01:00
ynh_script_progression --message="Securing files and directories..." --weight=1
2020-01-18 10:28:47 +01:00
# Set permissions to app files
2021-05-01 22:04:34 +02:00
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
2021-05-01 23:10:36 +02:00
chown -R $app: "$final_path"
2021-05-01 22:04:34 +02:00
2020-12-27 23:18:55 +01:00
mkdir -p "$final_path/live/log"
chown -R $app: "$final_path/live/log/"
mkdir -p "$final_path/live/tmp"
chown -R $app: "$final_path/live/tmp/"
2020-12-20 00:27:44 +01:00
2020-12-27 23:18:55 +01:00
mkdir -p "/var/log/$app"
chown -R $app: "/var/log/$app"
2020-01-18 10:28:47 +01:00
#=================================================
# SETUP LOGROTATE
#=================================================
2020-12-20 01:26:25 +01:00
ynh_script_progression --message="Configuring log rotation..." --weight=1
2020-01-18 10:28:47 +01:00
# Use logrotate to manage application logfile(s)
2020-12-20 14:22:36 +01:00
ynh_use_logrotate --logfile="$final_path/live/log/production.log"
ynh_use_logrotate --logfile="/var/log/$app/$app.log"
2020-01-18 10:28:47 +01:00
#=================================================
# INTEGRATE SERVICE IN YUNOHOST
#=================================================
2020-12-20 01:26:25 +01:00
ynh_script_progression --message="Integrate $app service in Yunohost..." --weight=1
2020-01-18 10:28:47 +01:00
2020-12-24 12:11:42 +01:00
yunohost service add $app --description "Standard Notes - Syncing Server" --log "/var/log/$app/$app.log"
2020-01-18 10:28:47 +01:00
#=================================================
# SETUP FAIL2BAN
#=================================================
2021-01-03 15:45:28 +01:00
ynh_script_progression --message="Configuring fail2ban..." --weight=1
2020-01-18 10:28:47 +01:00
# Create a dedicated fail2ban config
2021-01-02 19:42:20 +01:00
touch "/var/log/$app/$app.log"
2021-05-01 22:39:00 +02:00
ynh_add_fail2ban_config --use_template --others_var="\
domain \
path_url \
"
2020-01-18 10:28:47 +01:00
#=================================================
# SETUP SSOWAT
#=================================================
2020-12-20 01:26:25 +01:00
ynh_script_progression --message="Configuring SSOwat..." --weight=3
2021-03-14 18:51:33 +01:00
# Make app public if necessary
2020-01-18 10:28:47 +01:00
if [ $is_public -eq 1 ]
then
2021-03-14 18:51:33 +01:00
# Everyone can access the app.
# The "main" permission is automatically created before the install script.
ynh_permission_update --permission="main" --add="visitors" --remove="all_users"
2020-01-18 10:28:47 +01:00
fi
2020-12-20 14:22:36 +01:00
#=================================================
# START SYSTEMD SERVICE
#=================================================
ynh_script_progression --message="Starting a systemd service..." --weight=1
# Start a systemd service
ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
2020-01-18 10:28:47 +01:00
#=================================================
# RELOAD NGINX
#=================================================
2020-12-20 01:26:25 +01:00
ynh_script_progression --message="Reloading nginx web server..." --weight=1
2020-01-18 10:28:47 +01:00
ynh_systemd_action --service_name=nginx --action=reload
2021-01-15 19:58:23 +01:00
#=================================================
2021-01-25 13:08:34 +01:00
# WAITING FOR SERVICE
#=================================================
ynh_script_progression --message="Waiting for service..." --weight=1
is_service_ready
#=================================================
2021-01-15 19:58:23 +01:00
# SEND A README FOR THE ADMIN
#=================================================
ynh_script_progression --message="Sending a readme for the admin..."
admin_panel="https://$(grep portal_domain /etc/ssowat/conf.json | cut -d'"' -f4)/yunohost/admin/#/apps/$app"
2021-01-22 23:47:08 +01:00
config_panel="You can find some specific configurations for this app by using the experimental __URL_TAG1__config-panel feature__URL_TAG2__$admin_panel/config-panel__URL_TAG3__"
2021-01-15 19:58:23 +01:00
2021-02-10 22:14:53 +01:00
admin_mail_info="\
Standard Notes extensions are hosted with this package.\n\
New users will get an e-mail with install instructions.\n\
With the current SMTP settings you can not send e-mails to all e-mail providers. For example GMail will probably not recive this e-mails.\n\
Please setup the SMTP account in this file: \"$final_path/live/.env\" under \"#Mailer settings\" if you want to fix this.\n\
2021-02-10 22:53:12 +01:00
Please setup the Access-Domain for the extensions in the __URL_TAG1__config-panel__URL_TAG2__$admin_panel/config-panel__URL_TAG3__ if not already done during the installation settings.\
"
2021-01-15 19:58:23 +01:00
2021-02-10 22:53:12 +01:00
echo -e "\
Standard Notes - Syncing Server was successfully installed.\n\
Please configure the Standard Notes web app or mobile app to use this syning server: https://$domain$path_url/\n\
$config_panel\n\n\
$admin_mail_info\
" > message
2021-01-15 19:58:23 +01:00
2021-02-10 22:53:12 +01:00
ynh_send_readme_to_admin --app_message="message" --type='install'
2021-01-15 19:58:23 +01:00
2020-01-18 10:28:47 +01:00
#=================================================
# END OF SCRIPT
#=================================================
2020-12-20 01:26:25 +01:00
ynh_script_progression --message="Installation of $app completed" --last