1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/chuwiki_ynh.git synced 2024-09-03 18:16:18 +02:00
chuwiki_ynh/README.md

56 lines
2.1 KiB
Markdown
Raw Normal View History

2021-04-01 13:19:44 +02:00
# ChuWiki for YunoHost
2021-04-01 12:47:58 +02:00
2021-04-01 13:19:44 +02:00
[![Integration level](https://dash.yunohost.org/integration/chuwiki.svg)](https://dash.yunohost.org/appci/app/chuwiki) ![](https://ci-apps.yunohost.org/ci/badges/chuwiki.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/chuwiki.maintain.svg)
[![Install chuwiki with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=chuwiki)
2021-04-01 12:47:58 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2021-04-01 13:19:44 +02:00
> *This package allows you to install ChuWiki quickly and simply on a YunoHost server.
2021-04-01 12:47:58 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2021-04-01 13:19:44 +02:00
A simple, fast and flexible wiki.
2021-04-01 12:47:58 +02:00
2021-04-01 13:19:44 +02:00
**Shipped version:** 2.0
2021-04-01 12:47:58 +02:00
## Configuration
2021-04-01 13:23:52 +02:00
How to configure this app: via the `configuration.ini` file.
2021-04-01 12:47:58 +02:00
## Documentation
2021-04-01 13:19:44 +02:00
* Official documentation: http://chuwiki.genezys.net/
2021-04-01 12:47:58 +02:00
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
## YunoHost specific features
#### Multi-user support
2021-04-01 13:19:44 +02:00
Are LDAP and HTTP auth supported? Yes.
Can the app be used by multiple users? Yes, but it is not specific to YunoHost but to the app.
2021-04-01 12:47:58 +02:00
#### Supported architectures
2021-04-01 13:19:44 +02:00
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/chuwiki%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/chuwiki/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/chuwiki%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/chuwiki/)
2021-04-01 12:47:58 +02:00
## Links
2021-04-01 13:19:44 +02:00
* Report a bug: https://github.com/YunoHost-Apps/chuwiki_ynh/issues
* App website: http://chuwiki.genezys.net/
2021-04-01 12:47:58 +02:00
* YunoHost website: https://yunohost.org/
---
## Developer info
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
2021-04-01 13:19:44 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/chuwiki_ynh/tree/testing).
2021-04-01 12:47:58 +02:00
To try the testing branch, please proceed like that.
```
2021-04-01 13:19:44 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/chuwiki_ynh/tree/testing --debug
2021-04-01 12:47:58 +02:00
or
2021-04-01 13:19:44 +02:00
sudo yunohost app upgrade chuwiki -u https://github.com/YunoHost-Apps/chuwiki_ynh/tree/testing --debug
2021-04-01 12:47:58 +02:00
```