YunoHost-Apps/grav_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/grav_ynh.git synced 2024-09-03 19:16:01 +02:00
Code Issues Activity Actions 1

Add documentation

Browse source
This commit is contained in:
tituspijean 2023-04-27 23:53:52 +02:00
parent bc0896e9a0
commit 6f65ab1b46
No known key found for this signature in database
GPG key ID: EF3B0D7CC0A94720
4 changed files with 12 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/DISCLAIMER.md → doc/ADMIN.md
View file

@ -1,9 +1,10 @@
* 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: * You can access the administration panel at `__DOMAIN____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 make users administrators, give them the `grav.admin` permission.
* To allow users to log in, without extended rights, give them the `grav.user` permission. * To allow users to log in, without extended rights, give them the `grav.user` permission.
* Grav offers an SSH or SFTP access, which can be enabled in its YunoHost admin configuration panel. * 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. * 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: 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 ...` 1. `cd __INSTALL_DIR__`
2. `sudo -u __APP__ php__PHPVERSION__ bin/grav ...` or `sudo -u __APP__ php__PHPVERSION__bin/gpm ...`
* You can install plugins through the admin panel, or through the 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. * If installing Grav at the root of a domain, bear in mind that paths starting by `/yunohost` are reserved.

7
doc/DISCLAIMER_fr.md → doc/ADMIN_fr.md
View file

@ -1,9 +1,10 @@
* 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: * Vous pouvez accéder au panneau d'adminstration à l'adresse `__DOMAIN____PATH__/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.admin` pour qu'ils soient administrateur de Grav ;
* `grav.user` pour qu'ils puissent se connecter, mais sans droit étendu. * `grav.user` pour qu'ils puissent se connecter, mais sans droit étendu.
* Grav offre un accès par SSH ou SFTP, activable dans le panneau de configuration de l'application dans l'administration de YunoHost. * 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. * 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: 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 ...` 1. `cd __INSTALL_DIR__`
2. `sudo -u __APP__ php__PHPVERSION__ bin/grav ...` ou `sudo -u __APP__ php__PHPVERSION__ bin/gpm ...`
* Vous pouvez installer les extensions soit via le panneau d'administration, soit via 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. * Si vous installez Grav à la racine d'un domaine, sachez que les chemins d'accès commançant par `/yunohost` sont réservés.

3
doc/POST_INSTALL.md Normal file
View file

@ -0,0 +1,3 @@
Grav has been successfully installed!
You can enable or disable its SFTP access, or tweak its PHP-FPM resources profile within its configuration panel in the webadmin.

4
manifest.toml
View file

@ -22,8 +22,8 @@ fund = "https://opencollective.com/grav"
yunohost = ">= 11.1" yunohost = ">= 11.1"
architectures = "all" architectures = "all"
multi_instance = true multi_instance = true
ldap = "true" ldap = true
sso = "false" sso = false
disk = "50M" disk = "50M"
ram.build = "50M" ram.build = "50M"
ram.runtime = "50M" ram.runtime = "50M"