mirror of
https://github.com/YunoHost-Apps/etherpad_mypads_ynh.git
synced 2024-09-03 18:36:09 +02:00
356 lines
16 KiB
Bash
356 lines
16 KiB
Bash
#!/bin/bash
|
|
|
|
#=================================================
|
|
# GENERIC START
|
|
#=================================================
|
|
# IMPORT GENERIC HELPERS
|
|
#=================================================
|
|
|
|
if [ ${PACKAGE_CHECK_EXEC:-0} -eq 1 ]; then
|
|
sleep 60
|
|
fi
|
|
|
|
source _common.sh
|
|
source /usr/share/yunohost/helpers
|
|
|
|
#=================================================
|
|
# MANAGE SCRIPT FAILURE
|
|
#=================================================
|
|
|
|
#REMOVEME? ynh_clean_setup () {
|
|
true
|
|
}
|
|
# Exit if an error occurs during the execution of the script
|
|
#REMOVEME? ynh_abort_if_errors
|
|
|
|
#=================================================
|
|
# RETRIEVE ARGUMENTS FROM THE MANIFEST
|
|
#=================================================
|
|
|
|
#REMOVEME? domain=$YNH_APP_ARG_DOMAIN
|
|
#REMOVEME? path=$YNH_APP_ARG_PATH
|
|
#REMOVEME? is_public=$YNH_APP_ARG_IS_PUBLIC
|
|
#REMOVEME? language=$YNH_APP_ARG_LANGUAGE
|
|
#REMOVEME? admin=$YNH_APP_ARG_ADMIN
|
|
#REMOVEME? password="$YNH_APP_ARG_PASSWORD"
|
|
#REMOVEME? export=$YNH_APP_ARG_EXPORT
|
|
#REMOVEME? mypads=$YNH_APP_ARG_MYPADS
|
|
#REMOVEME? useldap=$YNH_APP_ARG_USELDAP
|
|
|
|
#REMOVEME? app=$YNH_APP_INSTANCE_NAME
|
|
|
|
#=================================================
|
|
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
|
|
#=================================================
|
|
#REMOVEME? ynh_script_progression --message="Validating installation parameters..." --weight=1
|
|
|
|
if [ "${#password}" -lt 8 ] || [ "${#password}" -gt 30 ]
|
|
then
|
|
ynh_die --message="The password must be between 8 and 30 characters."
|
|
fi
|
|
|
|
#REMOVEME? install_dir=/var/www/$app
|
|
#REMOVEME? test ! -e "$install_dir" || ynh_die --message="This path already contains a folder"
|
|
|
|
# Register (book) web path
|
|
#REMOVEME? ynh_webpath_register --app=$app --domain=$domain --path=$path
|
|
|
|
#=================================================
|
|
# STORE SETTINGS FROM MANIFEST
|
|
#=================================================
|
|
#REMOVEME? ynh_script_progression --message="Storing installation settings..." --weight=3
|
|
|
|
#REMOVEME? ynh_app_setting_set --app=$app --key=domain --value=$domain
|
|
#REMOVEME? ynh_app_setting_set --app=$app --key=path --value=$path
|
|
ynh_app_setting_set --app=$app --key=language --value=$language
|
|
#REMOVEME? ynh_app_setting_set --app=$app --key=admin --value=$admin
|
|
#REMOVEME? ynh_app_setting_set --app=$app --key=password --value="$password"
|
|
#REMOVEME? ynh_app_setting_set --app=$app --key=export --value=$export
|
|
ynh_app_setting_set --app=$app --key=mypads --value=$mypads
|
|
ynh_app_setting_set --app=$app --key=useldap --value=$useldap
|
|
ynh_app_setting_set --app=$app --key=overwrite_settings --value="1"
|
|
ynh_app_setting_set --app=$app --key=overwrite_credentials --value="1"
|
|
ynh_app_setting_set --app=$app --key=overwrite_nginx --value="1"
|
|
ynh_app_setting_set --app=$app --key=overwrite_systemd --value="1"
|
|
|
|
#=================================================
|
|
# STANDARD MODIFICATIONS
|
|
#=================================================
|
|
# FIND AND OPEN A PORT
|
|
#=================================================
|
|
#REMOVEME? ynh_script_progression --message="Finding an available port..." --weight=2
|
|
|
|
# Find an available port
|
|
#REMOVEME? port=$(ynh_find_port --port=9001)
|
|
#REMOVEME? ynh_app_setting_set --app=$app --key=port --value=$port
|
|
|
|
#=================================================
|
|
# INSTALL DEPENDENCIES
|
|
#=================================================
|
|
#REMOVEME? ynh_script_progression --message="Installing dependencies..." --weight=120
|
|
|
|
if [ "$export" = "abiword" ]; then
|
|
#REMOVEME? ynh_exec_warn_less ynh_install_app_dependencies $abiword_app_depencencies
|
|
elif [ "$export" = "libreoffice" ]; then
|
|
#REMOVEME? ynh_exec_warn_less ynh_install_app_dependencies $libreoffice_app_dependencies
|
|
fi
|
|
|
|
ynh_install_nodejs --nodejs_version=$nodejs_version
|
|
ynh_use_nodejs
|
|
|
|
#=================================================
|
|
# CREATE DEDICATED USER
|
|
#=================================================
|
|
#REMOVEME? ynh_script_progression --message="Configuring system user..." --weight=3
|
|
|
|
# Create a system user
|
|
#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir"
|
|
|
|
#=================================================
|
|
# CREATE A MYSQL DATABASE
|
|
#=================================================
|
|
#REMOVEME? ynh_script_progression --message="Creating a MySQL database..." --weight=1
|
|
|
|
#REMOVEME? db_name=$(ynh_sanitize_dbid --db_name=$app)
|
|
#REMOVEME? db_user=$db_name
|
|
#REMOVEME? ynh_app_setting_set --app=$app --key=db_name --value=$db_name
|
|
#REMOVEME? ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name
|
|
|
|
echo "ALTER DATABASE $db_name CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci" | ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name
|
|
|
|
#=================================================
|
|
# DOWNLOAD, CHECK AND UNPACK SOURCE
|
|
#=================================================
|
|
ynh_script_progression --message="Setting up source files..." --weight=4
|
|
|
|
#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir
|
|
# Download, check integrity, uncompress and patch the source from app.src
|
|
ynh_setup_source --dest_dir="$install_dir"
|
|
|
|
chmod 750 "$install_dir"
|
|
chmod -R o-rwx "$install_dir"
|
|
chown -R $app:$app "$install_dir"
|
|
|
|
#=================================================
|
|
# NGINX CONFIGURATION
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring NGINX web server..." --weight=2
|
|
|
|
# Create a dedicated NGINX config
|
|
ynh_add_nginx_config
|
|
|
|
#=================================================
|
|
# SPECIFIC SETUP
|
|
#=================================================
|
|
# HANDLE LOG FILES AND LOGROTATE
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring log rotation..." --weight=1
|
|
|
|
# Create log directory
|
|
mkdir -p /var/log/$app
|
|
touch /var/log/$app/etherpad.log
|
|
chown $app -R /var/log/$app
|
|
|
|
#=================================================
|
|
# ADD A CONFIGURATION
|
|
#=================================================
|
|
ynh_script_progression --message="Adding a configuration file..." --weight=6
|
|
|
|
cp ../conf/settings.json "$install_dir/settings.json"
|
|
|
|
ynh_replace_string --match_string="__PORT__" --replace_string="$port" --target_file="$install_dir/settings.json"
|
|
if [ "$export" = "abiword" ]
|
|
then
|
|
# Get Abiword binary path
|
|
abiword_path=`which abiword`
|
|
# Set the path of abiword into Etherpad config
|
|
ynh_replace_string --match_string="\"abiword\" : null" --replace_string="\"abiword\" : \"$abiword_path\"" --target_file="$install_dir/settings.json"
|
|
elif [ "$export" = "libreoffice" ]
|
|
then
|
|
# Get soffice binary path
|
|
soffice_path=`which soffice`
|
|
# Set the path of soffice into Etherpad config
|
|
ynh_replace_string --match_string="\"soffice\" : null" --replace_string="\"soffice\" : \"$soffice_path\"" --target_file="$install_dir/settings.json"
|
|
fi
|
|
ynh_replace_string --match_string="__LANGUAGE__" --replace_string="$language" --target_file="$install_dir/settings.json"
|
|
|
|
# Use ldap for mypads
|
|
if [ $mypads -eq 1 ] && [ $useldap -eq 1 ]
|
|
then
|
|
ynh_replace_string --match_string="//noldap\(.*\)" --replace_string="\1 //useldap" --target_file="$install_dir/settings.json"
|
|
fi
|
|
|
|
# Calculate and store the config file checksum into the app settings
|
|
ynh_store_file_checksum --file="$install_dir/settings.json"
|
|
|
|
ynh_add_config --template="../conf/credentials.json" --destination="$install_dir/credentials.json"
|
|
|
|
chmod 600 "$install_dir/settings.json"
|
|
chown $app:$app "$install_dir/settings.json"
|
|
|
|
chmod 600 "$install_dir/credentials.json"
|
|
chown $app:$app "$install_dir/credentials.json"
|
|
|
|
#=================================================
|
|
# SETUP SYSTEMD
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring a systemd service..." --weight=4
|
|
|
|
# Create a dedicated systemd config
|
|
ynh_add_systemd_config
|
|
|
|
#=================================================
|
|
# INSTALL ETHERPAD'S PLUGINS
|
|
#=================================================
|
|
ynh_script_progression --message="Installing Etherpad plugins..." --weight=90
|
|
|
|
pushd "$install_dir"
|
|
# Add Left/Center/Right/Justify to lines of text in a pad
|
|
ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install --no-save ep_align@${ep_align_version}
|
|
# Framapad - Adds author names to span titles
|
|
ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install --no-save ep_author_hover@${ep_author_hover_version}
|
|
# Framapad - Adds comments on sidebar and link it to the text.
|
|
ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install --no-save ep_comments_page@${ep_comments_page_version}
|
|
# Framapad - Displays paragraphs, sentences, words and characters counts.
|
|
ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install --no-save ep_countable@${ep_countable_version}
|
|
# Framapad - Delete pads which were never edited
|
|
ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install --no-save ep_delete_empty_pads@${ep_delete_empty_pads_version}
|
|
# Framapad - Apply colors to fonts
|
|
ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install --no-save ep_font_color@${ep_font_color_version}
|
|
# Framapad - Adds heading support to Etherpad Lite.
|
|
ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install --no-save ep_headings2@${ep_headings2_version}
|
|
# Framapad - Edit and Export as Markdown in Etherpad
|
|
ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install --no-save ep_markdown@${ep_markdown_version}
|
|
if [ $mypads -eq 1 ]; then
|
|
# Framapad - Groups and private pads for Etherpad
|
|
ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install --no-save ep_mypads@${mypads_version}
|
|
fi
|
|
# Framapad - Add support to do 'Spell checking'
|
|
ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install --no-save ep_spellcheck@${ep_spellcheck_version}
|
|
# Framapad - Add support for Subscript and Superscript
|
|
ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install --no-save ep_subscript_and_superscript@${ep_subscript_and_superscript_version}
|
|
# Framapad - View a table of contents for your pad
|
|
ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install --no-save ep_table_of_contents@${ep_table_of_contents_version}
|
|
# Framapad - User Pad Contents font size can be set in settings, this does not effect other peoples views
|
|
ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH $ynh_npm install --no-save ep_font_size@${ep_font_size_version}
|
|
popd
|
|
|
|
#=================================================
|
|
# INSTALL ETHERPAD
|
|
#=================================================
|
|
ynh_script_progression --message="Installing Etherpad..." --weight=90
|
|
|
|
pushd $install_dir
|
|
ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH bin/installDeps.sh
|
|
popd
|
|
|
|
#=================================================
|
|
# SOME HACKS
|
|
#=================================================
|
|
|
|
if [ $mypads -eq 1 ]
|
|
then
|
|
ynh_script_progression --message="Some hacks..." --weight=1
|
|
|
|
# Add a link to Etherpad to allow anonymous pads creation from MyPads.
|
|
ynh_replace_string --match_string="^ *\"DESCRIPTION\": .*</ul>" --replace_string="&<a href=../>Pads anonymes</a>" --target_file=$install_dir/node_modules/ep_mypads/static/l10n/fr.json
|
|
ynh_replace_string --match_string="^ *\"DESCRIPTION\": .*</ul>" --replace_string="&<a href=../>Anonymous pads</a>" --target_file=$install_dir/node_modules/ep_mypads/static/l10n/en.json
|
|
# And a link to etherpad admin from Mypads.
|
|
ynh_replace_string --match_string="^ *\"FOOTER\": .*2.0" --replace_string="& | <a href='../admin'>Etherpad admin</a>" --target_file=$install_dir/node_modules/ep_mypads/static/l10n/en.json
|
|
ynh_replace_string --match_string="^ *\"FOOTER\": .*2.0" --replace_string="& | <a href='../admin'>Etherpad admin</a>" --target_file=$install_dir/node_modules/ep_mypads/static/l10n/fr.json
|
|
|
|
# Find the /div just after the field to open a pad in order to add a link to MyPads plugin.
|
|
sed -i '157i<center><br><font size="4"><a href="./mypads/" style="text-decoration: none; color: #555">MyPads</a></font></center>' $install_dir/src/templates/index.html
|
|
fi
|
|
|
|
#=================================================
|
|
# GENERIC FINALIZATION
|
|
#=================================================
|
|
# SETUP LOGROTATE
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring log rotation..." --weight=1
|
|
|
|
# Use logrotate to manage application logfile(s)
|
|
ynh_use_logrotate --specific_user=$app/$app
|
|
|
|
#=================================================
|
|
# INTEGRATE SERVICE IN YUNOHOST
|
|
#=================================================
|
|
ynh_script_progression --message="Integrating service in YunoHost..." --weight=2
|
|
|
|
yunohost service add $app --description="Collaborative editor" --log="/var/log/$app/etherpad.log"
|
|
|
|
#=================================================
|
|
# START SYSTEMD SERVICE
|
|
#=================================================
|
|
ynh_script_progression --message="Starting a systemd service..." --weight=20
|
|
|
|
# Start a systemd service
|
|
ynh_systemd_action --service_name=$app --action=restart --line_match="You can access your Etherpad instance at" --log_path="/var/log/$app/etherpad.log" --timeout="120"
|
|
|
|
if [ $mypads -eq 1 ]
|
|
then
|
|
ynh_replace_string --match_string="__LANGUAGE__" --replace_string="$language" --target_file="../conf/lang_mypads.sql"
|
|
ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < "../conf/lang_mypads.sql"
|
|
|
|
# Wait for etherpad to be fully started
|
|
ynh_systemd_action --action=restart --line_match="You can access your Etherpad instance at" --log_path="/var/log/$app/etherpad.log" --timeout="120"
|
|
fi
|
|
|
|
#=================================================
|
|
# SETUP FAIL2BAN
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring Fail2Ban..." --weight=13
|
|
|
|
# Create a dedicated Fail2Ban config
|
|
ynh_add_fail2ban_config --logpath="/var/log/nginx/$domain-access.log" --failregex="<HOST> .* .POST /mypads/api/auth/login HTTP/1.1. 400" --max_retry=5
|
|
|
|
#=================================================
|
|
# SETUP SSOWAT
|
|
#=================================================
|
|
#REMOVEME? ynh_script_progression --message="Configuring permissions..." --weight=2
|
|
|
|
# Make app public if necessary
|
|
#REMOVEME? if [ $is_public -eq 1 ]
|
|
then
|
|
# Everyone can access the app.
|
|
# The "main" permission is automatically created before the install script.
|
|
#REMOVEME? ynh_permission_update --permission="main" --add="visitors"
|
|
fi
|
|
|
|
# Only the admin can access the admin panel of the app (if the app has an admin panel)
|
|
#REMOVEME? ynh_permission_create --permission="admin" --url="/admin" --allowed=$admin --auth_header=false
|
|
|
|
#=================================================
|
|
# RELOAD NGINX
|
|
#=================================================
|
|
#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1
|
|
|
|
#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload
|
|
|
|
#=================================================
|
|
# SEND A README FOR THE ADMIN
|
|
#=================================================
|
|
|
|
# Get main domain and buid the URL of the admin panel of the app.
|
|
admin_panel="https://$(grep portal_domain /etc/ssowat/conf.json | cut -d'"' -f4)/yunohost/admin/#/apps/$app"
|
|
|
|
if [ $mypads -eq 1 ]
|
|
then
|
|
Informations="You can access two different admin panels, for Etherpad by accessing https://$domain${path%/}/admin and for MyPads by accessing https://$domain${path%/}/mypads/?/admin."
|
|
else
|
|
Informations="You can access the admin panel by accessing https://$domain${path%/}/admin."
|
|
fi
|
|
|
|
echo "$Informations
|
|
You can also find a config file for Etherpad at this path /var/www/etherpad_mypads/settings.json.
|
|
|
|
If you are facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/etherpad_mypads_ynh" > mail_to_send
|
|
|
|
ynh_send_readme_to_admin --app_message="mail_to_send" --recipients="$admin" --type=install
|
|
|
|
#=================================================
|
|
# END OF SCRIPT
|
|
#=================================================
|
|
|
|
ynh_script_progression --message="Installation of $app completed" --last
|