1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/pmwiki_ynh.git synced 2024-09-03 20:06:40 +02:00
pmwiki_ynh/README.md
2022-05-22 10:06:57 +00:00

69 lines
No EOL
2.7 KiB
Markdown

<!--
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.
-->
# PmWiki for YunoHost
[![Integration level](https://dash.yunohost.org/integration/pmwiki.svg)](https://dash.yunohost.org/appci/app/pmwiki) ![](https://ci-apps.yunohost.org/ci/badges/pmwiki.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pmwiki.maintain.svg)
[![Install PmWiki with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pmwiki)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install PmWiki quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
PmWiki est un système de type wiki pour la création et l'entretien collectif de sites Internet.
### Features
- Présentation personnalisée ;
- Contrôle d'accès ;
- Personnalisation et modules
**Shipped version:** 2.3.4~ynh1
**Demo:** https://demo.example.com
## Screenshots
![](./doc/screenshots/example.jpg)
## Disclaimers / important information
* Any known limitations, constrains or stuff not working, such as (but not limited to):
* requiring a full dedicated domain ?
* architectures not supported ?
* not-working single-sign on or LDAP integration ?
* the app requires an important amount of RAM / disk / .. to install or to work properly
* etc...
* Other infos that people should be aware of, such as:
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
* how to configure / administrate the application if it ain't obvious
* upgrade process / specificities / things to be aware of ?
* security considerations ?
## Documentation and resources
* Official app website: https://www.pmwiki.org
* Official user documentation: https://www.pmwiki.org/wiki/PmWikiFr/PmWikiUsers
* Official admin documentation: https://www.pmwiki.org/wiki/PmWikiFr/PmWikiFr
* Upstream app code repository: https://some.forge.com/example/example
* YunoHost documentation for this app: https://yunohost.org/app_pmwiki
* Report a bug: https://github.com/YunoHost-Apps/pmwiki_ynh/issues
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/pmwiki_ynh/tree/testing).
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/pmwiki_ynh/tree/testing --debug
or
sudo yunohost app upgrade pmwiki -u https://github.com/YunoHost-Apps/pmwiki_ynh/tree/testing --debug
```
**More info regarding app packaging:** https://yunohost.org/packaging_apps