diff --git a/issue_template.md b/.github/ISSUE_TEMPLATE.md old mode 100644 new mode 100755 similarity index 93% rename from issue_template.md rename to .github/ISSUE_TEMPLATE.md index f9dfef3..2729a6b --- a/issue_template.md +++ b/.github/ISSUE_TEMPLATE.md @@ -8,7 +8,7 @@ about: When creating a bug report, please use the following template to provide 1. *Read this whole template first.* 2. *Determine if you are on the right place:* - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!* - - *Otherwise, the issue may be due to PeerTube search-index itself. Refer to its documentation or repository for help.* + - *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.* - *When in doubt, post here and we will figure it out together.* 3. *Delete the italic comments as you write over them below, and remove this guide.* --- @@ -31,7 +31,7 @@ about: When creating a bug report, please use the following template to provide - *If you performed a command from the CLI, the command itself is enough. For example:* ```sh - sudo yunohost app install peertube-search-index + sudo yunohost app install the_app ``` - *If you used the webadmin, please perform the equivalent command from the CLI first.* - *If the error occurs in your browser, explain what you did:* diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100755 index 0000000..ef70e18 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +## Problem + +- *Description of why you made this PR* + +## Solution + +- *And how do you fix that problem* + +## PR Status + +- [ ] Code finished and ready to be reviewed/tested +- [ ] The fix/enhancement were manually tested (if applicable) + +## Automatic tests + +Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization) diff --git a/README.md b/README.md index 83a50be..4358a7f 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,48 @@ + + # PeerTube search-index for YunoHost [![Integration level](https://dash.yunohost.org/integration/peertube-search-index.svg)](https://dash.yunohost.org/appci/app/peertube-search-index) ![](https://ci-apps.yunohost.org/ci/badges/peertube-search-index.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/peertube-search-index.maintain.svg) [![Install PeerTube search-index with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=peertube-search-index) -> *This package allows you to install PeerTube search-index quickly and simply on a YunoHost server. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install PeerTube search-index quickly and simply on a YunoHost server. If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview + A search engine for [PeerTube](https://joinpeertube.org/) videos and channels, developed by Framasoft. -**Shipped version:** 0.0.1-2021-02-17 -## Important points to read before installing +**Shipped version:** 0.0.1.2021.12.28~ynh1 -1. **PeerTube search-index** require a dedicated **root domain**, eg. search.domain.tld +**Demo:** https://search.joinpeertube.org/ ## Screenshots -![](sepia-search-screenshot.png) +![](./doc/screenshots/sepia-search-screenshot.png) -## Demo +## Disclaimers / important information -* [Official demo](https://search.joinpeertube.org/) +## Important points to read before installing + +1. **PeerTube search-index** requires a dedicated **root domain**, e.g. search.domain.tld ## Configuration -To configure this app: modify the file /var/www/peertube-search-index/config/production.yaml with SSH. +To configure this app: modify the file `/var/www/peertube-search-index/config/production.yaml` with SSH. -## Documentation +## Documentation and resources - * Official documentation: https://framagit.org/framasoft/peertube/search-index - -## YunoHost specific features - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/peertube-search-index.svg)](https://ci-apps.yunohost.org/ci/apps/peertube-search-index/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/peertube-search-index.svg)](https://ci-apps-arm.yunohost.org/ci/apps/peertube-search-index/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/peertube-search-index_ynh/issues - * App website: https://search.joinpeertube.org/ - * Upstream app repository: https://framagit.org/framasoft/peertube/search-index - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://search.joinpeertube.org/ +* Official admin documentation: https://framagit.org/framasoft/peertube/search-index +* Upstream app code repository: https://framagit.org/framasoft/peertube/search-index +* YunoHost documentation for this app: https://yunohost.org/app_peertube-search-index +* Report a bug: https://github.com/YunoHost-Apps/peertube-search-index_ynh/issues ## Developer info @@ -57,3 +54,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/peertube-search-index or sudo yunohost app upgrade peertube-search-index -u https://github.com/YunoHost-Apps/peertube-search-index_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..aab6501 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,54 @@ +# PeerTube search-index pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/peertube-search-index.svg)](https://dash.yunohost.org/appci/app/peertube-search-index) ![](https://ci-apps.yunohost.org/ci/badges/peertube-search-index.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/peertube-search-index.maintain.svg) +[![Installer PeerTube search-index avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=peertube-search-index) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer PeerTube search-index 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 + +A search engine for [PeerTube](https://joinpeertube.org/) videos and channels, developed by Framasoft. + + +**Version incluse :** 0.0.1.2021.12.28~ynh1 + +**Démo :** https://search.joinpeertube.org/ + +## Captures d'écran + +![](./doc/screenshots/sepia-search-screenshot.png) + +## Avertissements / informations importantes + +## Important points to read before installing + +1. **PeerTube search-index** requires a dedicated **root domain**, e.g. search.domain.tld + +## Configuration + +To configure this app: modify the file `/var/www/peertube-search-index/config/production.yaml` with SSH. + +## Documentations et ressources + +* Site officiel de l'app : https://search.joinpeertube.org/ +* Documentation officielle de l'admin : https://framagit.org/framasoft/peertube/search-index +* Dépôt de code officiel de l'app : https://framagit.org/framasoft/peertube/search-index +* Documentation YunoHost pour cette app : https://yunohost.org/app_peertube-search-index +* Signaler un bug : https://github.com/YunoHost-Apps/peertube-search-index_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/peertube-search-index_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/peertube-search-index_ynh/tree/testing --debug +ou +sudo yunohost app upgrade peertube-search-index -u https://github.com/YunoHost-Apps/peertube-search-index_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/check_process b/check_process index 4e2bab9..904ffa6 100644 --- a/check_process +++ b/check_process @@ -1,7 +1,7 @@ ;; Test complet ; Manifest - domain="domain.tld" (DOMAIN) - is_public=1 (PUBLIC|public=1|private=0) + domain="domain.tld" + is_public=1 ; Checks pkg_linter=1 setup_sub_dir=1 diff --git a/conf/app.src b/conf/app.src index 731be7e..769239b 100644 --- a/conf/app.src +++ b/conf/app.src @@ -3,5 +3,5 @@ SOURCE_SUM=7a68fd70aeaac05d06fbbb3c8cf7a375e9d2e112235e4af6857630380e114b18 SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=tar.gz SOURCE_IN_SUBDIR=true -SOURCE_FILENAME=search-index-0.0.1-2020-12-24~ynh1.tar.gz +SOURCE_FILENAME=search-index.tar.gz SOURCE_EXTRACT=true diff --git a/conf/nginx.conf b/conf/nginx.conf index d37eb68..6dcc899 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -4,11 +4,6 @@ location __PATH__/ { # Path to source alias __FINALPATH__/ ; - # Force usage of https - if ($scheme = http) { - rewrite ^ https://$server_name$request_uri? permanent; - } - proxy_pass http://localhost:__PORT__; proxy_set_header X-Real-IP $remote_addr; proxy_set_header Host $host; diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..eabca23 --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1 @@ +A search engine for [PeerTube](https://joinpeertube.org/) videos and channels, developed by Framasoft. diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..da5f91e --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,7 @@ +## Important points to read before installing + +1. **PeerTube search-index** requires a dedicated **root domain**, e.g. search.domain.tld + +## Configuration + +To configure this app: modify the file `/var/www/peertube-search-index/config/production.yaml` with SSH. diff --git a/sepia-search-screenshot.png b/doc/screenshots/sepia-search-screenshot.png similarity index 100% rename from sepia-search-screenshot.png rename to doc/screenshots/sepia-search-screenshot.png diff --git a/manifest.json b/manifest.json index f20e585..4ebe38e 100644 --- a/manifest.json +++ b/manifest.json @@ -3,17 +3,24 @@ "id": "peertube-search-index", "packaging_format": 1, "description": { - "en": "A search engine for PeerTube videos and channels", - "fr": "Un moteur de recherche de vidéos et chaînes PeerTube" + "en": "Search engine for PeerTube videos and channels", + "fr": "Moteur de recherche de vidéos et chaînes PeerTube" }, - "version": "0.0.1-2021-02-17~ynh2", + "version": "0.0.1.2021.12.28~ynh1", "url": "https://search.joinpeertube.org/", + "upstream": { + "license": "AGPL-3.0-only", + "website": "https://search.joinpeertube.org/", + "demo": "https://search.joinpeertube.org/", + "admindoc": "https://framagit.org/framasoft/peertube/search-index", + "code": "https://framagit.org/framasoft/peertube/search-index" + }, "license": "AGPL-3.0-only", "maintainer": { "name": "yalh76" }, "requirements": { - "yunohost": ">= 4.2.0" + "yunohost": ">= 4.3.0" }, "multi_instance": true, "services": [ @@ -23,8 +30,7 @@ "install" : [ { "name": "domain", - "type": "domain", - "example": "example.com" + "type": "domain" }, { "name": "is_public", diff --git a/pull_request_template.md b/pull_request_template.md deleted file mode 100644 index 6c28fc5..0000000 --- a/pull_request_template.md +++ /dev/null @@ -1,16 +0,0 @@ -## Problem -- *Description of why you made this PR* - -## Solution -- *And how do you fix that problem* - -## PR Status -- [ ] Code finished. -- [ ] Tested with Package_check. -- [ ] Fix or enhancement tested. -- [ ] Upgrade from last version tested. -- [ ] Can be reviewed and tested. - -## Package_check results ---- -* An automatic package_check will be launch at https://ci-apps-dev.yunohost.org/, when you add a specific comment to your Pull Request: "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!"* diff --git a/scripts/_common.sh b/scripts/_common.sh index 2649474..54ce98f 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -13,7 +13,7 @@ NODEJS_VERSION=12 REPOSITORY="https://framagit.org/framasoft/peertube/search-index" -COMMIT="c29e7f02df4bd5cdfac3696de6d221f1beea041f" +COMMIT="5c8dc80186971f6f0b837ea484dde668ca437bd7" #================================================= # PERSONAL HELPERS diff --git a/scripts/install b/scripts/install index e5ac81c..e01cd6b 100644 --- a/scripts/install +++ b/scripts/install @@ -59,10 +59,6 @@ ynh_script_progression --message="Finding an available port..." port=$(ynh_find_port --port=8095) ynh_app_setting_set --app=$app --key=port --value=$port -# Optional: Expose this port publicly -# (N.B.: you only need to do this if the app actually needs to expose the port publicly. -# If you do this and the app doesn't actually need you are CREATING SECURITY HOLES IN THE SERVER !) - #================================================= # INSTALL DEPENDENCIES #================================================= @@ -105,7 +101,7 @@ chown -R $app:$app "$final_path" ynh_script_progression --message="Configuring NGINX web server..." # Create a dedicated NGINX config -ynh_add_nginx_config "port" +ynh_add_nginx_config #================================================= # SPECIFIC SETUP diff --git a/scripts/remove b/scripts/remove index 548ad77..43e1f46 100644 --- a/scripts/remove +++ b/scripts/remove @@ -73,16 +73,6 @@ ynh_script_progression --message="Removing logrotate configuration..." # Remove the app-specific logrotate config ynh_remove_logrotate -#================================================= -# CLOSE A PORT -#================================================= - -if yunohost firewall list | grep -q "\- $port$" -then - ynh_script_progression --message="Closing port $port..." - ynh_exec_warn_less yunohost firewall disallow TCP $port -fi - #================================================= # GENERIC FINALIZATION #================================================= diff --git a/scripts/restore b/scripts/restore index b049c37..fd1df9c 100644 --- a/scripts/restore +++ b/scripts/restore @@ -36,10 +36,7 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path) #================================================= ynh_script_progression --message="Validating restoration parameters..." -ynh_webpath_available --domain=$domain --path_url=$path_url \ - || ynh_die --message="Path not available: ${domain}${path_url}" -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " +test ! -d $final_path || ynh_die --message="There is already a directory: $final_path " #================================================= # STANDARD RESTORATION STEPS diff --git a/scripts/upgrade b/scripts/upgrade index b67da06..860b939 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -97,7 +97,7 @@ chown -R $app:$app "$final_path" ynh_script_progression --message="Upgrading NGINX web server configuration..." # Create a dedicated NGINX config -ynh_add_nginx_config "port" +ynh_add_nginx_config #================================================= # UPGRADE DEPENDENCIES