1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/wordpress_ynh.git synced 2024-09-03 20:36:10 +02:00

Merge pull request #33 from YunoHost-Apps/standard_readme

Proposition for a new standard readme
This commit is contained in:
Maniack Crudelis 2018-01-25 18:56:17 +01:00 committed by GitHub
commit d0f1ee88a2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,38 +1,67 @@
# Wordpress multisite for YunoHost
==================
# Wordpress for YunoHost
[Yunohost project](https://yunohost.org/#/)
https://wordpress.org/
[![Integration level](https://dash.yunohost.org/integration/wordpress.svg)](https://ci-apps.yunohost.org/jenkins/job/wordpress%20%28Official%29/lastBuild/consoleFull)
[![Install Wordpress with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wordpress)
=======
> *This package allow you to install wordpress quickly and simply on a YunoHost server.
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
## English version
Wordpress lets you create your blog or web site very easily. <br/>
With this package, you can even activate the [multisite](http://codex.wordpress.org/Glossary#Multisite)
## Overview
WordPress is open source software you can use to create a beautiful website, blog, or app.
With this package, you can even activate the [multisite](https://codex.wordpress.org/Glossary#Multisite) option.
**How to upgrade the package:**
1) sudo yunohost app upgrade --verbose wordpress -u https://github.com/YunoHost-Apps/wordpress_ynh <br/>
2) To be noted that once installed, the updates of the php code of the Wordpress blog are managed from the Wordpress web admin interface. <br/>
3) There may also be some upgrades of the wordpress_ynh package, these are to cover its integration whithin the Yunohost system.
**Shipped version:** 4.8
**Multi-user support:** Yes, with LDAP ability.
## Screenshots
**See the status of this package:**
*[Last weekly report](https://forum.yunohost.org/t/rapport-hebdomadaire-dintegration-continue/2297)*
*[Last continuous integration test](https://ci-apps.yunohost.org/jenkins/job/wordpress%20%28Official%29/lastBuild/consoleFull)*
![](https://s.w.org/images/home/screen-themes.png?1)
=======
## Configuration
## Version Française
Logiciel de création de blog ou de site Web avec option [multisite](http://codex.wordpress.org/Glossary#Multisite)
Use the admin panel of your wordpress to configure this app.
**Mise à jour du package:**
1) sudo yunohost app upgrade --verbose wordpress -u https://github.com/YunoHost-Apps/wordpress_ynh <br/>
2) A noter qu'une fois installé, les mises à jour du code php du blog Wordpress se font depuis l'interface wed d'admin de Wordpress <br/>
3) Il peut également y avoir des mises à jour du paquet wordpress_ynh, celles-ci sont liées à l'intégration du paquet dans le systeme Yunohost.
## Documentation
**Multi-utilisateur:** Oui, avec support ldap.
* Official documentation: https://codex.wordpress.org/
* YunoHost documentation: There no other documentations, feel free to contribute.
**Voir l'état du package:**
*[Dernier rapport hebdomadaire](https://forum.yunohost.org/t/rapport-hebdomadaire-dintegration-continue/2297)*
*[Dernier test d'intégration continue](https://ci-apps.yunohost.org/jenkins/job/wordpress%20%28Official%29/lastBuild/consoleFull)*
## YunoHost specific features
* Integration with YunoHost users and SSO:
* private mode: Blog only accessible by YunoHost users
* public mode: Visible by anyone, YunoHost users automatically connected
* Automatic update of wordpress core, plugins and themes
* Allow to set up a [multisite](https://codex.wordpress.org/Glossary#Multisite) instance.
#### Multi-users support
Supported, with LDAP and SSO.
#### Supported architectures
* Tested on x86_64
* Tested on RaspberryPi
## Limitations
* Multisite only available on subdirectories.
## Links
* Report a bug: https://github.com/YunoHost-Apps/wordpress_ynh/issues
* Wordpress website: https://wordpress.org/
* YunoHost website: https://yunohost.org/
---
Developers infos
----------------
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/wordpress_ynh/tree/testing).
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/wordpress_ynh/tree/testing --verbose
or
sudo yunohost app upgrade wordpress -u https://github.com/YunoHost-Apps/wordpress_ynh/tree/testing --verbose
```