diff --git a/README.md b/README.md index 3b6455a..6e33e43 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ It shall NOT be edited by hand. # Scrumblr for YunoHost -[![Integration level](https://dash.yunohost.org/integration/scrumblr.svg)](https://dash.yunohost.org/appci/app/scrumblr) ![](https://ci-apps.yunohost.org/ci/badges/scrumblr.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/scrumblr.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/scrumblr.svg)](https://dash.yunohost.org/appci/app/scrumblr) ![Working status](https://ci-apps.yunohost.org/ci/badges/scrumblr.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/scrumblr.maintain.svg) + [![Install Scrumblr with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=scrumblr) *[Lire ce readme en français.](./README_fr.md)* @@ -23,24 +24,25 @@ scrumblr is a web-based simulation of a physical agile kanban board that support ## Screenshots -![](./doc/screenshots/post-it_demo.png) +![Screenshot of Scrumblr](./doc/screenshots/post-it_demo.png) ## Documentation and resources -* Official app website: http://www.scrumblr.ca/ -* Upstream app code repository: https://framagit.org/colibris/framemo -* YunoHost documentation for this app: https://yunohost.org/app_scrumblr -* Report a bug: https://github.com/YunoHost-Apps/scrumblr_ynh/issues +* Official app website: +* Upstream app code repository: +* YunoHost Store: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/scrumblr_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/scrumblr_ynh/tree/testing --debug or sudo yunohost app upgrade scrumblr -u https://github.com/YunoHost-Apps/scrumblr_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 8810627..53e8bef 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,15 +1,20 @@ + + # Scrumblr pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/scrumblr.svg)](https://dash.yunohost.org/appci/app/scrumblr) ![](https://ci-apps.yunohost.org/ci/badges/scrumblr.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/scrumblr.maintain.svg) +[![Niveau d’intégration](https://dash.yunohost.org/integration/scrumblr.svg)](https://dash.yunohost.org/appci/app/scrumblr) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/scrumblr.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/scrumblr.maintain.svg) + [![Installer Scrumblr avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=scrumblr) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Scrumblr rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* +> *Ce package vous permet d’installer Scrumblr rapidement et simplement sur un serveur YunoHost. +Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.* -## Vue d'ensemble +## Vue d’ensemble scrumblr is a web-based simulation of a physical agile kanban board that supports real-time collaboration. it is built using node.js, websockets (using socket.io), CSS3, and jquery. @@ -17,26 +22,27 @@ scrumblr is a web-based simulation of a physical agile kanban board that support **Démo :** http://scrumblr.ca/ -## Captures d'écran +## Captures d’écran -![](./doc/screenshots/post-it_demo.png) +![Capture d’écran de Scrumblr](./doc/screenshots/post-it_demo.png) ## Documentations et ressources -* Site officiel de l'app : http://www.scrumblr.ca/ -* Dépôt de code officiel de l'app : https://framagit.org/colibris/framemo -* Documentation YunoHost pour cette app : https://yunohost.org/app_scrumblr -* Signaler un bug : https://github.com/YunoHost-Apps/scrumblr_ynh/issues +* Site officiel de l’app : +* Dépôt de code officiel de l’app : +* YunoHost Store: +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/scrumblr_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/scrumblr_ynh/tree/testing --debug ou sudo yunohost app upgrade scrumblr -u https://github.com/YunoHost-Apps/scrumblr_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** \ No newline at end of file diff --git a/check_process b/check_process deleted file mode 100644 index ac25d73..0000000 --- a/check_process +++ /dev/null @@ -1,25 +0,0 @@ -;; Test complet - ; Manifest - domain="domain.tld" - path="/path" - is_public=1 - ; Checks - pkg_linter=1 - setup_sub_dir=1 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - upgrade=1 from_commit=7097f3fe8fcf818f342e1971a58bc45cb8fe835c - backup_restore=1 - multi_instance=1 - change_url=1 -;;; Options -Email= -Notification=none -;;; Upgrade options - ; commit=7097f3fe8fcf818f342e1971a58bc45cb8fe835c - name=Merge pull request #15 - manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666& - diff --git a/conf/app.src b/conf/app.src deleted file mode 100644 index f2cd28f..0000000 --- a/conf/app.src +++ /dev/null @@ -1,5 +0,0 @@ -SOURCE_URL=https://framagit.org/colibris/framemo/-/archive/d14b3167dfe413ca7db78283b70334100e82076f/framemo-d14b3167dfe413ca7db78283b70334100e82076f.tar.gz -SOURCE_SUM=f42433ee1e513a2881d00573d0ee5d9595bcee868a8ecbaf9b219d3811aa6943 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true diff --git a/conf/nginx.conf b/conf/nginx.conf index 083b591..f9716eb 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,13 +1,14 @@ +#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; location __PATH__/ { + + proxy_pass http://127.0.0.1:__PORT____PATH__/; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $remote_addr; proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header X-Forwarded-Host $http_host; + proxy_set_header X-Forwarded-Host $host; proxy_set_header Host $host; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection $connection_upgrade; - - proxy_pass http://localhost:__PORT____PATH__/; } diff --git a/conf/redis.conf b/conf/redis.conf index 7d50bbc..bb49a13 100644 --- a/conf/redis.conf +++ b/conf/redis.conf @@ -64,7 +64,7 @@ protected-mode yes # Accept connections on the specified port, default is 6379 (IANA #815344). # If port 0 is specified Redis will not listen on a TCP socket. -port __REDIS_PORT__ +port __PORT_REDIS__ # TCP listen() backlog. # @@ -122,7 +122,7 @@ supervised no # # Creating a pid file is best effort: if Redis is not able to create it # nothing bad happens, the server will start and run normally. -pidfile __FINAL_PATH__/redis-server-__REDIS_PORT__.pid +pidfile __INSTALL_DIR__/redis-server-__PORT_REDIS__.pid # Specify the server verbosity level. # This can be one of: @@ -135,7 +135,7 @@ loglevel notice # Specify the log file name. Also the empty string can be used to force # Redis to log on the standard output. Note that if you use standard # output for logging but daemonize, logs will be sent to /dev/null -logfile /var/log/__APP__/redis-__REDIS_PORT__.log +logfile /var/log/__APP__/redis-__PORT_REDIS__.log # Set the number of databases. The default database is DB 0, you can select # a different one on a per-connection basis using SELECT where @@ -210,7 +210,7 @@ dbfilename redis-__APP__.rdb # The Append Only File will also be created inside this directory. # # Note that you must specify a directory here, not a file name. -dir __FINAL_PATH__ +dir __INSTALL_DIR__ ############################# LAZY FREEING #################################### diff --git a/conf/scrumblr_redis.service b/conf/scrumblr_redis.service index feaa0ae..39c49b7 100644 --- a/conf/scrumblr_redis.service +++ b/conf/scrumblr_redis.service @@ -6,10 +6,10 @@ After=network.target Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -ExecStart=/usr/bin/redis-server __FINALPATH__/redis.conf +WorkingDirectory=__INSTALL_DIR__/ +ExecStart=/usr/bin/redis-server __INSTALL_DIR__/redis.conf ExecStop=/bin/kill -s TERM $MAINPID -PIDFile=__FINALPATH__/redis-server-__REDIS_PORT__.pid +PIDFile=__INSTALL_DIR__/redis-server-__PORT_REDIS__.pid TimeoutStopSec=0 Restart=always @@ -21,7 +21,7 @@ ProtectHome=yes #ReadOnlyDirectories=/ ReadWriteDirectories=-/var/lib/__APP__ ReadWriteDirectories=-/var/log/__APP__ -ReadWriteDirectories=-__FINALPATH__ +ReadWriteDirectories=-__INSTALL_DIR__ NoNewPrivileges=true CapabilityBoundingSet=CAP_SETGID CAP_SETUID CAP_SYS_RESOURCE @@ -32,7 +32,5 @@ RestrictRealtime=true RestrictNamespaces=true RestrictAddressFamilies=AF_INET AF_INET6 AF_UNIX - - [Install] WantedBy=multi-user.target diff --git a/conf/systemd.service b/conf/systemd.service index bff937c..e5c9137 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -1,15 +1,15 @@ [Unit] -Description=Scrumblr: software to take note. +Description=Scrumblr: collaborative whiteboard Requires=redis-__APP__.service [Service] Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__ +WorkingDirectory=__INSTALL_DIR__ Environment="PATH=_PATH__" Environment="NODE_ENV=production" -ExecStart=__YNH_NODE__ server.js --port=__PORT__ --baseurl=__PATH__ --redis localhost:__REDIS_PORT__ +ExecStart=__YNH_NODE__ server.js --port=__PORT__ --baseurl=__PATH__ --redis localhost:__PORT_REDIS__ Restart=always # Sandboxing options to harden security @@ -44,4 +44,3 @@ CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG [Install] WantedBy=multi-user.target - diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 0a94081..0000000 --- a/manifest.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "name": "Scrumblr", - "id": "scrumblr", - "packaging_format": 1, - "description": { - "en": "Software for post-it notes", - "fr": "Application pour créer des post-it" - }, - "version": "0.2.1~ynh2", - "url": "http://www.scrumblr.ca/", - "upstream": { - "license": "AGPL-3.0-only", - "website": "http://www.scrumblr.ca/", - "demo": "http://scrumblr.ca/", - "code": "https://framagit.org/colibris/framemo" - }, - "license": "AGPL-3.0-only", - "maintainer": [{ - "name": "frju365", - "email": "win10@tutanota.com" - }, - { "name": "oiseauroch", - "email": "tobias.ollive@oiseauroch.fr" - }], - "requirements": { - "yunohost": ">> 4.3.0" - }, - "multi_instance": true, - "services": [ - "nginx" - ], - "arguments": { - "install" : [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/scrumblr", - "default": "/scrumblr" - }, - { - "name": "is_public", - "type": "boolean", - "help": { - "en": "If enabled, Scrumblr will be accessible by people who do not have an account. This can be changed later via the webadmin.", - "fr": "Si cette case est cochée, Scrumblr sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin." - }, - "default": true - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..092e595 --- /dev/null +++ b/manifest.toml @@ -0,0 +1,61 @@ +packaging_format = 2 + +id = "scrumblr" +name = "Scrumblr" +description.en = "Software for post-it notes" +description.fr = "Application pour créer des post-it" + +version = "0.2.1~ynh2" + +maintainers = ["frju365", "oiseauroch"] + +[upstream] +license = "AGPL-3.0-only" +website = "http://www.scrumblr.ca/" +demo = "http://scrumblr.ca/" +code = "https://framagit.org/colibris/framemo" + +[integration] +yunohost = ">= 11.2" +architectures = "all" +multi_instance = true + +ldap = false + +sso = false + +disk = "50M" +ram.build = "50M" +ram.runtime = "50M" + +[install] + [install.domain] + type = "domain" + + [install.path] + type = "path" + default = "/scrumblr" + + [install.init_main_permission] + help.en = "If enabled, Scrumblr will be accessible by people who do not have an account. This can be changed later via the webadmin." + help.fr = "Si cette case est cochée, Scrumblr sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin." + type = "group" + default = "visitors" + +[resources] + [resources.sources.main] + url = "https://framagit.org/colibris/framemo/-/archive/d14b3167dfe413ca7db78283b70334100e82076f/framemo-d14b3167dfe413ca7db78283b70334100e82076f.tar.gz" + sha256 = "f42433ee1e513a2881d00573d0ee5d9595bcee868a8ecbaf9b219d3811aa6943" + + [resources.system_user] + + [resources.install_dir] + + [resources.ports] + redis.default = 8081 + + [resources.permissions] + main.url = "/" + + [resources.apt] + packages = "redis-server, redis-tools" diff --git a/scripts/backup b/scripts/backup index 5ce4bc9..f6297b0 100644 --- a/scripts/backup +++ b/scripts/backup @@ -10,46 +10,22 @@ source ../settings/scripts/_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 - -#================================================= -# 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) -redis_port=$(ynh_app_setting_get --app=$app --key=redis_port) -codename=$(ynh_app_setting_get $app codename) - #================================================= # DECLARE DATA AND CONF FILES TO BACKUP #================================================= ynh_print_info --message="Declaring files to be backed up..." - #================================================= # EXPORT DATABASE #================================================= -redis-cli --rdb "$final_path/redis-$app.rdb" -p $redis_port +redis-cli --rdb "$install_dir/redis-$app.rdb" -p $port_redis #================================================= # BACKUP THE APP MAIN DIR #================================================= -ynh_backup --src_path="$final_path" +ynh_backup --src_path="$install_dir" #================================================= # BACKUP THE NGINX CONFIGURATION @@ -57,8 +33,6 @@ ynh_backup --src_path="$final_path" ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" -#================================================= -# SPECIFIC BACKUP #================================================= # BACKUP LOGROTATE #================================================= diff --git a/scripts/change_url b/scripts/change_url index feaf25f..c6f5a1f 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,60 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# 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) -port=$(ynh_app_setting_get --app=$app --key=port) - -#================================================= -# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=1 - -# 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 - #================================================= # STANDARD MODIFICATIONS #================================================= @@ -77,30 +23,7 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app #================================================= ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1 -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 - +ynh_change_url_nginx_config #================================================= # CHANGE SYSTEMD SERVICE @@ -122,13 +45,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=5 ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Server running at" -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/install b/scripts/install index 2ccb1ed..c87e72b 100644 --- a/scripts/install +++ b/scripts/install @@ -9,56 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE FAILURE OF THE SCRIPT -#================================================= - -ynh_clean_setup () { - 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=$YNH_APP_ARG_PATH -is_public=$YNH_APP_ARG_IS_PUBLIC - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THIS ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." --weight=1 - -final_path=/var/www/$app -test ! -e "$final_path" || ynh_die --message="This path already contains a folder" - -# Register (book) web path -ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url - -#================================================= -# STORE SETTINGS FROM MANIFEST -#================================================= -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 - -#================================================= -# STANDARD MODIFICATIONS -#================================================= -# FIND AND OPEN A PORT -#================================================= -ynh_script_progression --message="Finding an available port..." --weight=1 - -# Find an available port -port=$(ynh_find_port --port=8080) -ynh_app_setting_set --app=$app --key=port --value=$port - #================================================= # INSTALL NODEJS #================================================= @@ -66,112 +16,57 @@ ynh_script_progression --message="Installing dependencies..." --weight=5 ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version - - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." --weight=1 - -# Create a system user -ynh_system_user_create --username=$app --home_dir="$final_path" - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." --weight=5 -ynh_app_setting_set --app=$app --key=final_path --value=$final_path -# Download, check integrity, uncompress and patch the source from app.src -ynh_setup_source --dest_dir="$final_path" +ynh_setup_source --dest_dir="$install_dir" #================================================== # CONFIGURE REDIS SERVICE #================================================== -ynh_install_app_dependencies redis-server redis-tools - -# Find an available port for redis -redis_port=$(ynh_find_port --port=8081) -ynh_app_setting_set --app=$app --key=redis_port --value=$redis_port - -ynh_add_config --template="redis.conf" --destination="$final_path/redis.conf" +ynh_add_config --template="redis.conf" --destination="$install_dir/redis.conf" redis_service="redis-$app" ynh_add_systemd_config --service $redis_service --template scrumblr_redis.service +chmod 770 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:$app "$install_dir" -chmod 770 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:$app "$final_path" #================================================= # NGINX CONFIGURATION #================================================= ynh_script_progression --message="Configuring NGINX web server..." --weight=1 -# 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 - -# Use logrotate to manage application logfile(s) ynh_use_logrotate chown -R $app:$app "/var/log/$app/" -#================================================= -# SETUP SYSTEMD -#================================================= -ynh_script_progression --message="Configuring a systemd service..." --weight=1 - ynh_add_systemd_config +yunohost service add $app --description="Software for notes" --log="/var/log/$app/$app.log" + #================================================= # INSTALL SCRUMBLR #================================================= -pushd $final_path +pushd $install_dir ynh_use_nodejs ynh_exec_warn_less $ynh_npm install popd -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 - -yunohost service add $app --description="Software for notes" --log="/var/log/$app/$app.log" - #================================================= # START SYSTEMD SERVICE #================================================= ynh_script_progression --message="Starting a systemd service..." --weight=2 # Start a systemd service -ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Server running at " - -#================================================= -# Set Public or private -#================================================= -ynh_script_progression --message="Configuring permissions..." --weight=1 - -# Make app public if necessary or protect it -if [ $is_public -eq 1 ] -then - ynh_permission_update --permission "main" --add "visitors" -fi - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload +ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Server running at " #================================================= # END OF SCRIPT diff --git a/scripts/remove b/scripts/remove index 62b39e1..7f3b063 100644 --- a/scripts/remove +++ b/scripts/remove @@ -9,95 +9,33 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# 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) -port=$(ynh_app_setting_get --app=$app --key=port) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) - #================================================= # STANDARD REMOVE #================================================= # REMOVE SERVICE INTEGRATION IN YUNOHOST #================================================= +ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 -# Remove the service from the list of services known by YunoHost (added from `yunohost service add`) if ynh_exec_warn_less yunohost service status $app >/dev/null then ynh_script_progression --message="Removing $app service integration..." --weight=1 yunohost service remove $app fi -#================================================= -# STOP AND REMOVE SERVICE -#================================================= -ynh_script_progression --message="Stopping and removing the systemd service..." --weight=2 - -# Remove the dedicated systemd config ynh_remove_systemd_config ynh_remove_systemd_config --service="redis-$app" - - -#================================================= -# REMOVE LOGROTATE CONFIGURATION -#================================================= -ynh_script_progression --message="Removing logrotate configuration..." --weight=1 - -# Remove the app-specific logrotate config ynh_remove_logrotate -#================================================= -# REMOVE LOG DIR -#================================================= -ynh_script_progression --message="Removing log dir..." --weight=1 - ynh_secure_remove --file="/var/log/$app" -#================================================= -# REMOVE DEPENDENCIES -#================================================= -ynh_script_progression --message="Removing dependencies..." --weight=2 - -# Remove metapackage and its dependencies ynh_remove_nodejs -ynh_script_progression --message="Removing redis service" --weight=2 - ynh_remove_systemd_config --service="redis-$app" -#================================================= -# REMOVE APP MAIN DIR -#================================================= -ynh_script_progression --message="Removing app main directory..." --weight=1 - -# 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 -#================================================= -# GENERIC FINALIZATION -#================================================= -# REMOVE DEDICATED USER -#================================================= -ynh_script_progression --message="Removing the dedicated system user..." --weight=1 - -# Delete a system user -ynh_system_user_delete --username=$app - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/restore b/scripts/restore index 62f167d..06b0955 100644 --- a/scripts/restore +++ b/scripts/restore @@ -6,62 +6,15 @@ # IMPORT GENERIC HELPERS #================================================= -# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_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 - -#================================================= -# 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=1 - -test ! -d $final_path || ynh_die --message="There is already a directory: $final_path " - -#================================================= -# STANDARD RESTORATION STEPS -#================================================= -# RESTORE THE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the NGINX configuration..." --weight=1 - -ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" - -#================================================= -# RECREATE THE DEDICATED USER -#================================================= -ynh_script_progression --message="Recreating the dedicated system user..." --weight=1 - -# Create the dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" - #================================================= # RESTORE THE APP MAIN DIR #================================================= ynh_script_progression --message="Restoring the app main directory..." --weight=1 -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="$install_dir" #================================================= # SPECIFIC RESTORATION @@ -80,38 +33,22 @@ ynh_script_progression --message="Restoring the systemd configuration..." --weig ynh_restore_file --origin_path="/etc/systemd/system/$app.service" systemctl enable $app.service --quiet -#================================================= -# RESTORE redis service -#================================================= -ynh_script_progression --message="Restoring the redis configuration..." --weight=1 - -ynh_install_app_dependencies redis-server redis-tools +ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" ynh_restore_file --origin_path="/etc/systemd/system/redis-$app.service" systemctl enable "redis-$app.service" --quiet -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:$app "$final_path" - -#================================================= -# RESTORE THE LOGROTATE CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the logrotate configuration..." --weight=1 - - -# recreate log directory in case of restoring backup in a new installation mkdir --parents /var/log/$app chown -R $app:$app "/var/log/$app/" ynh_restore_file --origin_path="/etc/logrotate.d/$app" -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 yunohost service add $app --description="Software for notes" --log="/var/log/$app/$app.log" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:$app "$install_dir" + #================================================= # START SYSTEMD SERVICE #================================================= @@ -119,13 +56,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=1 ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Server running at" -#================================================= -# 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 #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 8a0c8aa..6410135 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,48 +9,12 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# 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) -port=$(ynh_app_setting_get --app=$app --key=port) - -if ynh_compare_current_package_version --comparison gt --version 0.2.0~ynh1 -then - redis_port=$(ynh_app_setting_get --app=$app --key=redis_port) -else - redis_port=$(ynh_find_port --port=8081) - ynh_app_setting_set --app=$app --key=redis_port --value=$redis_port -fi - #================================================= # CHECK VERSION #================================================= upgrade_type=$(ynh_check_app_version_changed) -ynh_install_app_dependencies redis-server redis-tools - -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app 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 - #================================================= # STANDARD UPGRADE STEPS #================================================= @@ -62,38 +26,19 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app if $(ynh_compare_current_package_version --comparison gt --version "0.2.0~ynh1") then - # save redis db - pushd $final_path - redis-cli --rdb "/tmp/redis-$app.rdb" -p $redis_port + pushd $install_dir + redis-cli --rdb "/tmp/redis-$app.rdb" -p $port_redis popd ynh_systemd_action --service_name=redis-$app --action="stop" --log_path="/var/log/$app/redis-$app.log" fi -#================================================= -# ENSURE DOWNWARD COMPATIBILITY -#================================================= -ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 - -# 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 - -# Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public -fi #================================================= -# CREATE DEDICATED USER +# INSTALL NODEJS #================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 +ynh_script_progression --message="Installing dependencies..." --weight=5 -# Create a dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" +ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE @@ -103,20 +48,20 @@ if [ "$upgrade_type" == "UPGRADE_APP" ] then ynh_script_progression --message="Upgrading source files..." --weight=1 - ynh_secure_remove --file="$final_path" + ynh_secure_remove --file="$install_dir" # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir="$final_path" + ynh_setup_source --dest_dir="$install_dir" # restore db backup if $(ynh_compare_current_package_version --comparison gt --version "0.2.0~ynh1") then - mv /tmp/redis-$app.rdb $final_path/redis-$app.rdb + mv /tmp/redis-$app.rdb $install_dir/redis-$app.rdb fi fi if [ "$upgrade_type" == "UPGRADE_APP" ] then - pushd $final_path + pushd $install_dir ynh_use_nodejs ynh_exec_warn_less $ynh_npm install popd @@ -129,11 +74,9 @@ ynh_script_progression --message="migrating database... $(ynh_package_version -- echo "$(ynh_package_version --package=srumblr)" - - if $(ynh_compare_current_package_version --comparison lt --version "0.2.0~ynh2") then - pushd $final_path + pushd $install_dir redis-cli --rdb "redis-$app.rdb" popd fi @@ -142,16 +85,14 @@ fi # REDIS CONFIGURATION #================================================= - -ynh_add_config --template="redis.conf" --destination="$final_path/redis.conf" +ynh_add_config --template="redis.conf" --destination="$install_dir/redis.conf" redis_service="redis-$app" ynh_add_systemd_config --service $redis_service --template "scrumblr_redis.service" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:$app "$final_path" - +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:$app "$install_dir" #================================================= # NGINX CONFIGURATION @@ -161,38 +102,14 @@ ynh_script_progression --message="Upgrading NGINX web server configuration..." - # Create a dedicated NGINX config ynh_add_nginx_config -#================================================= -# UPGRADE DEPENDENCIES -#================================================= -ynh_script_progression --message="Upgrading dependencies..." --weight=5 - -ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version - -#================================================= -# SETUP SYSTEMD -#================================================= -ynh_script_progression --message="Upgrading systemd configuration..." --weight=1 - ynh_add_systemd_config -#================================================= -# GENERIC FINALIZATION -#================================================= -# SETUP LOGROTATE -#================================================= -ynh_script_progression --message="Upgrading logrotate configuration..." --weight=1 - # Use logrotate to manage app-specific logfile(s) ynh_use_logrotate --non-append #fix log directory owner chown -R $app:$app /var/log/$app -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 - yunohost service add $app --description="Software for notes" --log="/var/log/$app/$app.log" #================================================= @@ -200,14 +117,7 @@ yunohost service add $app --description="Software for notes" --log="/var/log/$ap #================================================= ynh_script_progression --message="Starting a systemd service..." --weight=1 -ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="Server running at" - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload +ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Server running at" #================================================= # END OF SCRIPT diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..d64ef3c --- /dev/null +++ b/tests.toml @@ -0,0 +1,7 @@ +test_format = 1.0 + +[default] + + # ------------ + # Tests to run + # ------------