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

Merge pull request #3 from YunoHost-Apps/testing

Browse source 
Testing
This commit is contained in:
Éric Gaspar 2023-04-15 08:32:17 +02:00 committed by GitHub
commit 94aa4d2326
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
21 changed files with 149 additions and 418 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
README.md
View file

@ -6,6 +6,7 @@ It shall NOT be edited by hand.
# Librarian for YunoHost
[![Integration level](https://dash.yunohost.org/integration/librarian.svg)](https://dash.yunohost.org/appci/app/librarian) ![Working status](https://ci-apps.yunohost.org/ci/badges/librarian.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/librarian.maintain.svg)
[![Install Librarian with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=librarian)
*[Lire ce readme en français.](./README_fr.md)*

21
README_fr.md
View file

@ -5,15 +5,16 @@ It shall NOT be edited by hand.
# Librarian pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/librarian.svg)](https://dash.yunohost.org/appci/app/librarian) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/librarian.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/librarian.maintain.svg)
[![Niveau d’intégration](https://dash.yunohost.org/integration/librarian.svg)](https://dash.yunohost.org/appci/app/librarian) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/librarian.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/librarian.maintain.svg)
[![Installer Librarian avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=librarian)
*[Read this readme in english.](./README.md)*
> *Ce package vous permet d'installer Librarian 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 Librarian 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
An alternative frontend for LBRY/Odysee. Inspired by Invidious and Libreddit.
@ -30,15 +31,15 @@ An alternative frontend for LBRY/Odysee. Inspired by Invidious and Libreddit.
**Démo :** https://lbry.bcow.xyz/@RetroMusic:d/1987-Rick-Astley-Never-Gonna-Give-You-Up-1920x1080:f
## Captures d'écran
## Captures d’écran
![Capture d'écran de Librarian](./doc/screenshots/screeshot.png)
![Capture d’écran de Librarian](./doc/screenshots/screeshot.png)
## Documentations et ressources
* Site officiel de l'app : <https://lbry.bcow.xyz/>
* Documentation officielle de l'admin : <https://codeberg.org/librarian/librarian/wiki>
* Dépôt de code officiel de l'app : <https://codeberg.org/librarian/librarian>
* Site officiel de l’app : <https://lbry.bcow.xyz/>
* Documentation officielle de l’admin : <https://codeberg.org/librarian/librarian/wiki>
* Dépôt de code officiel de l’app : <https://codeberg.org/librarian/librarian>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_librarian>
* Signaler un bug : <https://github.com/YunoHost-Apps/librarian_ynh/issues>
@ -54,4 +55,4 @@ ou
sudo yunohost app upgrade librarian -u https://github.com/YunoHost-Apps/librarian_ynh/tree/testing --debug
```
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>

26
check_process
View file

@ -1,26 +0,0 @@
;; Test complet
; Manifest
domain="domain.tld"
path="/"
is_public=1
instance_country=France
instance_provider=OVH
; Checks
pkg_linter=1
setup_sub_dir=0
setup_root=1
setup_nourl=0
setup_private=1
setup_public=1
upgrade=1
#upgrade=1 from_commit=CommitHash
backup_restore=1
multi_instance=1
change_url=1
;;; Options
Email=
Notification=none
;;; Upgrade options
; commit=CommitHash
name=Name and date of the commit.
manifest_arg=domain=DOMAIN&path=PATH&is_public=1&language=fr&admin=USER&password=pass&port=666&

6
conf/amd64.src
View file

@ -1,6 +0,0 @@
SOURCE_URL=https://github.com/YunoHost-Apps/librarian_ynh/releases/download/v2022.05.14/librarian_2022-05-14_amd64.tar.gz
SOURCE_SUM=c50f1dd4061d9c66a79915d17be5c743a6b74a53ee0e3a87ba9036d56de2ce4d
SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=tar.gz
SOURCE_IN_SUBDIR=true
SOURCE_EXTRACT=true

6
conf/arm64.src
View file

@ -1,6 +0,0 @@
SOURCE_URL=https://github.com/YunoHost-Apps/librarian_ynh/releases/download/v2022.05.14/librarian_2022-05-14_arm64.tar.gz
SOURCE_SUM=02a666cfc65302fb5807aa214e9806e79077ed2b09dfe9c86d8a0595e3f5560f
SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=tar.gz
SOURCE_IN_SUBDIR=true
SOURCE_EXTRACT=true

6
conf/armhf.src
View file

@ -1,6 +0,0 @@
SOURCE_URL=https://github.com/YunoHost-Apps/librarian_ynh/releases/download/v2022.05.14/librarian_2022-05-14_armhf.tar.gz
SOURCE_SUM=d7a2657677382c8906d1758431a743b1b19d9f821674ece05a8fd0cc35fccb54
SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=tar.gz
SOURCE_IN_SUBDIR=true
SOURCE_EXTRACT=true

3
conf/nginx.conf
View file

@ -1,4 +1,5 @@
location / {
#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
location __PATH__/ {
proxy_pass http://127.0.0.1:__PORT__;
proxy_redirect off;

40
conf/systemd.service
View file

@ -1,14 +1,48 @@
[Unit]
Description=Librarian: An alternative frontend for LBRY/Odysee.
Description=Librarian: alternative frontend for LBRY/Odysee.
After=network.target
[Service]
Type=simple
User=__APP__
Group=__APP__
WorkingDirectory=__FINALPATH__/
ExecStart=__FINALPATH__/librarian
WorkingDirectory=__INSTALL_DIR__/
ExecStart=__INSTALL_DIR__/librarian
LimitNOFILE=65536
# Sandboxing options to harden security
# Depending on specificities of your service/app, you may need to tweak these
# .. but this should be a good baseline
# Details for these options: https://www.freedesktop.org/software/systemd/man/systemd.exec.html
NoNewPrivileges=yes
PrivateTmp=yes
PrivateDevices=yes
RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6 AF_NETLINK
RestrictNamespaces=yes
RestrictRealtime=yes
DevicePolicy=closed
ProtectClock=yes
ProtectHostname=yes
ProtectProc=invisible
ProtectSystem=full
ProtectControlGroups=yes
ProtectKernelModules=yes
ProtectKernelTunables=yes
LockPersonality=yes
SystemCallArchitectures=native
SystemCallFilter=~@clock @debug @module @mount @obsolete @reboot @setuid @swap @cpu-emulation @privileged
# Denying access to capabilities that should not be relevant for webapps
# Doc: https://man7.org/linux/man-pages/man7/capabilities.7.html
CapabilityBoundingSet=~CAP_RAWIO CAP_MKNOD
CapabilityBoundingSet=~CAP_AUDIT_CONTROL CAP_AUDIT_READ CAP_AUDIT_WRITE
CapabilityBoundingSet=~CAP_SYS_BOOT CAP_SYS_TIME CAP_SYS_MODULE CAP_SYS_PACCT
CapabilityBoundingSet=~CAP_LEASE CAP_LINUX_IMMUTABLE CAP_IPC_LOCK
CapabilityBoundingSet=~CAP_BLOCK_SUSPEND CAP_WAKE_ALARM
CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG
CapabilityBoundingSet=~CAP_MAC_ADMIN CAP_MAC_OVERRIDE
CapabilityBoundingSet=~CAP_NET_ADMIN CAP_NET_BROADCAST CAP_NET_RAW
CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG
[Install]
WantedBy=multi-user.target

6
config_panel.toml
View file

@ -2,7 +2,7 @@ version = "1.0"
[main]
name = "Librarian configuration"
services = ["__APP__"]
services = ["__ID__"]
[main.config]
name = "Configuration Options"
@ -11,10 +11,10 @@ services = ["__APP__"]
ask = "Instance country location"
type = "string"
help = "The country your instance is located. Leave blank if hosting on darknet."
bind = "INSTANCE_COUNTRY:__FINALPATH__/config.yml"
bind = "INSTANCE_COUNTRY:__INSTALL_DIR__/config.yml"
[main.config.instance_provider]
ask = "Name of your hosting provider"
type = "string"
help = "Put the name of your hosting provider. If hosting from home, use the name of your ISP. Leave blank if hosting on darknet."
bind = "INSTANCE_PROVIDER:__FINALPATH__/config.yml"
bind = "INSTANCE_PROVIDER:__INSTALL_DIR__/config.yml"

0
doc/DISCLAIMER.md
View file

BIN
doc/screenshots/screeshot.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 883 KiB

After

Width:  |  Height:  |  Size: 492 KiB

43
manifest.json
View file

@ -1,43 +0,0 @@
{
"name": "Librarian",
"id": "librarian",
"packaging_format": 1,
"description": {
"en": "Alternative frontend for LBRY/Odysee",
"fr": "Interface alternative pour LBRY/Odysee"
},
"version": "2022.05.14~ynh1",
"url": "https://lbry.bcow.xyz/",
"upstream": {
"license": "AGPL-3.0-only",
"website": "https://lbry.bcow.xyz/",
"demo": "https://lbry.bcow.xyz/@RetroMusic:d/1987-Rick-Astley-Never-Gonna-Give-You-Up-1920x1080:f",
"admindoc": "https://codeberg.org/librarian/librarian/wiki",
"code": "https://codeberg.org/librarian/librarian"
},
"license": "AGPL-3.0-only",
"maintainer": {
"name": "eric_G",
"email": ""
},
"requirements": {
"yunohost": ">= 4.3.0"
},
"multi_instance": true,
"services": [
"nginx"
],
"arguments": {
"install" : [
{
"name": "domain",
"type": "domain"
},
{
"name": "is_public",
"type": "boolean",
"default": true
}
]
}
}

58
manifest.toml Normal file
View file

@ -0,0 +1,58 @@
packaging_format = 2
id = "librarian"
name = "Librarian"
description.en = "Alternative frontend for LBRY/Odysee"
description.fr = "Interface alternative pour LBRY/Odysee"
version = "2022.05.14~ynh1"
maintainers = ["eric_G"]
[upstream]
license = "AGPL-3.0-only"
website = "https://lbry.bcow.xyz/"
demo = "https://lbry.bcow.xyz/@RetroMusic:d/1987-Rick-Astley-Never-Gonna-Give-You-Up-1920x1080:f"
admindoc = "https://codeberg.org/librarian/librarian/wiki"
code = "https://codeberg.org/librarian/librarian"
[integration]
yunohost = ">= 11.1.17"
architectures = ["amd64", "armhf", "arm64"]
multi_instance = true
ldap = false
sso = false
disk = "50M"
ram.build = "50M"
ram.runtime = "50M"
[install]
[install.domain]
type = "domain"
full_domain = true
[install.init_main_permission]
type = "group"
default = "visitors"
[resources]
[resources.sources.main]
arm64.url = "https://github.com/YunoHost-Apps/librarian_ynh/releases/download/v2022.05.14/librarian_2022-05-14_arm64.tar.gz"
arm64.sha256 = "02a666cfc65302fb5807aa214e9806e79077ed2b09dfe9c86d8a0595e3f5560f"
amd64.url = "https://github.com/YunoHost-Apps/librarian_ynh/releases/download/v2022.05.14/librarian_2022-05-14_amd64.tar.gz"
amd64.sha256 = "c50f1dd4061d9c66a79915d17be5c743a6b74a53ee0e3a87ba9036d56de2ce4d"
armhf.url = "https://github.com/YunoHost-Apps/librarian_ynh/releases/download/v2022.05.14/librarian_2022-05-14_armhf.tar.gz"
armhf.sha256 = "d7a2657677382c8906d1758431a743b1b19d9f821674ece05a8fd0cc35fccb54"
[resources.ports]
[resources.system_user]
[resources.install_dir]
[resources.permissions]
main.url = "/"
api.url="/api"
api.allowed="visitors"
api.show_tile = false
api.protected = true

1
scripts/_common.sh
View file

@ -4,7 +4,6 @@
# COMMON VARIABLES
#=================================================
#=================================================
# PERSONAL HELPERS
#=================================================

23
scripts/backup
View file

@ -10,27 +10,6 @@
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)
#=================================================
# DECLARE DATA AND CONF FILES TO BACKUP
#=================================================
@ -40,7 +19,7 @@ ynh_print_info --message="Declaring files to be backed up..."
# BACKUP THE APP MAIN DIR
#=================================================
ynh_backup --src_path="$final_path"
ynh_backup --src_path="$install_dir"
#=================================================
# BACKUP THE NGINX CONFIGURATION

93
scripts/change_url
View file

@ -9,62 +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)
instance_country=$(ynh_app_setting_get --app=$app --key=instance_country)
instance_provider=$(ynh_app_setting_get --app=$app --key=instance_provider)
#=================================================
# 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
#=================================================
@ -79,29 +23,7 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd"
#=================================================
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
#=================================================
# SPECIFIC MODIFICATIONS
@ -109,10 +31,10 @@ fi
ynh_script_progression --message="Adding a configuration file..." --weight=1
domain=$new_domain
ynh_add_config --template="../conf/config.example.yml" --destination="$final_path/config.yml"
ynh_add_config --template="../conf/config.example.yml" --destination="$install_dir/config.yml"
chmod 400 "$final_path/config.yml"
chown $app:$app "$final_path/config.yml"
chmod 400 "$install_dir/config.yml"
chown $app:$app "$install_dir/config.yml"
#=================================================
# GENERIC FINALISATION
@ -123,13 +45,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=3
ynh_systemd_action --service_name=$app --action="start" --log_path="systemd"
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================

86
scripts/install
View file

@ -9,83 +9,31 @@
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="/"
is_public=$YNH_APP_ARG_IS_PUBLIC
app=$YNH_APP_INSTANCE_NAME
instance_country=""
instance_provider=""
#=================================================
# CHECK IF THE APP CAN BE INSTALLED WITH THESE 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
ynh_app_setting_set --app=$app --key=instance_country --value=$instance_country
ynh_app_setting_set --app=$app --key=instance_provider --value=$instance_provider
#=================================================
# 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=8095)
ynh_app_setting_set --app=$app --key=port --value=$port
#=================================================
# 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=4
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" --source_id=$YNH_ARCH
ynh_setup_source --dest_dir="$install_dir"
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
chmod -R +x "$final_path/librarian"
chmod -R o-rwx "$install_dir"
chown -R $app:www-data "$install_dir"
chmod -R +x "$install_dir/librarian"
#=================================================
# NGINX CONFIGURATION
@ -100,10 +48,10 @@ ynh_add_nginx_config
#=================================================
ynh_script_progression --message="Adding a configuration file..." --weight=2
ynh_add_config --template="../conf/config.example.yml" --destination="$final_path/config.yml"
ynh_add_config --template="../conf/config.example.yml" --destination="$install_dir/config.yml"
chmod 400 "$final_path/config.yml"
chown $app:$app "$final_path/config.yml"
chmod 400 "$install_dir/config.yml"
chown $app:$app "$install_dir/config.yml"
#=================================================
# SETUP SYSTEMD
@ -128,26 +76,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=3
# Start a systemd service
ynh_systemd_action --service_name=$app --action="start" --log_path="systemd"
#=================================================
# SETUP SSOWAT
#=================================================
ynh_script_progression --message="Configuring permissions..." --weight=1
# Make app public if necessary
if [ $is_public -eq 1 ]
then
ynh_permission_update --permission="main" --add="visitors"
fi
ynh_permission_create --permission="api" --url="/api" --allowed="visitors" --show_tile="false" --protected="true"
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================

28
scripts/remove
View file

@ -9,16 +9,6 @@
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)
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
#=================================================
# STANDARD REMOVE
#=================================================
@ -40,14 +30,6 @@ ynh_script_progression --message="Stopping and removing the systemd service..."
# Remove the dedicated systemd config
ynh_remove_systemd_config
#=================================================
# 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
#=================================================
@ -56,16 +38,6 @@ ynh_script_progression --message="Removing NGINX web server configuration..." --
# 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
#=================================================

47
scripts/restore
View file

@ -10,36 +10,6 @@
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
#=================================================
@ -49,25 +19,16 @@ ynh_script_progression --message="Restoring the NGINX web server configuration..
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=4
ynh_restore_file --origin_path="$final_path"
ynh_restore_file --origin_path="$install_dir"
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
chmod -R +x "$final_path/librarian"
chmod -R o-rwx "$install_dir"
chown -R $app:www-data "$install_dir"
chmod -R +x "$install_dir/librarian"
#=================================================
# RESTORE SYSTEMD

57
scripts/upgrade
View file

@ -9,52 +9,23 @@
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)
instance_country=$(ynh_app_setting_get --app=$app --key=instance_country)
instance_provider=$(ynh_app_setting_get --app=$app --key=instance_provider)
#=================================================
# CHECK VERSION
#=================================================
upgrade_type=$(ynh_check_app_version_changed)
#=================================================
# 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
#=================================================
# ENSURE DOWNWARD COMPATIBILITY
#=================================================
ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
if [ -z "$instance_country" ]; then
if [ -z "${instance_country:-}" ]; then
instance_country=""
ynh_app_setting_set --app=$app --key=instance_country --value=$instance_country
fi
if [ -z "$instance_provider" ]; then
if [ -z "${instance_provider:-}" ]; then
instance_provider=""
ynh_app_setting_set --app=$app --key=instance_provider --value=$instance_provider
fi
@ -68,14 +39,6 @@ ynh_script_progression --message="Stopping a systemd service..." --weight=1
ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd"
#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
# Create a dedicated user (if not existing)
ynh_system_user_create --username=$app --home_dir="$final_path"
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
@ -85,13 +48,12 @@ then
ynh_script_progression --message="Upgrading source files..." --weight=1
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir="$final_path" --source_id=$YNH_ARCH --keep="$final_path/config.yml"
ynh_setup_source --dest_dir="$install_dir" --keep="config.yml"
fi
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
chmod -R +x "$final_path/librarian"
chmod -R o-rwx "$install_dir"
chown -R $app:www-data "$install_dir"
chmod -R +x "$install_dir/librarian"
#=================================================
# NGINX CONFIGURATION
@ -123,13 +85,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=4
ynh_systemd_action --service_name=$app --action="start" --log_path="systemd"
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================

14
tests.toml Normal file
View file

@ -0,0 +1,14 @@
test_format = 1.0
[default]
# -------------------------------
# Default args to use for install
# -------------------------------
args.instance_country = "France"
args.instance_provider = "OVH"
# -------------------------------
# Commits to test upgrade from
# -------------------------------