From 7a2eba44db560235b91a800d898bb6cabe47c817 Mon Sep 17 00:00:00 2001 From: tituspijean Date: Wed, 16 Aug 2023 18:06:32 +0200 Subject: [PATCH] Enhance login documentation --- doc/ADMIN.md | 17 ++++++++++++----- doc/ADMIN_fr.md | 21 ++++++++++++--------- 2 files changed, 24 insertions(+), 14 deletions(-) diff --git a/doc/ADMIN.md b/doc/ADMIN.md index 6269999..454a9bb 100644 --- a/doc/ADMIN.md +++ b/doc/ADMIN.md @@ -11,13 +11,20 @@ Once installed, go to the chosen URL to know the username, domain and port you w To connect, you'll need an SFTP app such as [Filezilla](https://filezilla-project.org/) for Windows, Mac or Linux. You can also use your default file manager on [Mac](https://support.apple.com/guide/mac-help/connect-mac-shared-computers-servers-mchlp1140/mac) or Linux. -### Adding or editing files - -Once logged in SFTP, under the Web directory, you will see a `www` folder which contains the public files served by this app. You can put all the files of your custom Web application inside. - -### Forgot your SFTP password? +#### Forgot your SFTP password? If you forgot your SFTP password, you can change it in YunoHost's webadmin interface in `Apps > My webapp > My Webapp configuration`. +You can also check there that SFTP is enabled. + +### Login using the command line + +Starting YunoHost v11.1.21, you can run `sudo yunohost app shell __APP__` in the command line interface to log in as your app user. + +The `php` command will point to the PHP version installed for the app. + +### Adding or editing files + +Once logged in, under the Web directory you will see a `www` folder which contains the public files served by this app. You can put all the files of your custom Web application inside. ### Customizing the nginx configuration diff --git a/doc/ADMIN_fr.md b/doc/ADMIN_fr.md index 562ba76..7822a12 100644 --- a/doc/ADMIN_fr.md +++ b/doc/ADMIN_fr.md @@ -9,20 +9,23 @@ Une fois installée, rendez-vous sur l'URL choisie pour connaître le nom d'util - Mot de passe: mot de passe défini lors de l'installation - Port: 22 (à moins que vous ayez changé le port SSH) -Pour vous connectez, vous devrez utiliser une application SFTP tel que [Filezilla](https://filezilla-project.org/) pour Windows, Mac ou Linux. Vous pouvez aussi directement utiliser votre gestionnaire de fichiers sous Linux ou [Mac](https://support.apple.com/guide/mac-help/connect-mac-shared-computers-servers-mchlp1140/mac). +Pour vous connecter, vous devrez utiliser une application SFTP tel que [Filezilla](https://filezilla-project.org/) pour Windows, Mac ou Linux. Vous pouvez aussi directement utiliser votre gestionnaire de fichiers sous Linux ou [Mac](https://support.apple.com/guide/mac-help/connect-mac-shared-computers-servers-mchlp1140/mac). + +#### Oubli du mot de passe SFTP + +Si vous avez oublié votre mot de passe SFTP, vous pouvez le changer dans la webadmin de Yunohost dans `Applications > Votre webapp > My Webapp configuration`. +Vous pourrez aussi vérifier que SFTP est activé pour votre app. + +### Connexion par le terminal + +A partir de YunoHost v11.1.21, vous pouvez lancer `sudo yunohost app shell __APP__` dans un terminal pour vous connecter en tant que l'utilisateur gérant l'app. + +La commande `php` pointera vers la version de PHP installée pour l'app. ### Ajouter ou modifier les fichiers Après vous être connecté avec SFTP, sous le répertoire Web, vous verrez un dossier `www` qui contient les fichiers publics servis par cette application. Vous pouvez mettre tous les fichiers de votre application Web personnalisée à l'intérieur. -### Oubli du mot de passe SFTP - -Si vous avez oublié votre mot de passe SFTP, vous pouvez le changer dans la webadmin de Yunohost dans `Applications > Votre webapp > My Webapp configuration`. - -## Résolution de problèmes - -Si vous n'arrivez pas à vous connecter et que vous avez vérifié que le nom d'utilisateur et le mot de passe sont bons, vérifiez si SFTP est activé pour votre app - ### Personnaliser la configuration nginx Si vous souhaitez ajuster la configuration nginx pour cette app, il est recommandé d'éditer `/etc/nginx/conf.d/__DOMAIN__.d/__ID__.d/WHATEVER_NAME.conf` (assurez-vous que le fichier a l'extension `.conf`) puis rechargez nginx après vous être assuré que la configuration est valide à l'aide de `nginx -t`.