diff --git a/README.md b/README.md index f0128ed..f4cb32d 100644 --- a/README.md +++ b/README.md @@ -16,20 +16,18 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -This is a dummy description of this app features +RSSHub is an open source, easy to use, and extensible RSS feed generator. It's capable of generating RSS feeds from pretty much everything. RSSHub can be used with browser extension RSSHub Radar and mobile auxiliary app RSSBud (iOS) and RSSAid (Android) -**Shipped version:** 1.0~ynh1 - -**Demo:** https://demo.example.com +**Shipped version:** 2023.10.18~ynh1 ## Screenshots -![Screenshot of RSSHub](./doc/screenshots/example.jpg) +![Screenshot of RSSHub](./doc/screenshots/screenshot.png) ## Documentation and resources -* Official app website: +* Official app website: * Official admin documentation: * Upstream app code repository: * Report a bug: diff --git a/README_fr.md b/README_fr.md index 189c8c9..f18d604 100644 --- a/README_fr.md +++ b/README_fr.md @@ -16,20 +16,18 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po ## Vue d’ensemble -Ceci est une fausse description des fonctionalités de l'app +RSSHub est un générateur de flux RSS open source, facile à utiliser et extensible. Il est capable de générer des flux RSS à partir d'à peu près tout. RSSHub peut être utilisé avec l'extension de navigateur RSSHub Radar et l'application mobile auxiliaire RSSBud (iOS) et RSSAid (Android) -**Version incluse :** 1.0~ynh1 - -**Démo :** https://demo.example.com +**Version incluse :** 2023.10.18~ynh1 ## Captures d’écran -![Capture d’écran de RSSHub](./doc/screenshots/example.jpg) +![Capture d’écran de RSSHub](./doc/screenshots/screenshot.png) ## Documentations et ressources -* Site officiel de l’app : +* Site officiel de l’app : * Documentation officielle de l’admin : * Dépôt de code officiel de l’app : * Signaler un bug : diff --git a/conf/systemd.service b/conf/systemd.service index c43699e..8e5a7d8 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -1,5 +1,5 @@ [Unit] -Description=RSSHub +Description=RSSHub: RSS feed aggregator After=network.target [Service] diff --git a/doc/ADMIN.md b/doc/ADMIN.md deleted file mode 100644 index c9b5225..0000000 --- a/doc/ADMIN.md +++ /dev/null @@ -1,3 +0,0 @@ -This is a dummy admin doc for this app - -The app install dir is `__INSTALL_DIR__` diff --git a/doc/ADMIN_fr.md b/doc/ADMIN_fr.md deleted file mode 100644 index a138028..0000000 --- a/doc/ADMIN_fr.md +++ /dev/null @@ -1,3 +0,0 @@ -Ceci est une fausse doc d'admin pour cette app - -Le dossier d'install de l'app est `__INSTALL_DIR__` diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index 3f2e57a..927095f 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1 +1 @@ -This is a dummy description of this app features +RSSHub is an open source, easy to use, and extensible RSS feed generator. It's capable of generating RSS feeds from pretty much everything. RSSHub can be used with browser extension RSSHub Radar and mobile auxiliary app RSSBud (iOS) and RSSAid (Android) diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md index 13f4b64..95d3140 100644 --- a/doc/DESCRIPTION_fr.md +++ b/doc/DESCRIPTION_fr.md @@ -1 +1 @@ -Ceci est une fausse description des fonctionalités de l'app +RSSHub est un générateur de flux RSS open source, facile à utiliser et extensible. Il est capable de générer des flux RSS à partir d'à peu près tout. RSSHub peut être utilisé avec l'extension de navigateur RSSHub Radar et l'application mobile auxiliaire RSSBud (iOS) et RSSAid (Android) diff --git a/doc/POST_INSTALL.md b/doc/POST_INSTALL.md deleted file mode 100644 index f367b62..0000000 --- a/doc/POST_INSTALL.md +++ /dev/null @@ -1,7 +0,0 @@ -This is a dummy disclaimer to display after the install - -The app url is `__DOMAIN____PATH__` - -The app install dir is `__INSTALL_DIR__` - -The app id is `__ID__` diff --git a/doc/POST_UPGRADE.md b/doc/POST_UPGRADE.md deleted file mode 100644 index a58e2ae..0000000 --- a/doc/POST_UPGRADE.md +++ /dev/null @@ -1 +0,0 @@ -This is a dummy disclaimer to display after upgrades diff --git a/doc/PRE_INSTALL.md b/doc/PRE_INSTALL.md deleted file mode 100644 index eb3ab3a..0000000 --- a/doc/PRE_INSTALL.md +++ /dev/null @@ -1 +0,0 @@ -This is a dummy disclaimer to display prior to the install diff --git a/doc/PRE_INSTALL_fr.md b/doc/PRE_INSTALL_fr.md deleted file mode 100644 index 4a02cd5..0000000 --- a/doc/PRE_INSTALL_fr.md +++ /dev/null @@ -1 +0,0 @@ -Ceci est un faux disclaimer à présenter avant l'installation diff --git a/doc/PRE_UPGRADE.md b/doc/PRE_UPGRADE.md deleted file mode 100644 index 780fc15..0000000 --- a/doc/PRE_UPGRADE.md +++ /dev/null @@ -1 +0,0 @@ -This is a dummy disclaimer to display prior to any upgrade diff --git a/doc/screenshots/example.jpg b/doc/screenshots/example.jpg deleted file mode 100644 index a1efa1a..0000000 Binary files a/doc/screenshots/example.jpg and /dev/null differ diff --git a/doc/screenshots/screenshot.png b/doc/screenshots/screenshot.png new file mode 100644 index 0000000..146d137 Binary files /dev/null and b/doc/screenshots/screenshot.png differ diff --git a/manifest.toml b/manifest.toml index 55fd9de..cd77066 100644 --- a/manifest.toml +++ b/manifest.toml @@ -4,24 +4,23 @@ packaging_format = 2 id = "rsshub" name = "RSSHub" -description.en = "Explain in *a few (10~15) words* the purpose of the app or what it actually does (it is meant to give a rough idea to users browsing a catalog of 100+ apps)" -description.fr = "Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps)" +description.en = "Extensible RSS feed aggregator" +description.fr = "Agrégateur de flux RSS extensible" -version = "1.0~ynh1" +version = "2023.10.18~ynh1" -maintainers = ["johndoe"] +maintainers = ["eric_G"] [upstream] license = "MIT" -website = "https://example.com" -demo = "https://demo.example.com" +website = "https://docs.rsshub.app/" admindoc = "https://docs.rsshub.app/install/" code = "https://github.com/DIYgod/RSSHub" [integration] yunohost = ">= 11.2" architectures = "all" -multi_instance = true +multi_instance = false ldap = false @@ -44,16 +43,15 @@ ram.runtime = "50M" [resources.sources] [resources.sources.main] - url = "https://github.com/DIYgod/RSSHub/archive/67d4a7ed3f877a8ceac6caebe874c4ce5c210bd8.tar.gz" - sha256 = "6f30e0a44ad480a6f87e3f0ba82571bca11c0dadb23edd85f9c4120230a306ec" - autoupdate.strategy = "latest_github_tag" + url = "https://github.com/DIYgod/RSSHub/archive/c136303759f8b951e8a53193d7355d3e4af238e1.tar.gz" + sha256 = "881f2617ab7a17903f7f2248807e5d733f4eb57e470c5ab43143693d47d90ce5" + autoupdate.upstream = "https://github.com/DIYgod/RSSHub" + autoupdate.strategy = "latest_github_commit" [resources.system_user] [resources.install_dir] - #[resources.data_dir] - [resources.permissions] main.url = "/" diff --git a/scripts/backup b/scripts/backup index 4606e12..f8e82aa 100755 --- a/scripts/backup +++ b/scripts/backup @@ -21,13 +21,6 @@ ynh_print_info --message="Declaring files to be backed up..." ynh_backup --src_path="$install_dir" -#================================================= -# BACKUP THE DATA DIR -#================================================= - -# Only relevant if there is a "data_dir" resource for this app -ynh_backup --src_path="$data_dir" --is_big - #================================================= # BACKUP THE NGINX CONFIGURATION #================================================= @@ -40,13 +33,6 @@ ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" ynh_backup --src_path="/etc/systemd/system/$app.service" -#================================================= -# BACKUP THE MYSQL DATABASE -#================================================= -ynh_print_info --message="Backing up the MySQL database..." - -ynh_mysql_dump_db --database="$db_name" > db.sql - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/change_url b/scripts/change_url index ae914ad..3a9b28d 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -16,7 +16,7 @@ source /usr/share/yunohost/helpers #================================================= 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" +ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" #================================================= # MODIFY URL IN NGINX CONF @@ -32,7 +32,7 @@ ynh_change_url_nginx_config #================================================= 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" +ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" #================================================= # END OF SCRIPT diff --git a/scripts/install b/scripts/install index a5245df..2b20631 100755 --- a/scripts/install +++ b/scripts/install @@ -41,7 +41,7 @@ env_path="$PATH" # Create a dedicated systemd config ynh_add_systemd_config -yunohost service add $app --description="A short description of the app" --log="/var/log/$app/$app.log" +yunohost service add $app --description="RSS feed aggregator" --log="/var/log/$app/$app.log" #================================================= # APP INITIAL CONFIGURATION @@ -72,7 +72,7 @@ popd 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" +ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" #================================================= # END OF SCRIPT diff --git a/scripts/restore b/scripts/restore index 2ed831b..836773a 100755 --- a/scripts/restore +++ b/scripts/restore @@ -19,23 +19,6 @@ ynh_restore_file --origin_path="$install_dir" chown -R $app:www-data "$install_dir" -#================================================= -# RESTORE THE DATA DIRECTORY -#================================================= -ynh_script_progression --message="Restoring the data directory..." --weight=1 - -ynh_restore_file --origin_path="$data_dir" --not_mandatory - -# (Same as for install dir) -chown -R $app:www-data "$data_dir" - -#================================================= -# RESTORE THE MYSQL DATABASE -#================================================= -ynh_script_progression --message="Restoring the MySQL database..." --weight=1 - -ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql - #================================================= # REINSTALL DEPENDENCIES #================================================= @@ -56,7 +39,7 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" ynh_restore_file --origin_path="/etc/systemd/system/$app.service" systemctl enable $app.service --quiet -yunohost service add $app --description="A short description of the app" --log="/var/log/$app/$app.log" +yunohost service add $app --description="RSS feed aggregator" --log="/var/log/$app/$app.log" #================================================= # GENERIC FINALIZATION @@ -66,7 +49,7 @@ yunohost service add $app --description="A short description of the app" --log=" ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1 # Typically you only have either $app or php-fpm but not both at the same time... -ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" +ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" ynh_systemd_action --service_name=nginx --action=reload diff --git a/scripts/upgrade b/scripts/upgrade index 0393df2..858e3ed 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -11,6 +11,14 @@ source /usr/share/yunohost/helpers upgrade_type=$(ynh_check_app_version_changed) +#================================================= +# INSTALL DEPENDENCIES +#================================================= +ynh_script_progression --message="Installing dependencies..." --weight=7 + +# Install Nodejs +ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version + #================================================= # STOP SYSTEMD SERVICE #================================================= @@ -41,28 +49,29 @@ ynh_script_progression --message="Upgrading system configurations related to $ap ynh_add_nginx_config +env_path="$PATH" ynh_add_systemd_config -yunohost service add $app --description="A short description of the app" --log="/var/log/$app/$app.log" +yunohost service add $app --description="RSS feed aggregator" --log="/var/log/$app/$app.log" #================================================= # RECONFIGURE THE APP (UPDATE CONF, APPLY MIGRATIONS...) #================================================= # UPDATE A CONFIG FILE #================================================= -ynh_script_progression --message="Updating a configuration file..." --weight=1 +#ynh_script_progression --message="Updating a configuration file..." --weight=1 -ynh_add_config --template="some_config_file" --destination="$install_dir/some_config_file" +#ynh_add_config --template="some_config_file" --destination="$install_dir/some_config_file" -chmod 400 "$install_dir/some_config_file" -chown $app:$app "$install_dir/some_config_file" +#chmod 400 "$install_dir/some_config_file" +#chown $app:$app "$install_dir/some_config_file" #================================================= # START SYSTEMD SERVICE #================================================= 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" +ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" #================================================= # END OF SCRIPT diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..d3803cb --- /dev/null +++ b/tests.toml @@ -0,0 +1,11 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json + +test_format = 1.0 + +[default] + + # ------------ + # Tests to run + # ------------ + + exclude = ["install.multi"] \ No newline at end of file diff --git a/tests.toml.example b/tests.toml.example deleted file mode 100644 index 26bb7e4..0000000 --- a/tests.toml.example +++ /dev/null @@ -1,67 +0,0 @@ -#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json - -test_format = 1.0 - -[default] - - # ------------ - # Tests to run - # ------------ - - # NB: the tests to run are automatically deduced by the CI script according to the - # content of the app's manifest. The declarations below allow to customize which - # tests are ran, possibly add special test suite to test special args, or - # declare which commits to test upgrade from. - # - # You can also decide (though this is discouraged!) to ban/ignore some tests, - - exclude = ["install.private", "install.multi"] - # The test IDs to be used in only/exclude statements are: - # * install.root - # * install.subdir - # * install.nourl - # * install.multi - # * backup_restore - # * upgrade - # * upgrade.someCommitId - # * change_url - # NB: you should NOT need this except if you really have a good reason... - - # For special usecases, sometimes you need to setup other things on the machine - # prior to installing the app (such as installing another app) - # (Remove this key entirely if not needed) - preinstall = """ - sudo yunohost app install foobar - sudo yunohost user list - """ - - # ------------------------------- - # Default args to use for install - # ------------------------------- - - # By default, the CI will automagically fill the 'standard' args - # such as domain, path, admin, is_public and password with relevant values - # and also install args with a "default" provided in the manifest.. - # It should only make sense to declare custom args here for args with no default values - - args.language = "fr_FR" - args.multisite = 0 - # NB: you should NOT need those lines unless for custom questions with no obvious/default value - - # ------------------------------- - # Commits to test upgrade from - # ------------------------------- - - test_upgrade_from.00a1a6e7.name = "Upgrade from 5.4" - test_upgrade_from.00a1a6e7.args.foo = "bar" - - -# This is an additional test suite -[some_additional_testsuite] - - # On additional tests suites, you can decide to run only specific tests - - only = ["install.subdir"] - - args.language = "en_GB" - args.multisite = 1