2021-05-20 00:23:21 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2020-09-07 18:14:58 +02:00
# Grav for YunoHost
2018-10-28 13:09:56 +01:00
2021-06-29 23:12:29 +02:00
[](https://dash.yunohost.org/appci/app/grav)  
[](https://install-app.yunohost.org/?app=grav)
2017-07-22 23:25:31 +02:00
2021-05-20 00:23:21 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2020-09-07 18:14:58 +02:00
2021-06-29 23:12:29 +02:00
> *This package allows you to install Grav quickly and simply on a YunoHost server.
2021-05-20 00:23:21 +02:00
If you don't have YunoHost, please consult [the guide ](https://yunohost.org/#/install ) to learn how to install it.*
2018-09-12 21:39:34 +02:00
2021-05-20 00:23:21 +02:00
## Overview
2020-09-07 18:14:58 +02:00
2021-05-20 00:23:21 +02:00
A modern open source flat-file CMS
2020-11-03 22:35:43 +01:00
2021-09-17 08:07:26 +02:00
**Shipped version:** 1.7.22~ynh1
2020-11-03 22:35:43 +01:00
2021-05-20 00:23:21 +02:00
**Demo:** https://getgrav.org/downloads/themes
2018-09-12 21:39:34 +02:00
2021-05-20 00:23:21 +02:00
## Screenshots
2020-09-07 18:14:58 +02:00
2021-06-29 23:12:29 +02:00
2015-11-11 18:23:02 +01:00
2021-05-20 00:23:21 +02:00
## Disclaimers / important information
2020-09-07 18:14:58 +02:00
2021-05-20 00:23:21 +02:00
* 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.
2020-09-07 18:14:58 +02:00
* 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)
2021-05-20 00:23:21 +02:00
* `php7.3 bin/grav ...` or `php7.3 bin/gpm ...`
2020-09-07 18:14:58 +02:00
* You can install plugins through the admin panel, or through the GPM.
2021-05-20 00:23:21 +02:00
* If installing Grav at the root of a domain, bear in mind that paths starting by `/yunohost` are reserved.
2020-09-07 18:14:58 +02:00
2021-05-20 00:23:21 +02:00
## Documentation and resources
2020-09-07 18:14:58 +02:00
2021-05-20 00:23:21 +02:00
* Official app website: https://www.getgrav.org/
* Official admin documentation: https://learn.getgrav.org
2021-06-29 23:12:29 +02:00
* Upstream app code repository: https://github.com/getgrav/grav
2021-05-20 00:23:21 +02:00
* YunoHost documentation for this app: https://yunohost.org/app_grav
* Report a bug: https://github.com/YunoHost-Apps/grav_ynh/issues
2020-09-07 18:14:58 +02:00
## 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.
```
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
```
2021-05-20 00:23:21 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps
