Merge pull request #2294 from YunoHost/add-app_shell

Document `yunohost app shell`
This commit is contained in:
Alexandre Aubin 2023-06-20 19:14:25 +02:00 committed by GitHub
commit 72ca0c1eea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 0 deletions

View file

@ -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).

View file

@ -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