diff --git a/issue_template.md b/.github/ISSUE_TEMPLATE.md similarity index 94% rename from issue_template.md rename to .github/ISSUE_TEMPLATE.md index c017fee..2729a6b 100644 --- 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 Searx 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 searx + 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 100644 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 759abb2..3bbbbb4 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,42 @@ + + # Searx for YunoHost [![Integration level](https://dash.yunohost.org/integration/searx.svg)](https://dash.yunohost.org/appci/app/searx) ![](https://ci-apps.yunohost.org/ci/badges/searx.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/searx.maintain.svg) [![Install Searx with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=searx) -> *This package allow you to install Searx quickly and simply on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/install) to know how to install and enjoy it.* +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Searx 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 -Searx is a privacy-respecting, hackable metasearch engine. -**Shipped version:** 1.0.0 +Privacy-respecting, hackable metasearch engine -## Screenshot +**Shipped version:** 1.0.0~ynh2 -![](Screenshot.png) +**Demo:** https://demo.yunohost.org/searx/ -## Demo +## Screenshots -* [YunoHost demo](https://demo.yunohost.org/searx/) +![](./doc/screenshots/Screenshot.png) -## Configuration +## Documentation and resources -## Documentation +* Official app website: https://searx.github.io/searx/ +* Official user documentation: https://yunohost.org/apps +* Official admin documentation: https://github.com/searx/searx/wiki +* Upstream app code repository: https://github.com/searx/searx +* YunoHost documentation for this app: https://yunohost.org/app_searx +* Report a bug: https://github.com/YunoHost-Apps/searx_ynh/issues - * Official documentation: https://github.com/searx/searx/wiki +## Developer info -## YunoHost specific features - -#### Multi-users support - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/searx.svg)](https://ci-apps.yunohost.org/ci/apps/searx/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/searx.svg)](https://ci-apps-arm.yunohost.org/ci/apps/searx/) - -## Limitations - -## Additional information - -- [Search syntax](https://searx.github.io/searx/user/search_syntax.html) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/searx_ynh/issues - * Searx website: https://searx.github.io/searx/ - * Searx repository: https://github.com/searx/searx - * YunoHost website: https://yunohost.org/ - ---- - -## Developers info - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/searx_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/searx_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -59,3 +44,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/searx_ynh/tree/testin or sudo yunohost app upgrade searx -u https://github.com/YunoHost-Apps/searx_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..23cd3bb --- /dev/null +++ b/README_fr.md @@ -0,0 +1,44 @@ +# Searx pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/searx.svg)](https://dash.yunohost.org/appci/app/searx) ![](https://ci-apps.yunohost.org/ci/badges/searx.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/searx.maintain.svg) +[![Installer Searx avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=searx) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Searx 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 + +Méta-moteur de recherche respectueux de la vie privée et bidouillable + +**Version incluse :** 1.0.0~ynh2 + +**Démo :** https://demo.yunohost.org/searx/ + +## Captures d'écran + +![](./doc/screenshots/Screenshot.png) + +## Documentations et ressources + +* Site officiel de l'app : https://searx.github.io/searx/ +* Documentation officielle utilisateur : https://yunohost.org/apps +* Documentation officielle de l'admin : https://github.com/searx/searx/wiki +* Dépôt de code officiel de l'app : https://github.com/searx/searx +* Documentation YunoHost pour cette app : https://yunohost.org/app_searx +* Signaler un bug : https://github.com/YunoHost-Apps/searx_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/searx_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/searx_ynh/tree/testing --debug +ou +sudo yunohost app upgrade searx -u https://github.com/YunoHost-Apps/searx_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 9b4f39b..7eeb2ed 100644 --- a/check_process +++ b/check_process @@ -1,8 +1,8 @@ ;; Test complet ; Manifest - domain="domain.tld" (DOMAIN) - path="/path" (PATH) - is_public=1 (PUBLIC|public=1|private=0) + domain="domain.tld" + path="/path" + is_public=1 ; Checks pkg_linter=1 setup_sub_dir=1 @@ -11,7 +11,7 @@ setup_private=1 setup_public=1 upgrade=1 - upgrade=1 from_commit=8843877c494c6b47edf2846cb6f1664e4404815c + upgrade=1 from_commit=24d48bd0e1268cae80a496855dbd9d404cd555ca backup_restore=1 multi_instance=0 change_url=1 @@ -19,6 +19,6 @@ Email= Notification=none ;;; Upgrade options - ; commit=8843877c494c6b47edf2846cb6f1664e4404815c - name=Fix Merge pull request #57 from YunoHost-Apps/16 + ; commit=24d48bd0e1268cae80a496855dbd9d404cd555ca + name=Merge pull request #84 manifest_arg=domain=DOMAIN&path=PATH&is_public=1& diff --git a/Screenshot.png b/doc/screenshots/Screenshot.png similarity index 100% rename from Screenshot.png rename to doc/screenshots/Screenshot.png diff --git a/manifest.json b/manifest.json index 09af11e..49c5394 100644 --- a/manifest.json +++ b/manifest.json @@ -7,15 +7,23 @@ "fr": "Méta-moteur de recherche respectueux de la vie privée et bidouillable", "de": "Meta-Suchmaschine, die den Privatsphäre wahrt und 'hackable' ist." }, - "version": "1.0.0~ynh1", + "version": "1.0.0~ynh2", "url": "https://searx.github.io/searx/", + "upstream": { + "license": "AGPL-3.0-or-later", + "website": "https://searx.github.io/searx/", + "demo": "https://demo.yunohost.org/searx/", + "admindoc": "https://github.com/searx/searx/wiki", + "userdoc": "https://yunohost.org/apps", + "code": "https://github.com/searx/searx" + }, "license": "AGPL-3.0-or-later", "maintainer": { "name": "opi", "email": "opi@zeropi.net" }, "requirements": { - "yunohost": ">= 4.1.7" + "yunohost": ">= 4.2.4" }, "multi_instance": false, "services": [ diff --git a/pull_request_template.md b/pull_request_template.md deleted file mode 100644 index 0a198cf..0000000 --- a/pull_request_template.md +++ /dev/null @@ -1,16 +0,0 @@ -## Problem -- *Description of why you made this PR* - -## Solution -- *And how you fix that* - -## 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!"*