1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/wikijs_ynh.git synced 2024-09-03 20:36:09 +02:00

Update to last example_ynh

This commit is contained in:
yalh76 2019-02-19 00:20:09 +01:00
parent 19f4ddaf62
commit e3ae55a472
8 changed files with 56 additions and 61 deletions

View file

@ -19,10 +19,6 @@ An open source, modern and powerful wiki app built on Node.js, Git and Markdown
![wikijs-screenshot2](https://user-images.githubusercontent.com/30271971/52230062-beb1e800-28b6-11e9-99c1-2bd04857600e.png)
## License
**LICENSE:** AGPL-3.0-or-later
## Demo
* [Official demo](https://docs-beta.requarks.io/)

View file

@ -1,7 +1,7 @@
#!/bin/bash
#=================================================
# PERSONNAL HELPERS
# PERSONAL HELPERS
#=================================================
#=================================================
@ -9,5 +9,5 @@
#=================================================
#=================================================
# FUTUR OFFICIAL HELPERS
# FUTURE OFFICIAL HELPERS
#=================================================

View file

@ -24,7 +24,7 @@ ynh_abort_if_errors
#=================================================
# LOAD SETTINGS
#=================================================
ynh_print_info "Load settings"
ynh_print_info "Loading installation settings..."
app=$YNH_APP_INSTANCE_NAME
@ -37,28 +37,28 @@ db_name=$(ynh_app_setting_get $app db_name)
#=================================================
# BACKUP THE APP MAIN DIR
#=================================================
ynh_print_info "Backup the app main dir"
ynh_print_info "Backing up the main app directory..."
ynh_backup "$final_path"
#=================================================
# BACKUP THE NGINX CONFIGURATION
#=================================================
ynh_print_info "Backup nginx configuration"
ynh_print_info "Backing up nginx web server configuration..."
ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"
#=================================================
# BACKUP THE PHP-FPM CONFIGURATION
#=================================================
ynh_print_info "Backup php-fpm configuration"
ynh_print_info "Backing up php-fpm configuration..."
#ynh_backup "/etc/php/7.0/fpm/pool.d/$app.conf"
#=================================================
# BACKUP THE POSTGRESQL DATABASE
#=================================================
ynh_print_info "Backup the postgresql database"
ynh_print_info "Backing up the PostgreSQL database..."
ynh_psql_dump_db "$db_name" > db.sql
@ -67,14 +67,14 @@ ynh_psql_dump_db "$db_name" > db.sql
#=================================================
# BACKUP LOGROTATE
#=================================================
ynh_print_info "Backup logrotate configuration"
ynh_print_info "Backing up logrotate configuration..."
ynh_backup "/etc/logrotate.d/$app"
#=================================================
# BACKUP SYSTEMD
#=================================================
ynh_print_info "Backup systemd configuration"
ynh_print_info "Backing up systemd configuration..."
ynh_backup "/etc/systemd/system/$app.service"
@ -88,4 +88,4 @@ ynh_backup "/etc/systemd/system/$app.service"
# END OF SCRIPT
#=================================================
ynh_print_info "Backup script completed. Please wait for YunoHost to create the backup."
ynh_print_info "Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."

View file

@ -25,7 +25,7 @@ app=$YNH_APP_INSTANCE_NAME
#=================================================
# LOAD SETTINGS
#=================================================
ynh_print_info "Load settings"
ynh_print_info "Loading installation settings..."
# Needed for helper "ynh_add_nginx_config"
final_path=$(ynh_app_setting_get $app final_path)
@ -37,7 +37,6 @@ final_path=$(ynh_app_setting_get $app final_path)
#=================================================
# CHECK THE SYNTAX OF THE PATHS
#=================================================
ynh_print_info "Check the syntax of the paths"
test -n "$old_path" || old_path="/"
test -n "$new_path" || new_path="/"
@ -65,7 +64,7 @@ fi
#=================================================
# MODIFY URL IN NGINX CONF
#=================================================
ynh_print_info "Modify url in nginx configuration"
ynh_print_info "Updating nginx web server configuration..."
nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
@ -102,7 +101,7 @@ fi
#=================================================
# RELOAD NGINX
#=================================================
ynh_print_info "Reload nginx"
ynh_print_info "Reloading nginx web server..."
systemctl reload nginx
@ -110,4 +109,4 @@ systemctl reload nginx
# END OF SCRIPT
#=================================================
ynh_print_info "Change of url completed"
ynh_print_info "Change of URL completed for $app"

View file

@ -24,7 +24,6 @@ ynh_abort_if_errors
#=================================================
# RETRIEVE ARGUMENTS FROM THE MANIFEST
#=================================================
ynh_print_info "Retrieve arguments from the manifest ..."
domain=$YNH_APP_ARG_DOMAIN
path_url="/"
@ -48,7 +47,7 @@ app=$YNH_APP_INSTANCE_NAME
#=================================================
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
#=================================================
ynh_print_info "Validating arguments ..."
ynh_print_info "Validating installation parameters..."
### 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"
@ -64,7 +63,7 @@ ynh_webpath_register $app $domain $path_url
#=================================================
# STORE SETTINGS FROM MANIFEST
#=================================================
ynh_print_info "Store settings from manifest ..."
ynh_print_info "Storing installation settings..."
ynh_app_setting_set $app domain $domain
ynh_app_setting_set $app path $path_url
@ -93,6 +92,7 @@ ynh_app_setting_set $app port $port
#=================================================
# INSTALL DEPENDENCIES
#=================================================
ynh_print_info "Installing 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.
@ -111,7 +111,7 @@ ynh_install_app_dependencies yarn redis-server postgresql postgresql-contrib bui
#=================================================
# CREATE A POSTGRESQL DATABASE
#=================================================
ynh_print_info "Creating a postgresql database ..."
ynh_print_info "Creating a PostgreSQL database..."
### 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.
@ -145,7 +145,7 @@ ynh_setup_source "$final_path"
#=================================================
# NGINX CONFIGURATION
#=================================================
ynh_print_info "Configuring nginx ..."
ynh_print_info "Configuring nginx web server..."
### `ynh_add_nginx_config` will use the file conf/nginx.conf
@ -325,7 +325,7 @@ ynh_use_logrotate
### 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
### - 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
@ -346,7 +346,7 @@ fi
#=================================================
# RELOAD NGINX
#=================================================
ynh_print_info "Reloading nginx ..."
ynh_print_info "Reloading nginx web server..."
systemctl reload nginx
@ -360,4 +360,4 @@ ynh_systemd_action --action=start --service_name=$app --line_match="Redis connec
# END OF SCRIPT
#=================================================
ynh_print_info "Installation completed"
ynh_print_info "Installation of $app completed"

View file

@ -13,7 +13,7 @@ source /usr/share/yunohost/helpers
#=================================================
# LOAD SETTINGS
#=================================================
ynh_print_info "Load settings"
ynh_print_info "Loading installation settings..."
app=$YNH_APP_INSTANCE_NAME
@ -31,14 +31,14 @@ final_path=$(ynh_app_setting_get $app final_path)
# Remove a service from the admin panel, added by `yunohost service add`
if yunohost service status | grep -q $app
then
ynh_print_info "Remove $app service"
ynh_print_info "Removing $app service"
yunohost service remove $app
fi
#=================================================
# STOP AND REMOVE SERVICE
#=================================================
ynh_print_info "Stop and remove the service"
ynh_print_info "Stopping and removing the systemd service"
# Remove the dedicated systemd config
ynh_remove_systemd_config
@ -46,7 +46,7 @@ ynh_remove_systemd_config
#=================================================
# REMOVE THE POSTGRESQL DATABASE
#=================================================
ynh_print_info "Remove the postgresql database"
ynh_print_info "Removing the PostgreSQL database"
# Remove a database if it exists, along with the associated user
ynh_psql_remove_db "$db_name" "$db_name"
@ -55,7 +55,7 @@ ynh_psql_drop_user "$db_name"
#=================================================
# REMOVE DEPENDENCIES
#=================================================
ynh_print_info "Remove dependencies"
ynh_print_info "Removing dependencies"
# Remove metapackage and its dependencies
ynh_remove_app_dependencies
@ -67,7 +67,7 @@ ynh_secure_remove "/etc/apt/sources.list.d/yarn.list"
#=================================================
# REMOVE APP MAIN DIR
#=================================================
ynh_print_info "Remove app main directory"
ynh_print_info "Removing app main directory"
# Remove the app directory securely
ynh_secure_remove "$final_path"
@ -75,7 +75,7 @@ ynh_secure_remove "$final_path"
#=================================================
# REMOVE NGINX CONFIGURATION
#=================================================
ynh_print_info "Remove nginx configuration"
ynh_print_info "Removing nginx web server configuration"
# Remove the dedicated nginx config
ynh_remove_nginx_config
@ -83,7 +83,7 @@ ynh_remove_nginx_config
#=================================================
# REMOVE PHP-FPM CONFIGURATION
#=================================================
ynh_print_info "Remove php-fpm configuration"
ynh_print_info "Removing php-fpm configuration"
# Remove the dedicated php-fpm config
#ynh_remove_fpm_config
@ -91,7 +91,7 @@ ynh_print_info "Remove php-fpm configuration"
#=================================================
# REMOVE LOGROTATE CONFIGURATION
#=================================================
ynh_print_info "Remove logrotate configuration"
ynh_print_info "Removing logrotate configuration"
# Remove the app-specific logrotate config
ynh_remove_logrotate
@ -99,11 +99,10 @@ ynh_remove_logrotate
#=================================================
# CLOSE A PORT
#=================================================
ynh_print_info "Close ports"
if yunohost firewall list | grep -q "\- $port$"
then
ynh_print_info "Close port $port"
ynh_print_info "Closing port $port"
ynh_exec_warn_less yunohost firewall disallow TCP $port
fi
@ -127,7 +126,7 @@ ynh_secure_remove "/var/log/$app/"
#=================================================
# REMOVE DEDICATED USER
#=================================================
ynh_print_info "Remove the dedicated user"
ynh_print_info "Removing the dedicated system user"
# Delete a system user
ynh_system_user_delete $app
@ -136,4 +135,4 @@ ynh_system_user_delete $app
# END OF SCRIPT
#=================================================
ynh_print_info "Deletion completed"
ynh_print_info "Removal of $app completed"

View file

@ -24,7 +24,7 @@ ynh_abort_if_errors
#=================================================
# LOAD SETTINGS
#=================================================
ynh_print_info "Load settings"
ynh_print_info "Loading settings..."
app=$YNH_APP_INSTANCE_NAME
@ -37,6 +37,7 @@ db_pwd=$(ynh_app_setting_get $app db_pwd)
#=================================================
# CHECK IF THE APP CAN BE RESTORED
#=================================================
ynh_print_info "Validating restoration parameters..."
ynh_webpath_available $domain $path_url \
|| ynh_die "Path not available: ${domain}${path_url}"
@ -54,14 +55,14 @@ ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf"
#=================================================
# RESTORE THE APP MAIN DIR
#=================================================
ynh_print_info "Restore the app main directory"
ynh_print_info "Restoring the app main directory..."
ynh_restore_file "$final_path"
#=================================================
# RECREATE THE DEDICATED USER
#=================================================
ynh_print_info "Recreate the dedicated user"
ynh_print_info "Recreating the dedicated system user..."
# Create the dedicated user (if not existing)
ynh_system_user_create "$app" "$final_path"
@ -84,7 +85,7 @@ chown -R "$app":"$app" "$final_path"
#=================================================
# REINSTALL DEPENDENCIES
#=================================================
ynh_print_info "Reinstall dependencies"
ynh_print_info "Reinstalling dependencies..."
# Define and install dependencies
@ -98,7 +99,7 @@ ynh_install_app_dependencies yarn redis-server postgresql postgresql-contrib bui
#=================================================
# RESTORE THE POSTGRESQL DATABASE
#=================================================
ynh_print_info "Restore the postgresql database"
ynh_print_info "Restoring the PostgreSQL database..."
ynh_psql_test_if_first_run
ynh_psql_create_db "$db_name" "$db_name" "$db_pwd"
@ -107,7 +108,7 @@ ynh_psql_execute_file_as_root ./db.sql "$db_name"
#=================================================
# RESTORE SYSTEMD
#=================================================
ynh_print_info "Restore the systemd configuration"
ynh_print_info "Restoring the systemd configuration..."
ynh_restore_file "/etc/systemd/system/$app.service"
systemctl enable $app.service
@ -136,7 +137,7 @@ ynh_restore_file "/etc/logrotate.d/$app"
#=================================================
# RELOAD NGINX AND PHP-FPM
#=================================================
ynh_print_info "Reload nginx and php-fpm"
ynh_print_info "Reloading nginx web server and php-fpm..."
#systemctl reload php7.0-fpm
systemctl reload nginx
@ -158,4 +159,4 @@ ynh_systemd_action --action=start --service_name=$app --line_match="Redis connec
# END OF SCRIPT
#=================================================
ynh_print_info "Restoration completed"
ynh_print_info "Restoration completed for $app"

View file

@ -13,7 +13,7 @@ source /usr/share/yunohost/helpers
#=================================================
# LOAD SETTINGS
#=================================================
ynh_print_info "Load settings"
ynh_print_info "Loading installation settings..."
app=$YNH_APP_INSTANCE_NAME
@ -30,7 +30,7 @@ port=$(ynh_app_setting_get $app port)
#=================================================
# ENSURE DOWNWARD COMPATIBILITY
#=================================================
ynh_print_info "Ensure downward compatibility"
ynh_print_info "Ensuring downward compatibility..."
# Fix is_public as a boolean value
if [ "$is_public" = "Yes" ]; then
@ -56,7 +56,7 @@ fi
#=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#=================================================
ynh_print_info "Backup the app before upgrading"
ynh_print_info "Backing up the app before upgrading (may take a while)..."
# Backup the current version of the app
ynh_backup_before_upgrade
@ -86,7 +86,7 @@ path_url=$(ynh_normalize_url_path $path_url)
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
ynh_print_info "Download, check and unpack source"
ynh_print_info "Upgrading source files..."
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source "$final_path"
@ -94,7 +94,7 @@ ynh_setup_source "$final_path"
#=================================================
# NGINX CONFIGURATION
#=================================================
ynh_print_info "Reconfigure nginx"
ynh_print_info "Upgrading nginx web server configuration..."
# Create a dedicated nginx config
ynh_add_nginx_config
@ -102,7 +102,7 @@ ynh_add_nginx_config
#=================================================
# UPGRADE DEPENDENCIES
#=================================================
ynh_print_info "Upgrade dependencies"
ynh_print_info "Upgrading dependencies..."
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
@ -114,7 +114,7 @@ ynh_install_app_dependencies yarn redis-server postgresql postgresql-contrib bui
#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_print_info "Create a dedicated user"
ynh_print_info "Making sure dedicated system user exists..."
# Create a dedicated user (if not existing)
ynh_system_user_create "$app" "$final_path"
@ -122,7 +122,7 @@ ynh_system_user_create "$app" "$final_path"
#=================================================
# PHP-FPM CONFIGURATION
#=================================================
ynh_print_info "Reconfigure php-fpm"
ynh_print_info "Upgrading php-fpm configuration..."
# Create a dedicated php-fpm config
#ynh_add_fpm_config
@ -174,7 +174,7 @@ ynh_store_file_checksum "$final_path/config.yml"
#=================================================
# SETUP LOGROTATE
#=================================================
ynh_print_info "Reconfigure logrotate"
ynh_print_info "Upgrading logrotate configuration..."
# Use logrotate to manage app-specific logfile(s)
ynh_use_logrotate --non-append
@ -182,7 +182,7 @@ ynh_use_logrotate --non-append
#=================================================
# SETUP SYSTEMD
#=================================================
ynh_print_info "Reconfigure systemd"
ynh_print_info "Upgrading systemd configuration..."
# Create a dedicated systemd config
ynh_replace_string "__NODEJS_PATH__" "$nodejs_path" "../conf/systemd.service"
@ -200,7 +200,7 @@ chown -R "$app":"$app" "$final_path"
#=================================================
# SETUP SSOWAT
#=================================================
ynh_print_info "Reconfigure SSOwat"
ynh_print_info "Upgrading SSOwat configuration..."
# Make app public if necessary
if [ $is_public -eq 1 ]
@ -212,7 +212,7 @@ fi
#=================================================
# RELOAD NGINX
#=================================================
ynh_print_info "Reload nginx"
ynh_print_info "Reloading nginx web server..."
systemctl reload nginx
@ -226,4 +226,4 @@ ynh_systemd_action --action=start --service_name=$app --line_match="Redis connec
# END OF SCRIPT
#=================================================
ynh_print_info "Upgrade completed"
ynh_print_info "Upgrade of $app completed"