From 8aee94f289f8785ed9376a4fe3090a6bb4c1a411 Mon Sep 17 00:00:00 2001
From: tituspijean <tituspijean@outlook.com>
Date: Tue, 20 Jun 2023 19:10:54 +0200
Subject: [PATCH] Document `yunohost app shell`

---
 pages/02.administer/15.admin_guide/30.apps/apps.fr.md | 9 +++++++++
 pages/02.administer/15.admin_guide/30.apps/apps.md    | 8 ++++++++
 2 files changed, 17 insertions(+)

diff --git a/pages/02.administer/15.admin_guide/30.apps/apps.fr.md b/pages/02.administer/15.admin_guide/30.apps/apps.fr.md
index 9d63a3ba..72d7d4bc 100644
--- a/pages/02.administer/15.admin_guide/30.apps/apps.fr.md
+++ b/pages/02.administer/15.admin_guide/30.apps/apps.fr.md
@@ -43,6 +43,15 @@ Les applications web peuvent fournir des tuiles disponibles depuis le portail ut
 
 L'accès aux applications peut être limité à certains utilisateurs seulement. Ceci peut être configuré via la webadmin sur la page [Groupes et permissions](/groups_and_permissions), ou de la même manière via la sous-catégorie de commandes `yunohost user permission`.
 
+## Éxécuter des commandes au sein d'une app
+
+À partir de YunoHost v11.1.21.4, si vous avez besoin d'exécuter des commandes avec le binaire de l'application, ou des commandes PHP, etc., vous pouvez exécuter la commande `yunohost app shell <app>`.
+Cela aura pour effet de :
+- ouvrir un nouveau shell Bash en tant qu'utilisateur système de l'application
+- ouvrir le répertoire de travail de l'application (par exemple `/var/www/<app>`)
+- précharger l'environnement avec des variables provenant du service de l'application, s'il existe
+- remplacer `php`, pour qu'il pointe vers la version de PHP utilisée par l'application
+
 ## Packaging d'applications
 
 Si vous voulez apprendre ou contribuer à l'empaquetage des applications, veuillez consulter la [documentation des contributeurs](/contributordoc).
diff --git a/pages/02.administer/15.admin_guide/30.apps/apps.md b/pages/02.administer/15.admin_guide/30.apps/apps.md
index 5871ea6c..a8b12cde 100644
--- a/pages/02.administer/15.admin_guide/30.apps/apps.md
+++ b/pages/02.administer/15.admin_guide/30.apps/apps.md
@@ -157,6 +157,14 @@ The `<key>` is the setting name, for example `main.sftp.with_sftp` from above.
 [/ui-tab]
 [/ui-tabs]
 
+## Execute commands within the app
+
+Starting YunoHost v11.1.21.4, if you need to execute commands with the app's binary, or PHP commands, etc., you can execute the command `yunohost app shell <app>`.
+It will:
+- open a new Bash shell as the app's system user
+- open the app's working directory (e.g. `/var/www/<app>`)
+- preload the environment with variables taken from the app's service, if it exists
+- override `php`, so that it points to the PHP version used by the app
 
 ## Applications packaging