diff --git a/README.md b/README.md index b336ca6..1b111d3 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ It shall NOT be edited by hand. # Ergo for YunoHost [![Integration level](https://dash.yunohost.org/integration/ergo.svg)](https://dash.yunohost.org/appci/app/ergo) ![Working status](https://ci-apps.yunohost.org/ci/badges/ergo.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/ergo.maintain.svg) + [![Install Ergo with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ergo) *[Lire ce readme en français.](./README_fr.md)* @@ -34,14 +35,6 @@ Ergo (formerly known as Oragono) is a modern IRC server written in Go. Its core ![Screenshot of Ergo](./doc/screenshots/textual.jpg) -## Disclaimers / important information - -* Known Limitations: - * WebIRC has not been setup correctly for now - -* Other Information - * Command to become operator is `/OPER admin password_set_during_install` - ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index 61924c1..d7b26ff 100644 --- a/README_fr.md +++ b/README_fr.md @@ -6,6 +6,7 @@ It shall NOT be edited by hand. # Ergo pour YunoHost [![Niveau d’intégration](https://dash.yunohost.org/integration/ergo.svg)](https://dash.yunohost.org/appci/app/ergo) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/ergo.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/ergo.maintain.svg) + [![Installer Ergo avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ergo) *[Read this readme in english.](./README.md)* @@ -34,14 +35,6 @@ Ergo (formerly known as Oragono) is a modern IRC server written in Go. Its core ![Capture d’écran de Ergo](./doc/screenshots/textual.jpg) -## Avertissements / informations importantes - -* Known Limitations: - * WebIRC has not been setup correctly for now - -* Other Information - * Command to become operator is `/OPER admin password_set_during_install` - ## Documentations et ressources * Site officiel de l’app : diff --git a/check_process b/check_process deleted file mode 100644 index bfd7724..0000000 --- a/check_process +++ /dev/null @@ -1,27 +0,0 @@ -;; Test complet - ; Manifest - domain="domain.tld" - path="/path" - is_public=1 - language="en" - password="1Strong-Password" - enable_ldap=0 - network_name="ErgoYunohost" - server_name="ergo.yunohost" - ; Checks - pkg_linter=1 - setup_sub_dir=1 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - # 2.10.0~ynh2 - upgrade=1 from_commit=3ae32de58fbb4d2c69d2eef68736bbf36bb67079 - backup_restore=1 - multi_instance=1 - port_already_use=0 - change_url=1 -;;; Options -Email= -Notification=none diff --git a/conf/amd64.src b/conf/amd64.src deleted file mode 100644 index c715bc7..0000000 --- a/conf/amd64.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://github.com/ergochat/ergo/releases/download/v2.11.1/ergo-2.11.1-linux-x86_64.tar.gz -SOURCE_SUM=0b7912be327260ae91c4e2580cd83bf2cd86212d569972406a0be0b0eca3ef30 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= -SOURCE_EXTRACT=true diff --git a/conf/arm64.src b/conf/arm64.src deleted file mode 100644 index f89af75..0000000 --- a/conf/arm64.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://github.com/ergochat/ergo/releases/download/v2.11.1/ergo-2.11.1-linux-arm64.tar.gz -SOURCE_SUM=9ab1408f12cbbad25917658dc40937c76f0da1cc44962d8b2336ce7c8cbc9420 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= -SOURCE_EXTRACT=true diff --git a/conf/armhf.src b/conf/armhf.src deleted file mode 100644 index 6d54c6c..0000000 --- a/conf/armhf.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://github.com/ergochat/ergo/releases/download/v2.11.1/ergo-2.11.1-linux-armv6.tar.gz -SOURCE_SUM=959d99c8b042c8113f11c0b0401e18bbac4dfec47fdc8277c6529531f2f27e3b -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= -SOURCE_EXTRACT=true diff --git a/conf/default.yaml b/conf/default.yaml index 2c612db..6a82cba 100644 --- a/conf/default.yaml +++ b/conf/default.yaml @@ -46,7 +46,7 @@ server: # for details. # The standard SSL/TLS port for IRC is 6697. This will listen on all interfaces: - ":__SECURE_PORT__": + ":__PORT_SECURE__": # this is a standard TLS configuration with a single certificate; # see the manual for instructions on how to configure SNI tls: @@ -111,7 +111,7 @@ server: duration: 1mo2d5m # tls port - you should be listening on this port above - port: __SECURE_PORT__ + port: __PORT_SECURE__ # should clients include this STS policy when they ship their inbuilt preload lists? preload: false @@ -557,10 +557,10 @@ accounts: # see the manual for details on how to write an authentication plugin script auth-script: enabled: __LDAPOPTION__ - command: "__FINALPATH__/ergo-ldap" + command: "__INSTALL_DIR__/ergo-ldap" # constant list of args to pass to the command; the actual authentication # data is transmitted over stdin/stdout: - args: ["__FINALPATH__/ldap-config.yaml"] + args: ["__INSTALL_DIR__/ldap-config.yaml"] # should we automatically create users if the plugin returns success? autocreate: true # timeout for process execution, after which we send a SIGTERM: @@ -788,7 +788,7 @@ languages: default: __LANGUAGE__ # which directory contains our language files - path: "__FINALPATH__/languages" + path: "__INSTALL_DIR__/languages" # limits - these need to be the same across the network limits: diff --git a/conf/ldap.src b/conf/ldap.src deleted file mode 100644 index 49a6210..0000000 --- a/conf/ldap.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://github.com/YunoHost-Apps/ergo_ynh/releases/download/v.1/ergo-ldap.zip -SOURCE_SUM=4fa3e4511a5462e9a3b831db67d754d322fa1db41a708901dfae50fe3e959377 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=zip -SOURCE_IN_SUBDIR=false -SOURCE_FILENAME= -SOURCE_EXTRACT=true diff --git a/conf/nginx.conf b/conf/nginx.conf index e1f85f8..66515e2 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,4 +1,4 @@ #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; location __PATH__/ { - alias __FINAL_PATH_WWW__/help/; + alias __INSTALL_DIR_WWW__/help/; } diff --git a/conf/systemd.service b/conf/systemd.service index e5f1868..3fcbfaf 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -1,13 +1,13 @@ [Unit] -Description=ergo +Description=Ergo After=network.target [Service] Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ -ExecStart=__FINALPATH__/ergo run --conf __FINALPATH__/ircd.yaml +WorkingDirectory=__INSTALL_DIR__/ +ExecStart=__INSTALL_DIR__/ergo run --conf __INSTALL_DIR__/ircd.yaml StandardOutput=append:/var/log/__APP__/__APP__.log StandardError=inherit diff --git a/doc/DISCLAIMER.md b/doc/ADMIN.md similarity index 100% rename from doc/DISCLAIMER.md rename to doc/ADMIN.md diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 8b421e8..0000000 --- a/manifest.json +++ /dev/null @@ -1,106 +0,0 @@ -{ - "name": "Ergo", - "id": "ergo", - "packaging_format": 1, - "description": { - "en": "Modern IRC server (daemon/ircd)", - "fr": "Serveur IRC moderne (démon/ircd)" - }, - "version": "2.11.1~ynh1", - "url": "https://ergo.chat/", - "upstream": { - "license": "MIT", - "website": "https://ergo.chat/", - "demo": "https://testnet.ergo.chat/", - "admindoc": "https://github.com/ergochat/ergo/blob/stable/docs/MANUAL.md", - "userdoc": "https://github.com/ergochat/ergo/blob/stable/docs/USERGUIDE.md", - "code": "https://github.com/ergochat/ergo" - }, - "license": "MIT", - "maintainer": { - "name": "Navan Chauhan", - "email": "ergochat_ynh@navan.email" - }, - "requirements": { - "yunohost": ">= 11.0.9" - }, - "multi_instance": true, - "services": [ - "nginx" - ], - "arguments": { - "install": [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/ergo", - "default": "/ergo" - }, - { - "name": "is_public", - "type": "boolean", - "default": true, - "help": { - "en": "Enable WebIRC For Public" - } - }, - { - "name": "language", - "type": "string", - "ask": { - "en": "Choose the application language", - "fr": "Choisissez la langue de l'application" - }, - "choices": [ - "en", - "en-AU", - "el", - "es", - "fr-FR", - "no", - "pl", - "pt-BR", - "ro", - "tr-TR", - "zh-CN" - ], - "default": "fr-FR" - }, - { - "name": "password", - "type": "password", - "help": { - "en": "For using /OPER admin" - } - }, - { - "name": "enable_ldap", - "type": "boolean", - "default": false, - "ask": { - "en": "Enable ldap authentication script" - } - }, - { - "name": "network_name", - "type": "string", - "default": "ErgoYunoHost", - "ask": { - "en": "Network Name" - } - }, - { - "name": "server_name", - "type": "string", - "default": "ergo.yunohost", - "ask": { - "en": "Server Name" - } - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..0f07fb0 --- /dev/null +++ b/manifest.toml @@ -0,0 +1,107 @@ +packaging_format = 2 + +id = "ergo" +name = "Ergo" +description.en = "Modern IRC server (daemon/ircd)" +description.fr = "Serveur IRC moderne (démon/ircd)" + +version = "2.11.1~ynh1" + +maintainers = ["Navan Chauhan"] + +[upstream] +license = "MIT" +website = "https://ergo.chat/" +demo = "https://testnet.ergo.chat/" +admindoc = "https://github.com/ergochat/ergo/blob/stable/docs/MANUAL.md" +userdoc = "https://github.com/ergochat/ergo/blob/stable/docs/USERGUIDE.md" +code = "https://github.com/ergochat/ergo" + +[integration] +yunohost = ">= 11.1.19" +architectures = ["amd64", "arm64","armhf",] +multi_instance = true +ldap = true +sso = false +disk = "50M" +ram.build = "50M" +ram.runtime = "50M" + +[install] + [install.domain] + type = "domain" + + [install.path] + type = "path" + default = "/ergo" + + [install.init_main_permission] + help.en = "Enable WebIRC For Public" + help.fr = "Activer WebIRC pour le public" + type = "group" + default = "visitors" + + [install.language] + ask.en = "Choose the application language" + ask.fr = "Choisissez la langue de l'application" + type = "string" + choices = ["en", "en-AU", "el", "es", "fr-FR", "no", "pl", "pt-BR", "ro", "tr-TR", "zh-CN"] + default = "fr-FR" + + [install.password] + help.en = "For using /OPER admin" + help.fr = "Pour utiliser /OPER admin" + type = "password" + + [install.enable_ldap] + ask.en = "Enable LDAP authentication script" + ask.fr = "Activer le script d'authentification LDAP" + type = "boolean" + default = false + + [install.network_name] + ask.en = "Network Name" + ask.fr = "Nom du réseau" + type = "string" + default = "ErgoYunoHost" + + [install.server_name] + ask.en = "Server Name" + ask.fr = "Nom du serveur" + type = "string" + default = "ergo.yunohost" + +[resources] + [resources.sources] + [resources.sources.main] + arm64.url = "https://github.com/ergochat/ergo/releases/download/v2.11.1/ergo-2.11.1-linux-arm64.tar.gz" + arm64.sha256 = "9ab1408f12cbbad25917658dc40937c76f0da1cc44962d8b2336ce7c8cbc9420" + amd64.url = "https://github.com/ergochat/ergo/releases/download/v2.11.1/ergo-2.11.1-linux-x86_64.tar.gz" + amd64.sha256 = "0b7912be327260ae91c4e2580cd83bf2cd86212d569972406a0be0b0eca3ef30" + armhf.url = "https://github.com/ergochat/ergo/releases/download/v2.11.1/ergo-2.11.1-linux-armv6.tar.gz" + armhf.sha256 = "959d99c8b042c8113f11c0b0401e18bbac4dfec47fdc8277c6529531f2f27e3b" + + [resources.sources.ldap] + url = "https://github.com/YunoHost-Apps/ergo_ynh/releases/download/v.1/ergo-ldap.zip" + sha256 = "4fa3e4511a5462e9a3b831db67d754d322fa1db41a708901dfae50fe3e959377" + in_subdir = false + + [resources.ports] + main.default = 6667 + main.exposed = "TCP" + secure.default = 6697 + secure.exposed = "TCP" + + [resources.system_user] + + [resources.install_dir] + dir = "/opt/yunohost/__APP__" + + [resources.permissions] + main.url = "/" + + [resources.apt] + packages = "mariadb-server" + + [resources.database] + type = "mysql" diff --git a/scripts/backup b/scripts/backup index 34c0cb0..888ed02 100755 --- a/scripts/backup +++ b/scripts/backup @@ -10,28 +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) -final_path_www=$(ynh_app_setting_get --app=$app --key=final_path_www) -domain=$(ynh_app_setting_get --app=$app --key=domain) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) - #================================================= # DECLARE DATA AND CONF FILES TO BACKUP #================================================= @@ -41,8 +19,8 @@ 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="$final_path_www" +ynh_backup --src_path="$install_dir" +ynh_backup --src_path="$install_dir_www" #================================================= # BACKUP THE NGINX CONFIGURATION diff --git a/scripts/change_url b/scripts/change_url index 6a35a8e..f5ff536 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,61 +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..." --time --weight=1 - -# Needed for helper "ynh_add_nginx_config" -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -final_path_www=$(ynh_app_setting_get --app=$app --key=final_path_www) -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)..." --time --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 #================================================= @@ -78,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..." --time --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 @@ -111,13 +34,6 @@ ynh_script_progression --message="Starting a systemd service..." --time --weight 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..." --time --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/install b/scripts/install index 480a382..3147d5a 100755 --- a/scripts/install +++ b/scripts/install @@ -9,119 +9,40 @@ source _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 - -#================================================= -# RETRIEVE ARGUMENTS FROM THE MANIFEST -#================================================= - -domain=$YNH_APP_ARG_DOMAIN -path_url=$YNH_APP_ARG_PATH -is_public=$YNH_APP_ARG_IS_PUBLIC -language=$YNH_APP_ARG_LANGUAGE -password=$YNH_APP_ARG_PASSWORD -enable_ldap=$YNH_APP_ARG_ENABLE_LDAP -network_name=$YNH_APP_ARG_NETWORK_NAME -server_name=$YNH_APP_ARG_SERVER_NAME - -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=/opt/yunohost/$app -test ! -e "$final_path" || ynh_die --message="This path already contains a folder" -final_path_www=/var/www/$app -test ! -e "$final_path_www" || ynh_die --message="This path already contains a folder" +install_dir_www=/var/www/$app +ynh_app_setting_set --app=$app --key=install_dir_www --value=$install_dir_www -# 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=language --value=$language -ynh_app_setting_set --app=$app --key=network_name --value=$network_name -ynh_app_setting_set --app=$app --key=server_name --value=$server_name -ynh_app_setting_set --app=$app --key=final_path_www --value=$final_path_www -ynh_app_setting_set --app=$app --key=final_path --value=$final_path - -#================================================= -# 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=6667) # Plaintext Port -secure_port=$(ynh_find_port --port=6697) # Secure Port - -ynh_app_setting_set --app=$app --key=port --value=$port -ynh_app_setting_set --app=$app --key=secure_port --value=$secure_port - -ynh_script_progression --message="Configuring firewall..." --weight=1 -ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $port -ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $secure_port - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." --weight=2 - -# Create a system user -ynh_system_user_create --username=$app --home_dir="$final_path" --groups="ssl-cert" - -#================================================= -# CREATE A MYSQL DATABASE -#================================================= -ynh_script_progression --message="Creating a MySQL database..." --weight=1 - -db_name=$(ynh_sanitize_dbid --db_name=$app) -db_user=$db_name -ynh_app_setting_set --app=$app --key=db_name --value=$db_name -ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name +test ! -e "$install_dir_www" || ynh_die --message="This path already contains a folder" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." --weight=10 -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="$final_path" --source_id=ldap +ynh_setup_source --dest_dir="$install_dir" +ynh_setup_source --dest_dir="$install_dir" --source_id=ldap -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" -chmod +x "$final_path/ergo" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" +chmod +x "$install_dir/ergo" # Copy help file -mkdir -p "$final_path_www/help" +mkdir -p "$install_dir_www/help" if test -e "$YNH_APP_BASEDIR/sources/extra_files/help"; then - cp --archive "$YNH_APP_BASEDIR/sources/extra_files/help/." "$final_path_www/help" + cp --archive "$YNH_APP_BASEDIR/sources/extra_files/help/." "$install_dir_www/help" fi -ynh_replace_vars --file="$final_path_www/help/index.html" - -chmod 750 "$final_path_www" -chmod -R o-rwx "$final_path_www" -chown -R "www-data":"www-data" "$final_path_www" +ynh_replace_vars --file="$install_dir_www/help/index.html" +chmod 750 "$install_dir_www" +chmod -R o-rwx "$install_dir_www" +chown -R "www-data":"www-data" "$install_dir_www" #================================================= # NGINX CONFIGURATION @@ -139,7 +60,7 @@ ynh_add_nginx_config ynh_script_progression --message="Adding a configuration file..." --weight=2 # Get Password Hash -passwordhash=$((echo "$password"; echo "$password") | $final_path/ergo genpasswd) +passwordhash=$((echo "$password"; echo "$password") | $install_dir/ergo genpasswd) # Enable ldap authentication if necessary @@ -151,12 +72,12 @@ then fi server=$domain -ynh_add_config --template="../conf/default.yaml" --destination="$final_path/ircd.yaml" -ynh_add_config --template="../conf/ldap-config.yaml" --destination="$final_path/ldap-config.yaml" -ynh_add_config --template="../conf/ircd.motd" --destination="$final_path/ircd.motd" +ynh_add_config --template="../conf/default.yaml" --destination="$install_dir/ircd.yaml" +ynh_add_config --template="../conf/ldap-config.yaml" --destination="$install_dir/ldap-config.yaml" +ynh_add_config --template="../conf/ircd.motd" --destination="$install_dir/ircd.motd" -chmod 400 "$final_path/ircd.yaml" -chown $app: "$final_path/ircd.yaml" +chmod 400 "$install_dir/ircd.yaml" +chown $app: "$install_dir/ircd.yaml" #================================================= # SETUP SYSTEMD @@ -183,7 +104,7 @@ ynh_use_logrotate # Build the ports list needed_ports=() needed_ports+=( "$port" ) -needed_ports+=( "$secure_port" ) +needed_ports+=( "$port_secure" ) ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 @@ -197,26 +118,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=1 # 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 86ee92e..7e9d6e7 100755 --- a/scripts/remove +++ b/scripts/remove @@ -9,21 +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) -secure_port=$(ynh_app_setting_get --app=$app --key=secure_port) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -final_path_www=$(ynh_app_setting_get --app=$app --key=final_path_www) - #================================================= # STANDARD REMOVE #================================================= @@ -53,22 +38,13 @@ ynh_script_progression --message="Removing logrotate configuration..." --weight= # Remove the app-specific logrotate config ynh_remove_logrotate -#================================================= -# REMOVE THE MYSQL DATABASE -#================================================= -ynh_script_progression --message="Removing the MySQL database..." --weight=1 - -# Remove a database if it exists, along with the associated user -ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name - #================================================= # 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" -ynh_secure_remove --file="$final_path_www" +ynh_secure_remove --file="$install_dir_www" #================================================= # REMOVE NGINX CONFIGURATION @@ -78,32 +54,6 @@ ynh_script_progression --message="Removing NGINX web server configuration..." -- # Remove the dedicated NGINX config ynh_remove_nginx_config -#================================================= -# CLOSE A PORT -#================================================= - -if yunohost firewall list | grep -q "\- $port$" -then - ynh_script_progression --message="Closing port $port..." --weight=1 - ynh_exec_warn_less yunohost firewall disallow TCP $port -fi - -if yunohost firewall list | grep -q "\- $secure_port$" -then - ynh_script_progression --message="Closing port $secure_port..." --weight=1 - ynh_exec_warn_less yunohost firewall disallow TCP $secure_port -fi - -#================================================= -# 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 8ecbb75..6084448 100755 --- a/scripts/restore +++ b/scripts/restore @@ -10,69 +10,30 @@ 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_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) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -final_path_www=$(ynh_app_setting_get --app=$app --key=final_path_www) -port=$(ynh_app_setting_get --app=$app --key=port) -secure_port=$(ynh_app_setting_get --app=$app --key=secure_port) - #================================================= # 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 " - -test ! -d $final_path_www \ - || ynh_die --message="There is already a directory: $final_path_www " - -#================================================= -# 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" +test ! -d $install_dir_www \ + || ynh_die --message="There is already a directory: $install_dir_www " #================================================= # 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" -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" -ynh_restore_file --origin_path="$final_path_www" +ynh_restore_file --origin_path="$install_dir_www" -chmod 750 "$final_path_www" -chmod -R o-rwx "$final_path_www" -chown -R $app:www-data "$final_path_www" +chmod 750 "$install_dir_www" +chmod -R o-rwx "$install_dir_www" +chown -R $app:www-data "$install_dir_www" #================================================= # SPECIFIC RESTORATION @@ -88,8 +49,6 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= ynh_script_progression --message="Restoring the MySQL database..." --weight=1 -db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd) -ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql #================================================= @@ -115,7 +74,7 @@ ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 # Build the ports list needed_ports=() needed_ports+=( "$port" ) -needed_ports+=( "$secure_port" ) +needed_ports+=( "$port_secure" ) yunohost service add $app --description="A modern IRC server" --log="/var/log/$app/$app.log" ${needed_ports:+--needs_exposed_ports} "${needed_ports[@]}" diff --git a/scripts/upgrade b/scripts/upgrade index f38d94b..669f960 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,41 +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) -final_path_www=$(ynh_app_setting_get --app=$app --key=final_path_www) -port=$(ynh_app_setting_get --app=$app --key=port) -secure_port=$(ynh_app_setting_get --app=$app --key=secure_port) - #================================================= # CHECK VERSION #================================================= -ynh_script_progression --message="Checking version..." --weight=1 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 - #================================================= # STANDARD UPGRADE STEPS #================================================= @@ -53,14 +24,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" -#================================================= -# 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 #================================================= @@ -70,12 +33,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="ircd.yaml" + ynh_setup_source --dest_dir="$install_dir" --keep="ircd.yaml" 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,7 +74,7 @@ ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 # Build the ports list needed_ports=() needed_ports+=( "$port" ) -needed_ports+=( "$secure_port" ) +needed_ports+=( "$port_secure" ) yunohost service add $app --description="A modern IRC server" --log="/var/log/$app/$app.log" ${needed_ports:+--needs_exposed_ports} "${needed_ports[@]}" @@ -122,13 +85,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/sources/extra_files/help/index.html b/sources/extra_files/help/index.html index eaf3dd1..65ca2af 100644 --- a/sources/extra_files/help/index.html +++ b/sources/extra_files/help/index.html @@ -42,7 +42,7 @@
    Server Details:
      -
    • __DOMAIN__ on __PORT__ / __SECURE_PORT__ (SSL) +
    • __DOMAIN__ on __PORT__ / __PORT_SECURE__ (SSL)
diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..a5bc344 --- /dev/null +++ b/tests.toml @@ -0,0 +1,11 @@ +test_format = 1.0 + +[default] + + # ------------------------------- + # Default args to use for install + # ------------------------------- + + args.enable_ldap=0 + args.network_name="ErgoYunohost" + args.server_name="ergo.yunohost" \ No newline at end of file