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

Merge pull request #9 from YunoHost-Apps/testing

Browse source 
Testing
This commit is contained in:
Éric Gaspar 2020-11-05 14:28:29 +01:00 committed by GitHub
commit 81abda0f3f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 667 additions and 85 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

0
LICENSE.txt → LICENSE
View file

63
README.md
View file

@ -1,8 +1,16 @@
# chtickynotes_ynh : sticky notes for Yunohost # # ChtickyNotes for YunoHost
chtickynotes_ynh is packaged to be installed on a [Yunohost](https://yunohost.org) server. [![Integration level](https://dash.yunohost.org/integration/chtickynotes.svg)](https://dash.yunohost.org/appci/app/chtickynotes) ![](https://ci-apps.yunohost.org/ci/badges/chtickynotes.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/chtickynotes.maintain.svg)
[![Install ChtickyNotes with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=chtickynotes)
chtickynotes_ynh is a "simple post-it" application. Its main features are: *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install ChtickyNotes quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
ChtickyNotes core is based on [Post It All!](https://github.com/txusko/PostItAll).
ChtickyNotes is a "simple post-it" application. Its main features are:
- notes movable and resizable - notes movable and resizable
- edit note by just typing on it (or CTRL-V to paste chunks of HTML) - edit note by just typing on it (or CTRL-V to paste chunks of HTML)
- menu on each note to change its color, and so on - menu on each note to change its color, and so on
@ -10,8 +18,51 @@ chtickynotes_ynh is a "simple post-it" application. Its main features are:
- autosave every 10 seconds - autosave every 10 seconds
- storage on the server (not on the browser local storage) - storage on the server (not on the browser local storage)
**Screen shot:**<br> **Shipped version:** 1.0
![Screen shot](https://lh4.googleusercontent.com/-ATC-XA5iVsc/VM06cI3ClLI/AAAAAAAACHo/uBhDViaSBRg/s800/chtickynotes.gif)
chtickynotes_ynh core is based on [Post It All!](https://github.com/txusko/PostItAll). ## Screenshots
![](https://lh4.googleusercontent.com/-ATC-XA5iVsc/VM06cI3ClLI/AAAAAAAACHo/uBhDViaSBRg/s800/chtickynotes.gif)
## Documentation
* Official documentation: Link to the official documentation of this app
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
## YunoHost specific features
#### Multi-user support
* Are LDAP and HTTP auth supported?
* Can the app be used by multiple users?
#### Supported architectures
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/chtickynotes%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/chtickynotes/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/chtickynotes%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/chtickynotes/)
## Limitations
* Any known limitations.
## Additional information
* Other info you would like to add about this app.
## Links
* Report a bug: https://github.com/YunoHost-Apps/chtickynotes_ynh/issues
* YunoHost website: https://yunohost.org/
---
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing).
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing --debug
or
sudo yunohost app upgrade chtickynotes -u https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing --debug
```

68
README_fr.md Normal file
View file

@ -0,0 +1,68 @@
# ChtickyNotes pour YunoHost
[![Integration level](https://dash.yunohost.org/integration/chtickynotes.svg)](https://dash.yunohost.org/appci/app/chtickynotes) ![](https://ci-apps.yunohost.org/ci/badges/chtickynotes.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/chtickynotes.maintain.svg)
[![Install ChtickyNotes with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=chtickynotes)
*[Read this readme in english.](./README.md)*
> *Ce package vous permet d'installer ChtickyNotes rapidement et simplement sur un serveur YunoHost.
Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.*
## Overview
Le noyau de ChtickyNotes est basé sur [Post It All!](Https://github.com/txusko/PostItAll).
ChtickyNotes est une application "post-it". Ses principales caractéristiques sont :
- notes mobiles et redimensionnables
- éditer la note en tapant simplement dessus (ou CTRL-V pour coller du code HTML)
- menu sur chaque note pour changer sa couleur...
- menu global pour changer de tableau...
- sauvegarde automatique toutes les 10 secondes
- stockage sur le serveur (pas de stockage local dans le navigateur)
**Version incluse :** 1.0
## Captures d'écran
![](https://lh4.googleusercontent.com/-ATC-XA5iVsc/VM06cI3ClLI/AAAAAAAACHo/uBhDViaSBRg/s800/chtickynotes.gif)
## Documentation
* Documentation officielle : Lien vers la documentation officielle de cette application.
* Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer.
## Caractéristiques spécifiques YunoHost
#### Support multi-utilisateur
* L'authentification LDAP et HTTP est-elle prise en charge ?
* L'application peut-elle être utilisée par plusieurs utilisateurs ?
#### Architectures supportées
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/chtickynotes%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/chtickynotes/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/chtickynotes%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/chtickynotes/)
## Limitations
* Limitations connues.
## Informations additionnelles
* Autres informations que vous souhaitez ajouter sur cette application.
## Liens
* Signaler un bug : https://github.com/YunoHost-Apps/chtickynotes_ynh/issues
* Site web YunoHost : https://yunohost.org/
---
## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit.
```
sudo yunohost app install https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing --debug
or
sudo yunohost app upgrade chtickynotes -u https://github.com/YunoHost-Apps/chtickynotes_ynh/tree/testing --debug
```

32
check_process Normal file
View file

@ -0,0 +1,32 @@
# See here for more information
# https://github.com/YunoHost/package_check#syntax-check_process-file
# Move this file from check_process.default to check_process when you have filled it.
;; Test complet
; Manifest
domain="domain.tld" (DOMAIN)
path="/path" (PATH)
is_public=1 (PUBLIC|public=1|private=0)
; Checks
pkg_linter=1
setup_sub_dir=1
setup_root=1
setup_nourl=0
setup_private=1
setup_public=1
upgrade=1
backup_restore=1
multi_instance=0
port_already_use=0
change_url=1
;;; Levels
# If the level 5 (Package linter) is forced to 1. Please add justifications here.
Level 5=auto
;;; Options
Email=
Notification=none
;;; Upgrade options
; commit=CommitHash
name=Name and date of the commit.
manifest_arg=domain=DOMAIN&path=PATH&admin=USER&is_public=1&

21
conf/nginx.conf
View file

@ -1,16 +1,25 @@
location PATHTOCHANGE { #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
location __PATH__/ {
alias WWWPATH ; # Path to source
alias __FINALPATH__/ ;
# Force usage of https
if ($scheme = http) {
rewrite ^ https://$server_name$request_uri? permanent;
}
index index.html index.php;
index index.html index.php ;
try_files $uri $uri/ index.php; try_files $uri $uri/ index.php;
location ~ [^/]\.php(/|$) { location ~ [^/]\.php(/|$) {
fastcgi_split_path_info ^(.+?\.php)(/.*)$; fastcgi_split_path_info ^(.+?\.php)(/.*)$;
fastcgi_pass unix:/var/run/php5-fpm.sock; fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock;
fastcgi_index index.php; fastcgi_index index.php;
include fastcgi_params; include fastcgi_params;
fastcgi_param REMOTE_USER $remote_user; fastcgi_param REMOTE_USER $remote_user;
fastcgi_param PATH_INFO $fastcgi_path_info; fastcgi_param PATH_INFO $fastcgi_path_info;
fastcgi_param SCRIPT_FILENAME $request_filename; fastcgi_param SCRIPT_FILENAME $request_filename;
} }

29
manifest.json
View file

@ -1,18 +1,32 @@
{ {
"name": "ChtickyNotes", "name": "ChtickyNotes",
"id": "chtickynotes", "id": "chtickynotes",
"packaging_format": 1,
"description": { "description": {
"en": "Generic sticky notes for all purpose", "en": "Generic sticky notes for all purpose",
"fr": "Des post-its génériques à tout faire" "fr": "Des post-its génériques à tout faire"
}, },
"version": "1.0~ynh1",
"url": "https://github.com/YunoHost-Apps/chtickynotes_ynh/",
"license": "MIT", "license": "MIT",
"developer": { "developer": {
"name": "chtixof" "name": "chtixof"
}, },
"multi_instance": "false", "maintainer": {
"name": "YunoHost Contributors",
"email": "apps@yunohost.org"
},
"requirements": {
"yunohost": ">= 3.8.1"
},
"multi_instance": false,
"services": [
"nginx"
],
"arguments": { "arguments": {
"install" : [ { "install" : [ {
"name": "domain", "name": "domain",
"type": "domain",
"ask": { "ask": {
"en": "Choose a domain for ChtickyNotes", "en": "Choose a domain for ChtickyNotes",
"fr": "Choisissez un domaine pour ChtickyNotes" "fr": "Choisissez un domaine pour ChtickyNotes"
@ -20,12 +34,23 @@
"example": "domain.org" "example": "domain.org"
},{ },{
"name": "path", "name": "path",
"type": "path",
"ask": { "ask": {
"en": "Choose a path for ChtickyNotes", "en": "Choose a path for ChtickyNotes",
"fr": "Choisissez un chemin pour ChtickyNotes" "fr": "Choisissez un chemin pour ChtickyNotes"
}, },
"example": "/chtickynotes", "example": "/chtickynotes",
"default": "/chtickynotes" "default": "/chtickynotes"
} ] },
{
"name": "is_public",
"type": "boolean",
"ask": {
"en": "Is it a public application?",
"fr": "Est-ce une application publique ?"
},
"default": true
}
]
} }
} }

18
pull_request.md Normal file
View file

@ -0,0 +1,18 @@
## Problem
- *Description of why you made this PR*
## Solution
- *And how do you fix that problem*
## PR Status
- [ ] Code finished.
- [ ] Tested with Package_check.
- [ ] Fix or enhancement tested.
- [ ] Upgrade from last version tested.
- [ ] Can be reviewed and tested.
## Package_check results
---
*If you have access to [App Continuous Integration for packagers](https://yunohost.org/#/packaging_apps_ci) you can provide a link to the package_check results like below, replacing '-NUM-' in this link by the PR number and USERNAME by your username on the ci-apps-dev. Or you provide a screenshot or a pastebin of the results*
[![Build Status](https://ci-apps-dev.yunohost.org/jenkins/job/chtickynotes_ynh%20PR-NUM-%20(USERNAME)/badge/icon)](https://ci-apps-dev.yunohost.org/jenkins/job/chtickynotes_ynh%20PR-NUM-%20(USERNAME)/)

17
scripts/_common.sh Normal file
View file

@ -0,0 +1,17 @@
#!/bin/bash
#=================================================
# COMMON VARIABLES
#=================================================
#=================================================
# PERSONAL HELPERS
#=================================================
#=================================================
# EXPERIMENTAL HELPERS
#=================================================
#=================================================
# FUTURE OFFICIAL HELPERS
#=================================================

56
scripts/backup
View file

@ -1,15 +1,49 @@
#!/bin/bash #!/bin/bash
app=chtickynotes
# The parameter $1 is the backup directory location #=================================================
# which will be compressed afterward # GENERIC START
backup_dir=$1/apps/$app #=================================================
mkdir -p $backup_dir # IMPORT GENERIC HELPERS
#=================================================
# Backup sources & data source ../settings/scripts/_common.sh
sudo cp -a /var/www/$app/. $backup_dir/sources source /usr/share/yunohost/helpers
# Copy Nginx and YunoHost parameters to make the script "standalone" #=================================================
sudo cp -a /etc/yunohost/apps/$app/. $backup_dir/yunohost # MANAGE SCRIPT FAILURE
domain=$(sudo yunohost app setting $app domain) #=================================================
sudo cp -a /etc/nginx/conf.d/$domain.d/$app.conf $backup_dir/nginx.conf
ynh_abort_if_errors
#=================================================
# LOAD SETTINGS
#=================================================
ynh_print_info --message="Loading installation settings..."
app=$YNH_APP_INSTANCE_NAME
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
domain=$(ynh_app_setting_get --app=$app --key=domain)
#=================================================
# DECLARE DATA AND CONF FILES TO BACKUP
#=================================================
ynh_print_info --message="Declaring files to be backed up..."
#=================================================
# BACKUP THE APP MAIN DIR
#=================================================
ynh_backup --src_path="$final_path"
#=================================================
# BACKUP THE NGINX CONFIGURATION
#=================================================
ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
#=================================================
# END OF SCRIPT
#=================================================
ynh_print_info --message="Backup script completed for ChtickyNotes. (YunoHost will then actually copy those files to the archive)."

107
scripts/change_url Normal file
View file

@ -0,0 +1,107 @@
#!/bin/bash
#=================================================
# GENERIC STARTING
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
source /usr/share/yunohost/helpers
# Stop script if errors
ynh_abort_if_errors
#=================================================
# RETRIEVE ARGUMENTS
#=================================================
old_domain=$YNH_APP_OLD_DOMAIN
old_path=$YNH_APP_OLD_PATH
new_domain=$YNH_APP_NEW_DOMAIN
new_path=$YNH_APP_NEW_PATH
app=$YNH_APP_INSTANCE_NAME
#=================================================
# LOAD SETTINGS
#=================================================
ynh_script_progression --message="Loading installation settings..." --weight=1
# Needed for helper "ynh_add_nginx_config"
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
#=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#=================================================
ynh_script_progression --message="Backing up ChtickyNotes before changing its URL (may take a while)..." --weight=2
# Backup the current version of the app
ynh_backup_before_upgrade
ynh_clean_setup () {
# Remove the new domain config file, the remove script won't do it as it doesn't know yet its location.
ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
# restore it if the upgrade fails
ynh_restore_upgradebackup
}
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors
#=================================================
# CHECK WHICH PARTS SHOULD BE CHANGED
#=================================================
change_domain=0
if [ "$old_domain" != "$new_domain" ]
then
change_domain=1
fi
change_path=0
if [ "$old_path" != "$new_path" ]
then
change_path=1
fi
#=================================================
# MODIFY URL IN NGINX CONF
#=================================================
ynh_script_progression --message="Updating NGINX web server configuration..." --weight=3
nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
# Change the path in the NGINX config file
if [ $change_path -eq 1 ]
then
# Make a backup of the original NGINX config file if modified
ynh_backup_if_checksum_is_different --file="$nginx_conf_path"
# Set global variables for NGINX helper
domain="$old_domain"
path_url="$new_path"
# Create a dedicated NGINX config
ynh_add_nginx_config
fi
# Change the domain for NGINX
if [ $change_domain -eq 1 ]
then
# Delete file checksum for the old conf file location
ynh_delete_file_checksum --file="$nginx_conf_path"
mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf
# Store file checksum for the new config file location
ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
fi
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=2
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Change of URL completed for ChtickyNotes" --last

105
scripts/install
View file

@ -1,28 +1,91 @@
#!/bin/bash #!/bin/bash
# Installation de ChtickyNotes dans Yunohost
app=chtickynotes
# Retrieve arguments #=================================================
domain=$1 # GENERIC START
path=$2 #=================================================
# IMPORT GENERIC HELPERS
#=================================================
# Check domain/path availability source _common.sh
sudo yunohost app checkurl $domain$path -a $app source /usr/share/yunohost/helpers
if [[ ! $? -eq 0 ]]; then
exit 1 #=================================================
fi # MANAGE SCRIPT FAILURE
#=================================================
ynh_abort_if_errors
#=================================================
# RETRIEVE ARGUMENTS FROM THE MANIFEST
#=================================================
domain=$YNH_APP_ARG_DOMAIN
path_url=$YNH_APP_ARG_PATH
is_public=$YNH_APP_ARG_IS_PUBLIC
app=$YNH_APP_INSTANCE_NAME
#=================================================
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
#=================================================
ynh_script_progression --message="Validating installation parameters..." --weight=1
# Copy files to the right place with the right permissions
final_path=/var/www/$app final_path=/var/www/$app
sudo mkdir -p $final_path test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
sudo cp -a ../sources/* $final_path
sudo chown -R www-data: $final_path
# Modify Nginx configuration file and copy it to Nginx conf directory # Register (book) web path
sed -i "s@PATHTOCHANGE@$path@g" ../conf/nginx.conf ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
sed -i "s@WWWPATH@$final_path@g" ../conf/nginx.conf
sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf
# Reload nginx and regenerate SSOwat conf #=================================================
sudo service nginx reload # STORE SETTINGS FROM MANIFEST
sudo yunohost app ssowatconf #=================================================
ynh_script_progression --message="Storing installation settings..." --weight=1
ynh_app_setting_set --app=$app --key=domain --value=$domain
ynh_app_setting_set --app=$app --key=path --value=$path_url
ynh_app_setting_set --app=$app --key=is_public --value=$is_public
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
ynh_script_progression --message="Setting up source files..." --weight=7
ynh_app_setting_set --app=$app --key=final_path --value=$final_path
mkdir -p $final_path
cp -a ../sources/* $final_path
#=================================================
# NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Configuring NGINX web server..." --weight=2
# Create a dedicated NGINX config
ynh_add_nginx_config
#=================================================
# SECURE FILES AND DIRECTORIES
#=================================================
chown -R www-data: $final_path
#=================================================
# SETUP SSOWAT
#=================================================
ynh_script_progression --message="Configuring SSOwat..." --weight=1
# Make app public if necessary or protect it
[ $is_public -eq 0 ] || ynh_permission_update --permission "main" --add "visitors"
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Installation of ChtickyNotes completed" --last

47
scripts/remove
View file

@ -1,15 +1,42 @@
#!/bin/bash #!/bin/bash
app=chtickynotes
# Retrieve arguments #=================================================
domain=$(sudo yunohost app setting $app domain) # GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
# Remove sources source _common.sh
sudo rm -rf /var/www/$app source /usr/share/yunohost/helpers
# Remove configuration files #=================================================
sudo rm -f /etc/nginx/conf.d/$domain.d/$app.conf # LOAD SETTINGS
#=================================================
ynh_script_progression --message="Loading installation settings..." --weight=1
# Restart services app=$YNH_APP_INSTANCE_NAME
sudo service nginx reload
sudo yunohost app ssowatconf domain=$(ynh_app_setting_get --app=$app --key=domain)
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
#=================================================
# REMOVE APP MAIN DIR
#=================================================
ynh_script_progression --message="Removing ChtickyNotes main directory..." --weight=2
# Remove the app directory securely
ynh_secure_remove --file="$final_path"
#=================================================
# REMOVE NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1
# Remove the dedicated NGINX config
ynh_remove_nginx_config
#=================================================
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Removal of ChtickyNotes completed" --last

87
scripts/restore
View file

@ -1,16 +1,81 @@
#!/bin/bash #!/bin/bash
app=chtickynotes
# The parameter $1 is the uncompressed restore directory location #=================================================
backup_dir=$1/apps/$app # GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
# Restore sources & data source ../settings/scripts/_common.sh
sudo cp -a $backup_dir/sources/. /var/www/$app source /usr/share/yunohost/helpers
# Restore Nginx and YunoHost parameters #=================================================
sudo cp -a $backup_dir/yunohost/. /etc/yunohost/apps/$app # MANAGE SCRIPT FAILURE
domain=$(sudo yunohost app setting $app domain) #=================================================
sudo cp -a $backup_dir/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf
# Restart webserver ynh_abort_if_errors
sudo service nginx reload
#=================================================
# LOAD SETTINGS
#=================================================
ynh_script_progression --message="Loading installation settings..." --weight=1
app=$YNH_APP_INSTANCE_NAME
domain=$(ynh_app_setting_get --app=$app --key=domain)
path_url=$(ynh_app_setting_get --app=$app --key=path)
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
#=================================================
# CHECK IF THE APP CAN BE RESTORED
#=================================================
ynh_script_progression --message="Validating restoration parameters..." --weight=2
ynh_webpath_available --domain=$domain --path_url=$path_url \
|| ynh_die --message="Path not available: ${domain}${path_url}"
test ! -d $final_path \
|| ynh_die --message="There is already a directory: $final_path "
#=================================================
# STANDARD RESTORATION STEPS
#=================================================
# RESTORE THE NGINX CONFIGURATION
#=================================================
ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
#=================================================
# RESTORE THE APP MAIN DIR
#=================================================
ynh_script_progression --message="Restoring ChtickyNotes main directory..." --weight=2
ynh_restore_file --origin_path="$final_path"
#=================================================
# RESTORE USER RIGHTS
#=================================================
# Restore permissions on app files
chown -R www-data: $final_path
#=================================================
# INTEGRATE SERVICE IN YUNOHOST
#=================================================
ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
yunohost service add $app --description "A short description of the app" --log "/var/log/$app/$app.log"
#=================================================
# GENERIC FINALIZATION
#=================================================
# RELOAD NGINX AND PHP-FPM
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Restoration completed for ChtickyNotes" --last

100
scripts/upgrade
View file

@ -1,24 +1,90 @@
#!/bin/bash #!/bin/bash
app=chtickynotes
# Retrieve arguments #=================================================
domain=$(sudo yunohost app setting $app domain) # GENERIC START
path=$(sudo yunohost app setting $app path) #=================================================
# IMPORT GENERIC HELPERS
#=================================================
# Remove trailing "/" for next commands source _common.sh
path=${path%/} source /usr/share/yunohost/helpers
# Copy source files #=================================================
final_path=/var/www/$app # LOAD SETTINGS
sudo mkdir -p $final_path #=================================================
sudo cp -a ../sources/* $final_path ynh_script_progression --message="Loading installation settings..." --weight=1
# Modify Nginx configuration file and copy it to Nginx conf directory app=$YNH_APP_INSTANCE_NAME
sed -i "s@PATHTOCHANGE@$path@g" ../conf/nginx.conf
sed -i "s@WWWPATH@$final_path@g" ../conf/nginx.conf
sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf
# Restart services domain=$(ynh_app_setting_get --app=$app --key=domain)
sudo service nginx reload path_url=$(ynh_app_setting_get --app=$app --key=path)
sudo yunohost app ssowatconf final_path=$(ynh_app_setting_get --app=$app --key=final_path)
#=================================================
# CHECK VERSION
#=================================================
upgrade_type=$(ynh_check_app_version_changed)
#=================================================
# ENSURE DOWNWARD COMPATIBILITY
#=================================================
ynh_script_progression --message="Ensuring downward compatibility..." --weight=2
# Fix is_public as a boolean value
if [ "$is_public" = "Yes" ]; then
ynh_app_setting_set --app=$app --key=is_public --value=1
is_public=1
elif [ "$is_public" = "No" ]; then
ynh_app_setting_set --app=$app --key=is_public --value=0
is_public=0
fi
# If final_path doesn't exist, create it
if [ -z "$final_path" ]; then
final_path=/var/www/$app
ynh_app_setting_set --app=$app --key=final_path --value=$final_path
fi
#=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#=================================================
ynh_script_progression --message="Backing up ChtickyNotes before upgrading (may take a while)..." --weight=1
# Backup the current version of the app
ynh_backup_before_upgrade
ynh_clean_setup () {
# restore it if the upgrade fails
ynh_restore_upgradebackup
}
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors
#=================================================
# SECURE FILES AND DIRECTORIES
#=================================================
mkdir -p $final_path
cp -a ../sources/* $final_path
chown -R www-data: $final_path
#=================================================
# NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=2
# Create a dedicated nginx config
ynh_add_nginx_config
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Upgrade of ChtickyNotes completed" --last