From 9bdeb506836c42394e875db55e2ed8e4c58598f6 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Fri, 5 Aug 2022 15:07:44 +0000 Subject: [PATCH] Auto-update README --- README.md | 26 ++++++++++++++------------ README_fr.md | 32 +++++++++++++++++++------------- 2 files changed, 33 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 1f20d97..ebbd164 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # Grav for YunoHost -[![Integration level](https://dash.yunohost.org/integration/grav.svg)](https://dash.yunohost.org/appci/app/grav) ![](https://ci-apps.yunohost.org/ci/badges/grav.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/grav.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/grav.svg)](https://dash.yunohost.org/appci/app/grav) ![Working status](https://ci-apps.yunohost.org/ci/badges/grav.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/grav.maintain.svg) [![Install Grav with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=grav) *[Lire ce readme en français.](./README_fr.md)* @@ -23,36 +23,38 @@ A modern open source flat-file CMS ## Screenshots -![](./doc/screenshots/grav.jpg) +![Screenshot of Grav](./doc/screenshots/grav.jpg) ## Disclaimers / important information * You can access the administration panel at `yourdomain.tld/path/admin`. Users created within YunoHost can log in, provided their were given the appropriate permissions: * To make users administrators, give them the `grav.admin` permission. * To allow users to log in, without extended rights, give them the `grav.user` permission. -* Grav provides a command line interface. Refer to its documentation, but you will need to specifically call for the PHP version currently used for the app: - * Go to your app's directory: `cd /var/www/grav` (or `grav__2`, etc. if you have multiple ones) - * `php7.3 bin/grav ...` or `php7.3 bin/gpm ...` +* Grav offers an SSH or SFTP access, which can be enabled in its YunoHost admin configuration panel. + * You can thus use its GPM command line binary. + Refer to is documentation, but bear in mind you need to call it by specifying the PHP version used by the app: + `php7.3 bin/grav ...` or `php7.3 bin/gpm ...` * You can install plugins through the admin panel, or through the GPM. * If installing Grav at the root of a domain, bear in mind that paths starting by `/yunohost` are reserved. ## Documentation and resources -* Official app website: https://www.getgrav.org/ -* Official admin documentation: https://learn.getgrav.org -* Upstream app code repository: https://github.com/getgrav/grav -* YunoHost documentation for this app: https://yunohost.org/app_grav -* Report a bug: https://github.com/YunoHost-Apps/grav_ynh/issues +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/grav_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/grav_ynh/tree/testing --debug or sudo yunohost app upgrade grav -u https://github.com/YunoHost-Apps/grav_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index a99af0f..fd62905 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,10 +1,14 @@ + + # Grav pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/grav.svg)](https://dash.yunohost.org/appci/app/grav) ![](https://ci-apps.yunohost.org/ci/badges/grav.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/grav.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/grav.svg)](https://dash.yunohost.org/appci/app/grav) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/grav.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/grav.maintain.svg) [![Installer Grav avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=grav) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer Grav 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.* @@ -19,36 +23,38 @@ Un CMS moderne basé sur des fichiers plats ## Captures d'écran -![](./doc/screenshots/grav.jpg) +![Capture d'écran de Grav](./doc/screenshots/grav.jpg) ## Avertissements / informations importantes * Vous pouvez accéder au panneau d'adminstration à l'adresse `votredomaine.tld/votrechemin/admin`. Les utilisateurs créés dans YunoHost peuvent se connecter, à condition de leur avoir octroyé la permission adéquate: * `grav.admin` pour qu'ils soient administrateur de Grav ; * `grav.user` pour qu'ils puissent se connecter, mais sans droit étendu. -* Grav dispose d'une interface par ligne de commande. Référez-vous à sa documentation, mais sachez que vous devrez préciser la version de PHP utilisée par l'app: - * Allez dans le répertoire de Grav: `cd /var/www/grav` (ou `grav__2`, etc. si vous avez de multiples instances) - * `php7.3 bin/grav ...` ou `php7.3 bin/gpm ...` +* Grav offre un accès par SSH ou SFTP, activable dans le panneau de configuration de l'application dans l'administration de YunoHost. + * Vous pouvez ainsi utiliser sa ligne de commande GPM. + Référez-vous à sa documentation, mais sachez que vous devrez préciser la version de PHP utilisée par l'app: + `php7.3 bin/grav ...` ou `php7.3 bin/gpm ...` * Vous pouvez installer les extensions soit via le panneau d'administration, soit via GPM. * Si vous installez Grav à la racin d'un domaine, sachez que les chemins d'accès commançant par `/yunohost` sont réservés. ## Documentations et ressources -* Site officiel de l'app : https://www.getgrav.org/ -* Documentation officielle de l'admin : https://learn.getgrav.org -* Dépôt de code officiel de l'app : https://github.com/getgrav/grav -* Documentation YunoHost pour cette app : https://yunohost.org/app_grav -* Signaler un bug : https://github.com/YunoHost-Apps/grav_ynh/issues +* Site officiel de l'app : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/grav_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/grav_ynh/tree/testing --debug ou sudo yunohost app upgrade grav -u https://github.com/YunoHost-Apps/grav_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d'infos sur le packaging d'applications :**