xwiki_ynh/README.md

<!--
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.
-->

# XWiki for YunoHost

[![Integration level](https://dash.yunohost.org/integration/xwiki.svg)](https://ci-apps.yunohost.org/ci/apps/xwiki/) ![Working status](https://ci-apps.yunohost.org/ci/badges/xwiki.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/xwiki.maintain.svg)

[![Install XWiki with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=xwiki)

*[Read this README in other languages.](./ALL_README.md)*

> *This package allows you to install XWiki 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

XWiki is an Open Source wiki engine (LGPLv2) suitable for use by workgroups (associations, companies, etc.). The software allows the rapid creation of small applications to meet different information management needs.

**Shipped version:** 16.5.0~ynh1

**Demo:** <https://playground.xwiki.org/xwiki/bin/view/Main/WebHome>

## Screenshots

![Screenshot of XWiki](./doc/screenshots/XWiki-standard-help.jpg)

## Documentation and resources

- Official app website: <https://www.xwiki.org/>
- Official user documentation: <https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/>
- Official admin documentation: <https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/>
- Upstream app code repository: <https://github.com/xwiki/xwiki-platform>
- YunoHost Store: <https://apps.yunohost.org/app/xwiki>
- Report a bug: <https://github.com/YunoHost-Apps/xwiki_ynh/issues>

## Developer info

Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/xwiki_ynh/tree/testing).

To try the `testing` branch, please proceed like that:

```bash
sudo yunohost app install https://github.com/YunoHost-Apps/xwiki_ynh/tree/testing --debug
or
sudo yunohost app upgrade xwiki -u https://github.com/YunoHost-Apps/xwiki_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>