2019-01-29 21:56:56 +01:00
|
|
|
#!/bin/bash
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# GENERIC START
|
|
|
|
|
#=================================================
|
|
|
|
|
# IMPORT GENERIC HELPERS
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
source _common.sh
|
|
|
|
|
source /usr/share/yunohost/helpers
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# MANAGE SCRIPT FAILURE
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
ynh_clean_setup () {
|
|
|
|
|
### Remove this function if there's nothing to clean before calling the remove script.
|
|
|
|
|
true
|
|
|
|
|
}
|
|
|
|
|
# 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
|
|
|
|
|
path_url="/"
|
2019-01-30 03:40:47 +01:00
|
|
|
#admin=$YNH_APP_ARG_ADMIN
|
2019-01-29 21:56:56 +01:00
|
|
|
is_public=$YNH_APP_ARG_IS_PUBLIC
|
2019-01-30 03:40:47 +01:00
|
|
|
#language=$YNH_APP_ARG_LANGUAGE
|
|
|
|
|
#password=$YNH_APP_ARG_PASSWORD
|
2019-01-29 21:56:56 +01:00
|
|
|
|
|
|
|
|
### If it's 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 instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...)
|
|
|
|
|
### The app instance name is available as $YNH_APP_INSTANCE_NAME
|
|
|
|
|
### - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
|
|
|
|
|
### - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
|
|
|
|
|
### - ynhexample__{N} for the subsequent installations, with N=3,4, ...
|
|
|
|
|
### The app instance name is probably what interests you most, since this is
|
|
|
|
|
### guaranteed to be unique. This is a good unique identifier to define installation path,
|
|
|
|
|
### db names, ...
|
|
|
|
|
app=$YNH_APP_INSTANCE_NAME
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### If the app uses nginx as web server (written in HTML/PHP in most cases), the final path should be "/var/www/$app".
|
|
|
|
|
### If the app provides an internal web server (or uses another application server such as uwsgi), the final path should be "/opt/yunohost/$app"
|
|
|
|
|
final_path=/var/www/$app
|
|
|
|
|
test ! -e "$final_path" || ynh_die "This path already contains a folder"
|
|
|
|
|
|
|
|
|
|
# Normalize the url path syntax
|
|
|
|
|
path_url=$(ynh_normalize_url_path $path_url)
|
|
|
|
|
|
|
|
|
|
# Register (book) web path
|
|
|
|
|
ynh_webpath_register $app $domain $path_url
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# STORE SETTINGS FROM MANIFEST
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
ynh_app_setting_set $app domain $domain
|
|
|
|
|
ynh_app_setting_set $app path $path_url
|
2019-01-30 03:40:47 +01:00
|
|
|
#ynh_app_setting_set $app admin $admin
|
2019-01-29 21:56:56 +01:00
|
|
|
ynh_app_setting_set $app is_public $is_public
|
2019-01-30 03:40:47 +01:00
|
|
|
#ynh_app_setting_set $app language $language
|
2019-01-29 21:56:56 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# STANDARD MODIFICATIONS
|
|
|
|
|
#=================================================
|
|
|
|
|
# FIND AND OPEN A PORT
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### Use these lines if you have to open a port for the application
|
|
|
|
|
### `ynh_find_port` will find the first available port starting from the given port.
|
|
|
|
|
### If you're not using these lines:
|
|
|
|
|
### - Remove the section "CLOSE A PORT" in the remove script
|
|
|
|
|
|
|
|
|
|
# Find a free port
|
|
|
|
|
port=$(ynh_find_port 8095)
|
|
|
|
|
# Open this port
|
|
|
|
|
#yunohost firewall allow --no-upnp TCP $port 2>&1
|
|
|
|
|
ynh_app_setting_set $app port $port
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# INSTALL DEPENDENCIES
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### `ynh_install_app_dependencies` allows you to add any "apt" dependencies to the package.
|
|
|
|
|
### Those deb packages will be installed as dependencies of this package.
|
|
|
|
|
### If you're not using this helper:
|
|
|
|
|
### - Remove the section "REMOVE DEPENDENCIES" in the remove script
|
|
|
|
|
### - As well as the section "REINSTALL DEPENDENCIES" in the restore script
|
|
|
|
|
### - And the section "UPGRADE DEPENDENCIES" in the upgrade script
|
|
|
|
|
|
2019-01-30 04:29:34 +01:00
|
|
|
ynh_install_app_dependencies redis-server postgresql postgresql-contrib
|
2019-01-29 21:56:56 +01:00
|
|
|
ynh_install_nodejs 10
|
|
|
|
|
|
|
|
|
|
#=================================================
|
2019-01-30 00:59:43 +01:00
|
|
|
# CREATE A POSTGRESQL DATABASE
|
2019-01-29 21:56:56 +01:00
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### Use these lines if you need a database for the application.
|
|
|
|
|
### `ynh_mysql_setup_db` will create a database, an associated user and a ramdom password.
|
|
|
|
|
### The password will be stored as 'mysqlpwd' into the app settings,
|
|
|
|
|
### and will be available as $db_pwd
|
|
|
|
|
### If you're not using these lines:
|
2019-01-30 00:59:43 +01:00
|
|
|
### - Remove the section "BACKUP THE POSTGRESQL DATABASE" in the backup script
|
|
|
|
|
### - Remove also the section "REMOVE THE POSTGRESQL DATABASE" in the remove script
|
|
|
|
|
### - As well as the section "RESTORE THE POSTGRESQL DATABASE" in the restore script
|
2019-01-29 21:56:56 +01:00
|
|
|
|
|
|
|
|
db_name=$(ynh_sanitize_dbid $app)
|
2019-01-30 00:59:43 +01:00
|
|
|
db_pwd=$(ynh_string_random 30)
|
2019-01-30 01:45:12 +01:00
|
|
|
ynh_app_setting_set "$app" db_name "$db_name"
|
|
|
|
|
ynh_app_setting_set "$app" db_pwd "$db_pwd"
|
2019-01-30 00:59:43 +01:00
|
|
|
ynh_psql_test_if_first_run
|
|
|
|
|
ynh_psql_create_db "$db_name" "$db_name" "$db_pwd"
|
2019-01-29 21:56:56 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# DOWNLOAD, CHECK AND UNPACK SOURCE
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### `ynh_setup_source` is used to install an app from a zip or tar.gz file,
|
|
|
|
|
### downloaded from an upstream source, like a git repository.
|
|
|
|
|
### `ynh_setup_source` use the file conf/app.src
|
|
|
|
|
|
|
|
|
|
ynh_app_setting_set $app final_path $final_path
|
|
|
|
|
# Download, check integrity, uncompress and patch the source from app.src
|
|
|
|
|
#ynh_setup_source "$final_path"
|
2019-01-29 22:09:48 +01:00
|
|
|
git clone https://github.com/Requarks/wiki "$final_path"
|
2019-01-29 21:56:56 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# NGINX CONFIGURATION
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### `ynh_add_nginx_config` will use the file conf/nginx.conf
|
|
|
|
|
|
|
|
|
|
# Create a dedicated nginx config
|
|
|
|
|
ynh_add_nginx_config
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# CREATE DEDICATED USER
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
# Create a system user
|
|
|
|
|
ynh_system_user_create $app
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# PHP-FPM CONFIGURATION
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### `ynh_add_fpm_config` is used to set up a PHP config.
|
|
|
|
|
### You can remove it if your app doesn't use PHP.
|
|
|
|
|
### `ynh_add_fpm_config` will use the files conf/php-fpm.conf and conf/php-fpm.ini
|
|
|
|
|
### If you're not using these lines:
|
|
|
|
|
### - You can remove these files in conf/.
|
|
|
|
|
### - Remove the section "BACKUP THE PHP-FPM CONFIGURATION" in the backup script
|
|
|
|
|
### - Remove also the section "REMOVE PHP-FPM CONFIGURATION" in the remove script
|
|
|
|
|
### - As well as the section "RESTORE THE PHP-FPM CONFIGURATION" in the restore script
|
|
|
|
|
### With the reload at the end of the script.
|
|
|
|
|
### - And the section "PHP-FPM CONFIGURATION" in the upgrade script
|
|
|
|
|
|
|
|
|
|
# Create a dedicated php-fpm config
|
|
|
|
|
#ynh_add_fpm_config
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SPECIFIC SETUP
|
|
|
|
|
#=================================================
|
|
|
|
|
# ...
|
|
|
|
|
#=================================================
|
|
|
|
|
|
2019-01-30 17:18:41 +01:00
|
|
|
pushd $final_path
|
2019-01-30 17:23:36 +01:00
|
|
|
ynh_use_nodejs
|
2019-01-30 18:05:59 +01:00
|
|
|
$nodejs_path/npm install "graphql@^0.13.1"
|
|
|
|
|
$nodejs_path/npm install "acorn@^6.0.0"
|
|
|
|
|
$nodejs_path/npm install "babel-core@>=6.0.20"
|
|
|
|
|
$nodejs_path/npm install "eslint@>=5.0.0"
|
|
|
|
|
$nodejs_path/npm install
|
|
|
|
|
$nodejs_path/npm audit fix
|
|
|
|
|
$nodejs_path/npm run build
|
2019-01-30 01:05:02 +01:00
|
|
|
popd
|
|
|
|
|
|
|
|
|
|
|
2019-01-29 21:56:56 +01:00
|
|
|
#=================================================
|
|
|
|
|
# SETUP SYSTEMD
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### `ynh_systemd_config` is used to configure a systemd script for an app.
|
|
|
|
|
### It can be used for apps that use sysvinit (with adaptation) or systemd.
|
|
|
|
|
### Have a look at the app to be sure this app needs a systemd script.
|
|
|
|
|
### `ynh_systemd_config` will use the file conf/systemd.service
|
|
|
|
|
### If you're not using these lines:
|
|
|
|
|
### - You can remove those files in conf/.
|
|
|
|
|
### - Remove the section "BACKUP SYSTEMD" in the backup script
|
|
|
|
|
### - Remove also the section "STOP AND REMOVE SERVICE" in the remove script
|
|
|
|
|
### - As well as the section "RESTORE SYSTEMD" in the restore script
|
|
|
|
|
### - And the section "SETUP SYSTEMD" in the upgrade script
|
|
|
|
|
|
|
|
|
|
# Create a dedicated systemd config
|
2019-01-30 03:11:47 +01:00
|
|
|
ynh_replace_string "__NODEJS_PATH__" "$nodejs_path" "../conf/systemd.service"
|
|
|
|
|
ynh_add_systemd_config
|
2019-01-29 21:56:56 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SETUP APPLICATION WITH CURL
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### Use these lines only if the app installation needs to be finalized through
|
|
|
|
|
### web forms. We generally don't want to ask the final user,
|
|
|
|
|
### so we're going to use curl to automatically fill the fields and submit the
|
|
|
|
|
### forms.
|
|
|
|
|
|
|
|
|
|
# Set right permissions for curl install
|
|
|
|
|
#chown -R $app: $final_path
|
|
|
|
|
|
|
|
|
|
# Set the app as temporarily public for curl call
|
|
|
|
|
#ynh_app_setting_set $app skipped_uris "/"
|
|
|
|
|
# Reload SSOwat config
|
|
|
|
|
#yunohost app ssowatconf
|
|
|
|
|
|
|
|
|
|
# Reload Nginx
|
|
|
|
|
#systemctl reload nginx
|
|
|
|
|
|
|
|
|
|
# Installation with curl
|
|
|
|
|
#ynh_local_curl "/INSTALL_PATH" "key1=value1" "key2=value2" "key3=value3"
|
|
|
|
|
|
|
|
|
|
# Remove the public access
|
|
|
|
|
#if [ $is_public -eq 0 ]
|
|
|
|
|
#then
|
|
|
|
|
# ynh_app_setting_delete $app skipped_uris
|
|
|
|
|
#fi
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# MODIFY A CONFIG FILE
|
|
|
|
|
#=================================================
|
|
|
|
|
|
2019-01-29 22:02:01 +01:00
|
|
|
cp -f ../conf/config.sample.yml "$final_path/config.yml"
|
2019-01-29 21:56:56 +01:00
|
|
|
|
|
|
|
|
### `ynh_replace_string` is used to replace a string in a file.
|
|
|
|
|
### (It's compatible with sed regular expressions syntax)
|
|
|
|
|
|
|
|
|
|
#ynh_replace_string "match_string" "replace_string" "$final_path/config.yml"
|
|
|
|
|
ynh_replace_string "__PORT__" "$port" "$final_path/config.yml"
|
|
|
|
|
ynh_replace_string "__DB_PWD__" "$db_pwd" "$final_path/config.yml"
|
|
|
|
|
ynh_replace_string "__DB_NAME__" "$db_name" "$final_path/config.yml"
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# STORE THE CONFIG FILE CHECKSUM
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### `ynh_store_file_checksum` is used to store the checksum of a file.
|
|
|
|
|
### That way, during the upgrade script, by using `ynh_backup_if_checksum_is_different`,
|
|
|
|
|
### you can make a backup of this file before modifying it again if the admin had modified it.
|
|
|
|
|
|
|
|
|
|
# Calculate and store the config file checksum into the app settings
|
|
|
|
|
ynh_store_file_checksum "$final_path/config.yml"
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# GENERIC FINALIZATION
|
|
|
|
|
#=================================================
|
|
|
|
|
# SECURE FILES AND DIRECTORIES
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### For security reason, any app should set the permissions to root: before anything else.
|
|
|
|
|
### Then, if write authorization is needed, any access should be given only to directories
|
|
|
|
|
### that really need such authorization.
|
|
|
|
|
|
|
|
|
|
# Set permissions to app files
|
|
|
|
|
chown -R $app: $final_path
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SETUP LOGROTATE
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### `ynh_use_logrotate` is used to configure a logrotate configuration for the logs of this app.
|
|
|
|
|
### Use this helper only if there is effectively a log file for this app.
|
|
|
|
|
### If you're not using this helper:
|
|
|
|
|
### - Remove the section "BACKUP LOGROTATE" in the backup script
|
|
|
|
|
### - Remove also the section "REMOVE LOGROTATE CONFIGURATION" in the remove script
|
|
|
|
|
### - As well as the section "RESTORE THE LOGROTATE CONFIGURATION" in the restore script
|
|
|
|
|
### - And the section "SETUP LOGROTATE" in the upgrade script
|
|
|
|
|
|
|
|
|
|
# Use logrotate to manage application logfile(s)
|
|
|
|
|
ynh_use_logrotate
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# ADVERTISE SERVICE IN ADMIN PANEL
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
### `yunohost service add` is a CLI yunohost command to add a service in the admin panel.
|
|
|
|
|
### You'll find the service in the 'services' section of YunoHost admin panel.
|
|
|
|
|
### This CLI command would be useless if the app does not have any services (systemd or sysvinit)
|
|
|
|
|
### If you're not using these lines:
|
|
|
|
|
### - You can remove these files in conf/.
|
|
|
|
|
### - Remove the section "REMOVE SERVICE FROM ADMIN PANEL" in the remove script
|
|
|
|
|
### - As well as the section ADVERTISE SERVICE IN ADMIN PANEL" in the restore script
|
|
|
|
|
|
|
|
|
|
#yunohost service add $app --log "/var/log/$app/$app.log"
|
|
|
|
|
# if using yunohost version 3.2 or more in the 'manifest.json', a description can be added
|
2019-01-30 03:28:38 +01:00
|
|
|
yunohost service add $app --description "$app daemon for Wiki.js" --log "/var/log/$app/$app.log"
|
2019-01-29 21:56:56 +01:00
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# SETUP SSOWAT
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
# Make app public if necessary
|
|
|
|
|
if [ $is_public -eq 1 ]
|
|
|
|
|
then
|
|
|
|
|
# unprotected_uris allows SSO credentials to be passed anyway.
|
|
|
|
|
ynh_app_setting_set $app unprotected_uris "/"
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# RELOAD NGINX
|
|
|
|
|
#=================================================
|
2019-01-30 03:28:38 +01:00
|
|
|
systemctl start $app
|
2019-01-29 21:56:56 +01:00
|
|
|
systemctl reload nginx
|
