YunoHost-Apps/flarum_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/flarum_ynh.git synced 2024-09-03 18:36:24 +02:00
Code Issues Activity Actions

Installation and removal debugged, beta7

Browse source
This commit is contained in:
tituspijean 2018-02-12 16:07:11 +01:00
parent a56f1367b5
commit c484358ff2
5 changed files with 198 additions and 178 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -2,24 +2,25 @@
[Flarum](http://flarum.org/), an open-source forum software, packaged for [YunoHost](https://yunohost.org/), a self-hosting server operating server. [Flarum](http://flarum.org/), an open-source forum software, packaged for [YunoHost](https://yunohost.org/), a self-hosting server operating server.
## Development status ## Development status
Package is functional : installation and removal work, though upgrading, backing up and restoring don't. Package is **in progress** : installation and removal work. Upgrading, backing up and restoring are not supported yet.
[SSOwat integration](https://github.com/tituspijean/flarum-ext-auth-ssowat) is functional : users can log in, though logging out is only effective on Flarum. Only user creation hook is in place. [SSOwat integration](https://github.com/tituspijean/flarum-ext-auth-ssowat) is **non functional** and removed.
## Install ## Install
Flarum requires `composer`, which should be automatically retrieved and installed. Flarum requires `composer`, which should be automatically retrieved and installed.
## Post-installation ## Post-installation
Post-installation is **automated**. Post-installation is **automated**. You still have to set the mail configuration in the adminstration panel afterwards.
However, if you leave the forum title field empty in YunoHost's form, automatic post-installation will not be launched. However, if you leave the forum title field empty in YunoHost's form, automatic post-installation will not be launched.
1. Retrieve database password: 1. Retrieve database password:
* It should be displayed in the log messages on top of installation page. * It should be displayed in the log messages on top of installation page.
* Otherwise, display in command prompt with `sudo cat /etc/yunohost/apps/flarum/settings.yml | grep mysql` (Replace `flarum` by its actual app id if you are using multiple flarum instances in YNH) * Otherwise, display in command prompt with `sudo cat /etc/yunohost/apps/flarum/settings.yml | grep mysql` (Replace `flarum` by its actual app id if you are using multiple flarum instances in YunoHost)
2. Go to your Flarum homepage to initiate manual post-installation. 2. Go to your Flarum homepage to initiate manual post-installation.
3. Fill in the blanks about `MySQL` as follow, put the retrieved database password. The remaining blanks are up to you. 3. Fill in the blanks about `MySQL` as follow, put the retrieved database password. The remaining blanks are up to you.
<p align="center"><img src="http://i.imgur.com/p7XmTDw.png" width="300" ></p> <p align="center"><img src="http://i.imgur.com/p7XmTDw.png" width="300" ></p>

2
manifest.json
View file

@ -9,7 +9,7 @@
}, },
"url": "http://flarum.org/", "url": "http://flarum.org/",
"license": "MIT", "license": "MIT",
"version": "0.1.0-beta.6", "version": "0.1.0-beta.7",
"maintainer": { "maintainer": {
"name": "Titus PiJean", "name": "Titus PiJean",
"email": "tituspijean@outlook.com" "email": "tituspijean@outlook.com"

12
scripts/_common.sh Normal file
View file

@ -0,0 +1,12 @@
# Execute a command as another user
# usage: exec_as USER COMMAND [ARG ...]
exec_as() {
local USER=$1
shift 1
if [[ $USER = $(whoami) ]]; then
eval "$@"
else
sudo -u "$USER" "$@"
fi
}

298
scripts/install
View file

@ -1,10 +1,11 @@
#!/bin/bash #!/bin/bash
# Load extra functions # Load helpers
source .functions source _common.sh
source /usr/share/yunohost/helpers
# Activate TRAP to stop the script if an error is detected # Exit if an error occurs during the execution of the script
TRAP_ON ynh_abort_if_errors
# This is a multi-instance app, meaning it can be installed several times independently # This is a multi-instance app, meaning it can be installed several times independently
# The id of the app as stated in the manifest is available as $YNH_APP_ID # The id of the app as stated in the manifest is available as $YNH_APP_ID
@ -18,110 +19,149 @@ TRAP_ON
# db names, ... # db names, ...
app=$YNH_APP_INSTANCE_NAME app=$YNH_APP_INSTANCE_NAME
# Retrieve arguments #===================================================
# RETRIEVE ARGUMENTS FROM THE MANIFEST
#===================================================
domain=$YNH_APP_ARG_DOMAIN domain=$YNH_APP_ARG_DOMAIN
path=$YNH_APP_ARG_PATH path_url=$YNH_APP_ARG_PATH
admin=$YNH_APP_ARG_ADMIN admin=$YNH_APP_ARG_ADMIN
title=$YNH_APP_ARG_TITLE title=$YNH_APP_ARG_TITLE
is_public=$YNH_APP_ARG_IS_PUBLIC is_public=$YNH_APP_ARG_IS_PUBLIC
www_path=/var/www flarum_version="v0.1.0-beta.7"
final_path=$www_path/$app
# Source YunoHost helpers$ #===================================================
source /usr/share/yunohost/helpers # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
#===================================================
# Check variables are not empty final_path=/var/www/$app
CHECK_VAR "$app" "app name not set" test ! -e "$final_path" || ynh_die "This path already contains a folder"
# Check validity of admin user # Normalize the url path syntax
CHECK_USER "$admin" path_url=$(ynh_normalize_url_path $path_url)
# Check and correct path syntax # Check web path availability
CHECK_PATH ynh_webpath_available $domain $path_url
# Check availibility of path and domain # Register (book) web path
CHECK_DOMAINPATH ynh_webpath_register $app $domain $path_url
#===================================================
# STORE SETTINGS FROM MANIFEST
#===================================================
# Save app settings # Save app settings
ynh_app_setting_set "$app" admin "$admin" ynh_app_setting_set $app admin $admin
ynh_app_setting_set "$app" is_public "$is_public" ynh_app_setting_set $app is_public $is_public
ynh_app_setting_set "$app" path "$path" ynh_app_setting_set $app domain $domain
ynh_app_setting_set $app path $path_url
# Check final_path availibility. Installation stops if it already exists #===================================================
CHECK_FINALPATH # CREATE APP USER
sudo mkdir "$final_path" #===================================================
### Nginx ### ynh_system_user_create $app "$final_path"
nginxconf="../conf/nginx.conf" sudo usermod -a -G www-data $app
if [ $path = "/" ]; then
sed -i "s@YNH_WWW_ROOTPATH@@g" ../conf/nginx.conf #=================================================
sed -i "s@YNH_WWW_ROOTAPP@/@g" ../conf/nginx.conf # COMPOSER INSTALLATION
#=================================================
composer_path=/opt/${app}_composer
# Test if composer is installed
if ! type "${composer_path}/composer" > /dev/null; then
# Prepare composer directories
sudo mkdir -p $composer_path
sudo mkdir -p $composer_path/cache
sudo chown -R $app:www-data $composer_path
sudo chmod -R 0775 $composer_path
# Install composer (https://getcomposer.org)
EXPECTED_SIGNATURE=$(wget https://composer.github.io/installer.sig -O - -q)
php -r "copy('https://getcomposer.org/installer', '$composer_path/composer-setup.php');"
ACTUAL_SIGNATURE=$(php -r "echo hash_file('SHA384', '$composer_path/composer-setup.php');")
if [ "$EXPECTED_SIGNATURE" = "$ACTUAL_SIGNATURE" ]
then
exec_as $app \
php $composer_path/composer-setup.php --install-dir=$composer_path --filename=composer --quiet
RESULT=$?
else else
sed -i "s@YNH_WWW_ROOTPATH@$path@g" ../conf/nginx.conf >&2 echo 'ERROR: Invalid Composer installer signature'
sed -i "s@YNH_WWW_ROOTAPP@$path$path@g" ../conf/nginx.conf RESULT=1
fi
if [ $RESULT != 0 ]
then
ynh_die 'Composer could not be installed'
fi fi
sed -i "s@YNH_WWW_PATH@$path@g" $nginxconf
sed -i "s@YNH_WWW_FINALPATH@$final_path@g" $nginxconf
sed -i "s@YNH_WWW_APP@$app@g" $nginxconf
sudo cp $nginxconf /etc/nginx/conf.d/$domain.d/$app.conf
### PHP ### fi
sed -i "s@YNH_WWW_APP@$app@g" ../conf/php-fpm.conf
sed -i "s@YNH_WWW_ALIAS@$final_path@g" ../conf/php-fpm.conf COMPOSER_HOME=$composer_path
#=================================================
# FLARUM INSTALLATION
#=================================================
# Prepare Flarum temp directory
tmp=/tmp/$app
sudo mkdir -p $tmp
sudo chown -R $app:www-data $tmp
sudo chmod -R 0775 $tmp
# Install Flarum
CWD="$(pwd)"
cd $tmp
exec_as $app \
php -d memory_limit=-1 $composer_path/composer create-project flarum/flarum . "$flarum_version" --stability=beta --ansi
cd $CWD
sudo cp -Rf $tmp/* $final_path
sudo chown -R $app:www-data $final_path
sudo chmod 0775 -R $final_path
ynh_secure_remove "$tmp"
#=================================================
# CREATE A MYSQL DATABASE
#=================================================
db_name=$(ynh_sanitize_dbid $app)
ynh_app_setting_set $app db_name $db_name
ynh_mysql_setup_db $db_name $db_name
ynh_app_setting_set "$app" db_pwd "$db_pwd"
#=================================================
# NGINX CONFIGURATION
#=================================================
finalnginxconf="/etc/nginx/conf.d/$domain.d/$app.conf"
sudo cp ../conf/nginx.conf "$finalnginxconf"
if [ $path_url = "/" ]; then
sed -i "s@YNH_WWW_ROOTPATH@@g" $finalnginxconf
sed -i "s@YNH_WWW_ROOTAPP@/@g" $finalnginxconf
else
sed -i "s@YNH_WWW_ROOTPATH@$path_url@g" $finalnginxconf
sed -i "s@YNH_WWW_ROOTAPP@$path_url$path_url@g" $finalnginxconf
fi
sed -i "s@YNH_WWW_PATH@$path_url@g" $finalnginxconf
sed -i "s@YNH_WWW_FINALPATH@$final_path@g" $finalnginxconf
sed -i "s@YNH_WWW_APP@$app@g" $finalnginxconf
#=================================================
# PHP-FPM CONFIGURATION
#=================================================
finalphpconf=/etc/php5/fpm/pool.d/$app.conf finalphpconf=/etc/php5/fpm/pool.d/$app.conf
sudo cp ../conf/php-fpm.conf $finalphpconf sudo cp ../conf/php-fpm.conf $finalphpconf
sed -i "s@YNH_WWW_APP@$app@g" $finalphpconf
sed -i "s@YNH_WWW_ALIAS@$final_path@g" $finalphpconf
sudo chown root: $finalphpconf sudo chown root: $finalphpconf
sudo chmod 644 $finalphpconf sudo chmod 644 $finalphpconf
sudo service php5-fpm reload sudo service php5-fpm reload
tmp=/tmp/flaruminstall #=================================================
sudo rm -rf $tmp # SETUP SSOWAT
sudo mkdir -p $tmp #=================================================
sudo chown -R www-data:www-data $tmp
sudo chmod -R 755 $tmp
# Prepare composer and cache directories
compo=$final_path/.composer
COMPOSER_HOME=$compo
sudo mkdir -p $compo/cache
sudo chown -R www-data:www-data $compo
sudo chmod -R 755 $compo
### composer ###
#if ! type "composer" > /dev/null; then
# Install composer (https://getcomposer.org)
EXPECTED_SIGNATURE=$(wget https://composer.github.io/installer.sig -O - -q)
sudo php -r "copy('https://getcomposer.org/installer', '$compo/composer-setup.php');"
ACTUAL_SIGNATURE=$(php -r "echo hash_file('SHA384', '$compo/composer-setup.php');")
if [ "$EXPECTED_SIGNATURE" = "$ACTUAL_SIGNATURE" ]
then
sudo php $compo/composer-setup.php --install-dir=$compo --filename=composer
RESULT=$?
else
>&2 echo 'ERROR: Invalid installer signature'
RESULT=1
fi
if [ $RESULT != 0 ]
then
ynh_die
fi
#fi
### composer end ###
### Install flarum
cwd=$(pwd)
sudo su - www-data -s /bin/bash -c "mkdir -p $tmp/$app && cd $tmp/$app && php -d memory_limit=-1 $compo/composer create-project flarum/flarum . --stability=beta"
sudo cp -Rf $tmp/$app $www_path/
sudo chown -R www-data:www-data $final_path
cd $cwd
sudo rm -rf $tmp
### MySQL ###
dbuser=$app
dbname=$app
dbpass=$(ynh_string_random 15)
ynh_app_setting_set "$app" mysqlpwd "$dbpass"
ynh_mysql_create_db "$dbname" "$dbuser" "$dbpass"
# If app is public, add url to SSOWat conf as skipped_uris # If app is public, add url to SSOWat conf as skipped_uris
if [[ $is_public -eq 1 ]]; then if [[ $is_public -eq 1 ]]; then
@ -129,37 +169,42 @@ if [[ $is_public -eq 1 ]]; then
ynh_app_setting_set "$app" unprotected_uris "/" ynh_app_setting_set "$app" unprotected_uris "/"
fi fi
ynh_app_setting_set "$app" skipped_uris "/api" ynh_app_setting_set "$app" skipped_uris "/api"
sudo yunohost app ssowatconf
# Reload services # Reload services
sudo service nginx reload service nginx reload
# Install the SSOwat auth extension # Install the SSOwat auth extension
#sudo su - www-data -s /bin/bash -c "cd $final_path && php -d memory_limit=-1 $compo/composer require 'tituspijean/flarum-ext-auth-ssowat:*@dev'" #sudo su - www-data -s /bin/bash -c "cd $final_path && php -d memory_limit=-1 $composer_path/composer require 'tituspijean/flarum-ext-auth-ssowat:*@dev'"
### POST-INSTALL ### #=================================================
# FLARUM POST-INSTALL
#=================================================
# Only if admin user or title were specified
if [[ -n $admin && -n $title ]]; then if [[ -n $admin && -n $title ]]; then
adminpass=$(ynh_string_random 8) finalflarumconf="$final_path/configuration.yml"
sed -i "s@YNH_APP_DOMAIN@$domain@g" ../sources/configuration.yml cp ../sources/configuration.yml $finalflarumconf
sed -i "s@/YNH_WWW_PATH@$path@g" ../sources/configuration.yml admin_pwd=$(ynh_string_random 8)
sed -i "s@YNH_WWW_APP@$app@g" ../sources/configuration.yml sed -i "s@YNH_APP_DOMAIN@$domain@g" $finalflarumconf
sed -i "s@YNH_DB_PASS@$dbpass@g" ../sources/configuration.yml sed -i "s@/YNH_WWW_PATH@$path_url@g" $finalflarumconf
sed -i "s@YNH_ADMIN_USER@$admin@g" ../sources/configuration.yml sed -i "s@YNH_WWW_APP@$app@g" $finalflarumconf
sed -i "s@YNH_ADMIN_PASS@$adminpass@g" ../sources/configuration.yml sed -i "s@YNH_DB_PASS@$db_pwd@g" $finalflarumconf
adminemail=$(ynh_user_get_info $admin mail) sed -i "s@YNH_ADMIN_USER@$admin@g" $finalflarumconf
sed -i "s%YNH_ADMIN_EMAIL%$adminemail%g" ../sources/configuration.yml sed -i "s@YNH_ADMIN_PASS@$admin_pwd@g" $finalflarumconf
sed -i "s@YNH_FORUM_TITLE@$title@g" ../sources/configuration.yml admin_mail=$(ynh_user_get_info $admin mail)
sudo cp ../sources/configuration.yml $final_path sed -i "s%YNH_ADMIN_EMAIL%$admin_mail%g" $finalflarumconf
sudo su - www-data -s /bin/bash -c "cd $final_path && php -d memory_limit=-1 flarum install -f configuration.yml" sed -i "s@YNH_FORUM_TITLE@$title@g" $finalflarumconf
sudo rm $final_path/configuration.yml cd "$final_path"
exec_as www-data \
php -d memory_limit=-1 flarum install -f configuration.yml
# Generate and add root token for user creation and deletion # Generate and add root token for user creation and deletion
#roottoken=$(ynh_string_random 40) roottoken=$(ynh_string_random 40)
#apitablesql="CREATE TABLE IF NOT EXISTS api_keys (api_key TEXT(40) NOT NULL UNIQUE)" apitablesql="CREATE TABLE IF NOT EXISTS api_keys (api_key TEXT(40) NOT NULL)"
#rootsql="INSERT INTO api_keys VALUES ('"$roottoken"')" rootsql="INSERT INTO api_keys VALUES ('"$roottoken"')"
#ynh_mysql_execute_as_root "$apitablesql" $dbname ynh_mysql_execute_as_root "$apitablesql" $db_name
#ynh_mysql_execute_as_root "$rootsql" $dbname ynh_mysql_execute_as_root "$rootsql" $db_name
#ynh_app_setting_set "$app" root_token "$roottoken" ynh_app_setting_set "$app" root_token "$roottoken"
# Configure SSOwat auth extension # Configure SSOwat auth extension
#ssowatdomain=$(</etc/yunohost/current_host) #ssowatdomain=$(</etc/yunohost/current_host)
@ -175,21 +220,22 @@ sudo rm $final_path/configuration.yml
#fi #fi
# Create missing users # Create missing users
#for username in $(ynh_user_list); do for username in $(ynh_user_list); do
# if [ "$username" == "$admin" ]; then continue; else if [ "$username" == "$admin" ]; then continue; else
# userpass=$(ynh_string_random 16) userpass=$(ynh_string_random 16)
# usermail=$(ynh_user_get_info $username 'mail') usermail=$(ynh_user_get_info $username 'mail')
# data='{"data":{"attributes":{"username":"'$username'","email":"'$usermail'","password":"'$userpass'"}}}' data='{"data":{"attributes":{"username":"'$username'","email":"'$usermail'","password":"'$userpass'"}}}'
# rep=$(curl -s -o /dev/null -w "%{http_code}" -k -i \ rep=$(curl -s -o /dev/null -w "%{http_code}" -k -i \
# -H "Content-Type: application/json" \ -H "Content-Type: application/json" \
# -H "Authentication: Token $roottoken" \ -H "Authentication: Token $roottoken" \
# -X POST -d "$data" \ -X POST -d "$data" \
# -L https://${domain}${path}/api/users ) -L https://${domain}${path}/api/users )
# if [[ $rep != 201 ]]; then if [[ $rep != 201 ]]; then
# ynh_die "ERROR: Flarum account creation failed for $username" ynh_die "ERROR: Flarum account creation failed for $username"
# fi fi
# fi fi
#done done
>&2 echo "Installation successfull. Admin : $admin, password : $admin_pwd. Change it!"
else
>&2 echo "Installation successfull. Post-installation required, visit your Flarum instance!"
fi fi
>&2 echo "Admin : $admin, password : $adminpass. Change it!"

55
scripts/remove
View file

@ -6,59 +6,20 @@ app=$YNH_APP_INSTANCE_NAME
# Source YunoHost helpers # Source YunoHost helpers
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
SECURE_REMOVE () { # Suppression de dossier avec vérification des variables
chaine="$1" # L'argument doit être donné entre quotes simple '', pour éviter d'interpréter les variables.
no_var=0
while (echo "$chaine" | grep -q '\$') # Boucle tant qu'il y a des $ dans la chaine
do
no_var=1
global_var=$(echo "$chaine" | cut -d '$' -f 2) # Isole la première variable trouvée.
only_var=\$$(expr "$global_var" : '\([A-Za-z0-9_]*\)') # Isole complètement la variable en ajoutant le $ au début et en gardant uniquement le nom de la variable. Se débarrasse surtout du / et d'un éventuel chemin derrière.
real_var=$(eval "echo ${only_var}") # `eval "echo ${var}` permet d'interpréter une variable contenue dans une variable.
if test -z "$real_var" || [ "$real_var" = "/" ]; then
echo "Variable $only_var is empty, suppression of $chaine cancelled." >&2
return 1
fi
chaine=$(echo "$chaine" | sed "s@$only_var@$real_var@") # remplace la variable par sa valeur dans la chaine.
done
if [ "$no_var" -eq 1 ]
then
if [ -e "$chaine" ]; then
echo "Delete directory $chaine"
sudo rm -r "$chaine"
fi
return 0
else
echo "No detected variable." >&2
return 1
fi
}
REMOVE_NGINX_CONF () { # Suppression de la configuration nginx
if [ -e "/etc/nginx/conf.d/$domain.d/$app.conf" ]; then # Delete nginx config
echo "Delete nginx config"
sudo rm "/etc/nginx/conf.d/$domain.d/$app.conf"
fi
}
REMOVE_FPM_CONF () { # Suppression de la configuration du pool php-fpm
if [ -e "/etc/php5/fpm/pool.d/$app.conf" ]; then # Delete fpm config
echo "Delete fpm config"
sudo rm "/etc/php5/fpm/pool.d/$app.conf"
fi
}
# Retrieve app settings # Retrieve app settings
domain=$(ynh_app_setting_get "$app" domain) domain=$(ynh_app_setting_get "$app" domain)
# Delete user
ynh_system_user_delete $app
# Remove sources # Remove sources
SECURE_REMOVE "/tmp/composerinstall" ynh_secure_remove "/tmp/$app"
SECURE_REMOVE "/var/www/$app" ynh_secure_remove "/var/www/$app"
SECURE_REMOVE "/opt/${app}_composer" ynh_secure_remove "/opt/${app}_composer"
# Remove nginx and PHP-FPM files and restart services # Remove nginx and PHP-FPM files and restart services
REMOVE_NGINX_CONF ynh_remove_nginx_config
REMOVE_FPM_CONF ynh_remove_fpm_config
sudo service nginx reload sudo service nginx reload
sudo service php5-fpm reload sudo service php5-fpm reload