diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh deleted file mode 100755 index 222a746..0000000 --- a/.github/workflows/updater.sh +++ /dev/null @@ -1,102 +0,0 @@ -#!/bin/bash - -#================================================= -# PACKAGE UPDATING HELPER -#================================================= - -# This script is meant to be run by GitHub Actions -# The YunoHost-Apps organisation offers a template Action to run this script periodically -# Since each app is different, maintainers can adapt its contents so as to perform -# automatic actions when a new upstream release is detected. - -#================================================= -# FETCHING LATEST RELEASE AND ITS ASSETS -#================================================= - -# Fetching information -current_version=$(cat manifest.json | jq -j '.version|split("~")[0]') -repo=$(cat manifest.json | jq -j '.upstream.code|split("https://github.com/")[1]') -# Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions) -version=$(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1) -assets=($(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '[ .[] | select(.tag_name=="'$version'").assets[].browser_download_url ] | join(" ") | @sh' | tr -d "'")) - -# Later down the script, we assume the version has only digits and dots -# Sometimes the release name starts with a "v", so let's filter it out. -# You may need more tweaks here if the upstream repository has different naming conventions. -if [[ ${version:0:1} == "v" || ${version:0:1} == "V" ]]; then - version=${version:1} -fi - -# Setting up the environment variables -echo "Current version: $current_version" -echo "Latest release from upstream: $version" -echo "VERSION=$version" >> $GITHUB_ENV -echo "REPO=$repo" >> $GITHUB_ENV -# For the time being, let's assume the script will fail -echo "PROCEED=false" >> $GITHUB_ENV - -# Proceed only if the retrieved version is greater than the current one -if ! dpkg --compare-versions "$current_version" "lt" "$version" ; then - echo "::warning ::No new version available" - exit 0 -# Proceed only if a PR for this new version does not already exist -elif git ls-remote -q --exit-code --heads https://github.com/$GITHUB_REPOSITORY.git ci-auto-update-v$version ; then - echo "::warning ::A branch already exists for this update" - exit 0 -fi - -#================================================= -# UPDATE SOURCE FILES -#================================================= - -src="app" - -# Create the temporary directory -tempdir="$(mktemp -d)" - -# Download sources and calculate checksum -filename="v$version.tar.gz" -asset_url="https://github.com/advplyr/audiobookshelf/archive/refs/tags/v$version.tar.gz" -curl --silent -4 -L $asset_url -o "$tempdir/$filename" -checksum=$(sha256sum "$tempdir/$filename" | head -c 64) - -# Delete temporary directory -rm -rf $tempdir - -# Get extension -if [[ $filename == *.tar.gz ]]; then - extension=tar.gz -else - extension=${filename##*.} -fi - -# Rewrite source file -cat < conf/$src.src -SOURCE_URL=$asset_url -SOURCE_SUM=$checksum -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=$extension -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= -EOT -echo "... conf/$src.src updated" - -#================================================= -# SPECIFIC UPDATE STEPS -#================================================= - -# Any action on the app's source code can be done. -# The GitHub Action workflow takes care of committing all changes after this script ends. - -#================================================= -# GENERIC FINALIZATION -#================================================= - -# Replace new version in manifest -echo "$(jq -s --indent 4 ".[] | .version = \"$version~ynh1\"" manifest.json)" > manifest.json - -# No need to update the README, yunohost-bot takes care of it - -# The Action will proceed only if the PROCEED environment variable is set to true -echo "PROCEED=true" >> $GITHUB_ENV -exit 0 \ No newline at end of file diff --git a/.github/workflows/updater.yml b/.github/workflows/updater.yml deleted file mode 100644 index ec690a7..0000000 --- a/.github/workflows/updater.yml +++ /dev/null @@ -1,49 +0,0 @@ -# This workflow allows GitHub Actions to automagically update your app whenever a new upstream release is detected. -# You need to enable Actions in your repository settings, and fetch this Action from the YunoHost-Apps organization. -# This file should be enough by itself, but feel free to tune it to your needs. -# It calls updater.sh, which is where you should put the app-specific update steps. -name: Check for new upstream releases -on: - # Allow to manually trigger the workflow - workflow_dispatch: - # Run it every day at 6:00 UTC - schedule: - - cron: '0 6 * * *' -jobs: - updater: - runs-on: ubuntu-latest - steps: - - name: Fetch the source code - uses: actions/checkout@v3 - with: - token: ${{ secrets.GITHUB_TOKEN }} - - name: Run the updater script - id: run_updater - run: | - # Setting up Git user - git config --global user.name 'yunohost-bot' - git config --global user.email 'yunohost-bot@users.noreply.github.com' - # Run the updater script - /bin/bash ./.github/workflows/updater.sh - - name: Commit changes - id: commit - if: ${{ env.PROCEED == 'true' }} - run: | - git commit -am "Upgrade to v$VERSION" - - name: Create Pull Request - id: cpr - if: ${{ env.PROCEED == 'true' }} - uses: peter-evans/create-pull-request@v4 - with: - token: ${{ secrets.GITHUB_TOKEN }} - commit-message: Update to version ${{ env.VERSION }} - committer: 'yunohost-bot ' - author: 'yunohost-bot ' - signoff: false - branch: ci-auto-update-v${{ env.VERSION }} - base: testing - delete-branch: true - title: 'Upgrade to version ${{ env.VERSION }}' - body: | - Upgrade to v${{ env.VERSION }} - draft: false \ No newline at end of file diff --git a/README.md b/README.md index 107c219..23d14b6 100644 --- a/README.md +++ b/README.md @@ -27,14 +27,6 @@ Federated Lightning Address server anyone can self-host to receive Lightning pay ![Screenshot of Satdress](./doc/screenshots/example.jpg) -## Disclaimers / important information - -* Limitations: - * Requires a full dedicated domain - * No LDAP - -* Disclaimer: - * Promotes Crypto. Crypto products are unregulated and can be highly risky. There may be no regulatory recourse for any loss from such transactions. ## Documentation and resources * Official user documentation: diff --git a/README_fr.md b/README_fr.md index bd05c88..04d9482 100644 --- a/README_fr.md +++ b/README_fr.md @@ -27,14 +27,6 @@ Federated Lightning Address server anyone can self-host to receive Lightning pay ![Capture d’écran de Satdress](./doc/screenshots/example.jpg) -## Avertissements / informations importantes - -* Limitations: - * Requires a full dedicated domain - * No LDAP - -* Disclaimer: - * Promotes Crypto. Crypto products are unregulated and can be highly risky. There may be no regulatory recourse for any loss from such transactions. ## Documentations et ressources * Documentation officielle utilisateur : diff --git a/conf/app.src b/conf/app.src deleted file mode 100644 index a43c8ea..0000000 --- a/conf/app.src +++ /dev/null @@ -1,6 +0,0 @@ -SOURCE_URL=https://github.com/nbd-wtf/satdress/archive/refs/tags/v0.7.2.tar.gz -SOURCE_SUM=1f7ec9987ee5d84aa8da6e96f8a5028fe1e391b6cdb3fd3cce3b637701645972 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_EXTRACT=true diff --git a/conf/nginx.conf b/conf/nginx.conf index 10594a1..b5245b2 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,3 +1,4 @@ +#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; location __PATH__/ { proxy_pass http://127.0.0.1:__PORT__; @@ -8,5 +9,7 @@ location __PATH__/ { proxy_set_header X-Forwarded-Port $server_port; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Host $server_name; - + + # Include SSOWAT user panel. + include conf.d/yunohost_panel.conf.inc; } \ No newline at end of file diff --git a/conf/systemd.service b/conf/systemd.service index fd7a39d..fc8e80e 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -1,21 +1,21 @@ [Unit] -Description=Federated Lightning addresses server. +Description=Satdress: federated Lightning addresses server After=network.target [Service] Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -ExecStart=__FINALPATH__/bin/satdress +WorkingDirectory=__INSTALL_DIR__/ +ExecStart=__INSTALL_DIR__/bin/satdress Restart=on-failure RestartSec=10 Environment="PORT=__PORT__" Environment="DOMAIN=__DOMAIN__" Environment="SECRET=__RANDOMSTRING__" -Environment="SITE_OWNER_NAME=__SITEOWNER__" -Environment="SITE_OWNER_URL=__SITEOWNERURL__" -Environment="SITE_NAME=__SITENAME__" +Environment="SITE_OWNER_NAME=__SITE_OWNER__" +Environment="SITE_OWNER_URL=__SITE_OWNER_URL__" +Environment="SITE_NAME=__SITE_NAME__" # Sandboxing options to harden security # Details for these options: https://www.freedesktop.org/software/systemd/man/systemd.exec.html diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md deleted file mode 100644 index 5f6eb05..0000000 --- a/doc/DISCLAIMER.md +++ /dev/null @@ -1,6 +0,0 @@ -* Limitations: - * Requires a full dedicated domain - * No LDAP - -* Disclaimer: - * Promotes Crypto. Crypto products are unregulated and can be highly risky. There may be no regulatory recourse for any loss from such transactions. \ No newline at end of file diff --git a/manifest.json b/manifest.json deleted file mode 100644 index a6620bc..0000000 --- a/manifest.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "name": "Satdress", - "id": "satdress", - "packaging_format": 1, - "description": { - "en": "Federated Lightning addresses server", - "fr": "Serveur d'adresses Lightning fédéré" - }, - "version": "0.7.2~ynh1", - "url": "https://github.com/nbd-wtf/satdress", - "upstream": { - "license": "MIT", - "demo": "https://github.com/nbd-wtf/satdress", - "admindoc": "https://github.com/nbd-wtf/satdress", - "userdoc": "https://github.com/nbd-wtf/satdresss", - "code": "https://github.com/nbd-wtf/satdress" - }, - "license": "GPL-3.0-only", - "maintainer": { - "name": "Navan Chauhan", - "email": "satdress@navan.email" - }, - "requirements": { - "yunohost": ">= 11.1.15" - }, - "multi_instance": true, - "services": [ - "nginx" - ], - "arguments": { - "install": [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "site_name", - "type": "string", - "example": "YUNOSatdress", - "ask": { - "en": "Site name to be displayed" - } - }, - { - "name": "site_owner", - "type": "string", - "example": "@yhuser", - "ask": { - "en": "Site owner handle to be displayed" - } - }, - { - "name": "site_owner_url", - "type": "string", - "example": "https://t.me/someuser", - "ask": { - "en": "Site owner's URL to be displayed" - } - }, - { - "name": "is_public", - "type": "boolean", - "default": true, - "help": { - "en": "Allow non-YunoHost users" - } - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..d071224 --- /dev/null +++ b/manifest.toml @@ -0,0 +1,71 @@ +packaging_format = 2 + +id = "satdress" +name = "Satdress" +description.en = "Federated Lightning addresses server" +description.fr = "Serveur d'adresses Lightning fédéré" + +version = "0.7.2~ynh1" + +maintainers = ["Navan Chauhan"] + +[upstream] +license = "MIT" +demo = "https://github.com/nbd-wtf/satdress" +admindoc = "https://github.com/nbd-wtf/satdress" +userdoc = "https://github.com/nbd-wtf/satdresss" +code = "https://github.com/nbd-wtf/satdress" + +[integration] +yunohost = ">= 11.1.15" +architectures = "all" +multi_instance = true +ldap = false +sso = false +disk = "50M" +ram.build = "50M" +ram.runtime = "50M" + +[install] + [install.domain] + type = "domain" + full_domain = true + + [install.site_name] + ask.en = "Site name to be displayed" + ask.fr = "Nom du site à afficher" + type = "string" + example = "YUNOSatdress" + + [install.site_owner] + ask.en = "Site owner handle to be displayed" + ask.fr = "Identifiant du propriétaire du site à afficher" + type = "string" + example = "@yhuser" + + [install.site_owner_url] + ask.en = "Site owner's URL to be displayed" + ask.fr = "URL du propriétaire du site à afficher" + type = "string" + example = "https://t.me/someuser" + + [install.init_main_permission] + help.en = "Allow non-YunoHost users" + help.fr = "Autoriser les utilisateurs non-YunoHost" + type = "group" + default = "visitors" + +[resources] + [resources.sources.main] + url = "https://github.com/nbd-wtf/satdress/archive/refs/tags/v0.7.2.tar.gz" + sha256 = "1f7ec9987ee5d84aa8da6e96f8a5028fe1e391b6cdb3fd3cce3b637701645972" + autoupdate.strategy = "latest_github_tag" + + [resources.ports] + + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" diff --git a/scripts/backup b/scripts/backup index f78c623..737146f 100755 --- a/scripts/backup +++ b/scripts/backup @@ -10,26 +10,6 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_clean_setup () { - 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 #================================================= @@ -39,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 diff --git a/scripts/change_url b/scripts/change_url index b286df6..ae914ad 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,59 +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) - -#================================================= -# 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 #================================================= @@ -76,29 +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 #================================================= # GENERIC FINALISATION @@ -109,13 +34,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=1 ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" -#================================================= -# 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 272d9a3..5a3e3b9 100755 --- a/scripts/install +++ b/scripts/install @@ -10,90 +10,34 @@ source _common.sh source ynh_install_go source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_clean_setup () { - ynh_clean_check_starting -} -# 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 -sitename=$YNH_APP_ARG_SITE_NAME -siteowner=$YNH_APP_ARG_SITE_OWNER -siteownerurl=$YNH_APP_ARG_SITE_OWNER_URL - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# 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 +site_name=$YNH_APP_ARG_SITE_NAME +site_owner=$YNH_APP_ARG_SITE_OWNER +site_owner_url=$YNH_APP_ARG_SITE_OWNER_URL +randomstring=$(ynh_string_random --length=12) #================================================= # 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=sitename --value=$sitename -ynh_app_setting_set --app=$app --key=siteowner --value=$siteowner -ynh_app_setting_set --app=$app --key=siteownerurl --value=$siteownerurl - -#================================================= -# 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 - -#================================================= -# Generate and Store Secret String -#================================================= - -randomstring=$(ynh_string_random --length=12) +ynh_app_setting_set --app=$app --key=site_name --value=$site_name +ynh_app_setting_set --app=$app --key=site_owner --value=$site_owner +ynh_app_setting_set --app=$app --key=site_owner_url --value=$site_owner_url ynh_app_setting_set --app=$app --key=randomstring --value=$randomstring -#================================================= -# 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=3 -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/build" +ynh_setup_source --dest_dir="$install_dir/build" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # NGINX CONFIGURATION @@ -112,20 +56,20 @@ ynh_script_progression --message="Building the sources (it will take some time). ynh_exec_warn_less ynh_install_go --go_version=$GO_VERSION -pushd "$final_path/build" +pushd "$install_dir/build" # Build the sources ynh_use_go - export GOPATH="$final_path/build/go" - export GOCACHE="$final_path/build/.cache" - CGO_ENABLED=1 go build -trimpath -v -o "$final_path/bin/" > /dev/null 2>&1 + export GOPATH="$install_dir/build/go" + export GOCACHE="$install_dir/build/.cache" + CGO_ENABLED=1 go build -trimpath -v -o "$install_dir/bin/" > /dev/null 2>&1 popd -ynh_secure_remove --file="$final_path/build" +#REMOVEME? ynh_secure_remove --file="$install_dir/build" ynh_remove_go # Set permissions to app files -chown -R $app:root "$final_path" -chmod 750 "${final_path}/bin/satdress" +chown -R $app:root "$install_dir" +chmod 750 "${install_dir}/bin/satdress" #================================================= # SETUP SYSTEMD @@ -159,26 +103,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=2 # Start a systemd service ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" -#================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring permissions..." --weight=1 - -# Make app public if necessary -if [ $is_public -eq 1 ] -then - # Everyone can access the app. - # The "main" permission is automatically created before the install script. - 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 - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/remove b/scripts/remove index 9bbf87b..3b5236b 100755 --- a/scripts/remove +++ b/scripts/remove @@ -9,17 +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) -port=$(ynh_app_setting_get --app=$app --key=port) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) - #================================================= # STANDARD REMOVE #================================================= @@ -49,14 +38,6 @@ ynh_script_progression --message="Removing logrotate configuration..." --weight= # Remove the app-specific logrotate config ynh_remove_logrotate -#================================================= -# 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 #================================================= @@ -75,16 +56,6 @@ ynh_script_progression --message="Removing various files..." --weight=1 # Remove the log files ynh_secure_remove --file="/var/log/$app" -#================================================= -# 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 fec9f0f..f551fea 100755 --- a/scripts/restore +++ b/scripts/restore @@ -10,61 +10,15 @@ 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) -port=$(ynh_app_setting_get --app=$app --key=port) -sitename=$(ynh_app_setting_get --app=$app --key=sitename) -siteowner=$(ynh_app_setting_get --app=$app --key=siteowner) -siteownerurl=$(ynh_app_setting_get --app=$app --key=siteownerurl) -randomstring=$(ynh_app_setting_get --app=$app --key=randomstring) - -#================================================= -# 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 -#================================================= -# 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=2 -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 o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # SPECIFIC RESTORATION diff --git a/scripts/upgrade b/scripts/upgrade index edd47ec..fb780ca 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -10,42 +10,12 @@ source _common.sh source ynh_install_go 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) -sitename=$(ynh_app_setting_get --app=$app --key=sitename) -siteowner=$(ynh_app_setting_get --app=$app --key=siteowner) -siteownerurl=$(ynh_app_setting_get --app=$app --key=siteownerurl) -randomstring=$(ynh_app_setting_get --app=$app --key=randomstring) - #================================================= # 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=2 - -# 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 #================================================= @@ -55,26 +25,6 @@ ynh_script_progression --message="Stopping a systemd service..." --weight=1 ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log" -#================================================= -# ENSURE DOWNWARD COMPATIBILITY -#================================================= -ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 - -# 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 -#================================================= -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 #================================================= @@ -84,12 +34,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/build" --keep="$final_path/$sitename-multiple.db" + ynh_setup_source --dest_dir="$install_dir/build" --keep="$site_name-multiple.db" fi -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # NGINX CONFIGURATION @@ -111,20 +61,20 @@ then ynh_exec_warn_less ynh_install_go --go_version=$GO_VERSION - pushd "$final_path/build" + pushd "$install_dir/build" # Build the sources ynh_use_go - export GOPATH="$final_path/build/go" - export GOCACHE="$final_path/build/.cache" - CGO_ENABLED=1 go build -trimpath -v -o "$final_path/bin/" > /dev/null 2>&1 + export GOPATH="$install_dir/build/go" + export GOCACHE="$install_dir/build/.cache" + CGO_ENABLED=1 go build -trimpath -v -o "$install_dir/bin/" > /dev/null 2>&1 popd - ynh_secure_remove --file="$final_path/build" +#REMOVEME? ynh_secure_remove --file="$install_dir/build" ynh_remove_go fi -chown -R $app:root "$final_path" -chmod 750 "${final_path}/bin/satdress" +chown -R $app:root "$install_dir" +chmod 750 "${install_dir}/bin/satdress" #================================================= # SETUP SYSTEMD @@ -158,13 +108,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=1 ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" -#================================================= -# 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/ynh_install_go b/scripts/ynh_install_go index 4fbf4e9..2e26e29 100644 --- a/scripts/ynh_install_go +++ b/scripts/ynh_install_go @@ -30,7 +30,7 @@ export GOENV_ROOT="$goenv_install_dir" # However, $PATH is duplicated into $go_path to outlast any manipulation of $PATH # You can use the variable `$ynh_go_load_path` to quickly load your Go version # in $PATH for an usage into a separate script. -# Exemple: $ynh_go_load_path $final_path/script_that_use_gem.sh` +# Exemple: $ynh_go_load_path $install_dir/script_that_use_gem.sh` # # # Finally, to start a Go service with the correct version, 2 solutions @@ -72,7 +72,7 @@ ynh_use_go () { ynh_go_load_path="PATH=$PATH" # Sets the local application-specific Go version - pushd $final_path + pushd $install_dir $goenv_install_dir/bin/goenv local $go_version popd } diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..eb1b957 --- /dev/null +++ b/tests.toml @@ -0,0 +1,12 @@ +test_format = 1.0 + +[default] + + # ------------------------------- + # Default args to use for install + # ------------------------------- + + args.randomstring = "BUISDF3" + args.site_name="zamn" + args.site_owner="@zamn" + args.site_owner_url="https://zamn.com"