1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/mediawiki_ynh.git synced 2024-09-03 19:46:05 +02:00
mediawiki_ynh/README.md

76 lines
3.3 KiB
Markdown
Raw Normal View History

2021-05-20 10:04:50 +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-06-10 13:54:31 +02:00
# MediaWiki for YunoHost
2019-02-27 23:52:47 +01:00
2021-06-09 08:38:30 +02:00
[![Integration level](https://dash.yunohost.org/integration/mediawiki.svg)](https://dash.yunohost.org/appci/app/mediawiki) ![](https://ci-apps.yunohost.org/ci/badges/mediawiki.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mediawiki.maintain.svg)
2021-05-20 10:04:50 +02:00
[![Install MediaWiki with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mediawiki)
2019-02-27 23:52:47 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2021-05-20 10:04:50 +02:00
> *This package allows you to install MediaWiki 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.*
2019-02-27 23:52:47 +01:00
## Overview
2021-05-20 10:04:50 +02:00
A free and open source software wiki package written in PHP, originally for use on Wikipedia.
2019-02-27 23:52:47 +01:00
2021-06-08 23:39:33 +02:00
**Shipped version:** 1.36.0
2019-02-27 23:52:47 +01:00
2021-05-20 10:04:50 +02:00
**Demo:** https://www.wikipedia.org/, https://www.mediawiki.org/wiki/Project:Sandbox
## Screenshots
2021-05-20 13:47:42 +02:00
![](./doc/screenshots/screenshot.avif)
2021-05-20 10:04:50 +02:00
## Disclaimers / important information
### Shipped extension versions
2021-05-20 12:18:38 +02:00
* [LDAPAuthentication2](https://www.mediawiki.org/wiki/Extension:LDAPAuthentication2)
* [LDAPAuthorization](https://www.mediawiki.org/wiki/Extension:LDAPAuthorization) (**disabled and unused for now**)
* [LDAPGroups](https://www.mediawiki.org/wiki/Extension:LDAPGroups) (**disabled and unused for now**)
* [LDAPUserInfo](https://www.mediawiki.org/wiki/Extension:LDAPUserInfo) (**disabled and unused for now**)
* [LDAPProvider](https://www.mediawiki.org/wiki/Extension:LDAPProvider)
* [PluggableAuth](https://www.mediawiki.org/wiki/Extension:PluggableAuth)
2020-06-10 15:09:08 +02:00
Some of the extensions are marked as "disabled and unused" because they are not immediately required but are part of the MediaWiki "LDAP Stack" which may be needed in future versions.
2019-02-27 23:52:47 +01:00
#### Multi-users support
2021-05-20 12:18:38 +02:00
* Is LDAP supported?: **yes**
* Is HTTP auth supported?: **no**
* Can the app be used by multiple users?: **yes**
2019-02-27 23:52:47 +01:00
#### Supported architectures
2021-05-20 12:18:38 +02:00
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mediawiki.svg)](https://ci-apps.yunohost.org/ci/apps/mediawiki/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mediawiki.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mediawiki/)
2019-02-27 23:52:47 +01:00
2021-05-20 10:04:50 +02:00
### How to configure this app:
2019-02-27 23:52:47 +01:00
2021-05-20 12:18:38 +02:00
* Through the admin panel: Log in then click on `Preferences`
2019-02-27 23:52:47 +01:00
2021-05-20 10:04:50 +02:00
## Documentation and resources
2019-02-27 23:52:47 +01:00
2021-05-20 10:04:50 +02:00
* Official app website: https://www.mediawiki.org
* Official user documentation: https://www.mediawiki.org/wiki/Project:Help
* Official admin documentation: https://www.mediawiki.org/wiki/Documentation
2021-06-09 08:38:30 +02:00
* Upstream app code repository: https://github.com/wikimedia/mediawiki
2021-05-20 10:04:50 +02:00
* YunoHost documentation for this app: https://yunohost.org/app_mediawiki
* Report a bug: https://github.com/YunoHost-Apps/mediawiki_ynh/issues
2019-02-27 23:52:47 +01:00
2021-05-20 10:04:50 +02:00
## Developer info
2019-02-27 23:52:47 +01:00
2021-05-20 10:04:50 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/mediawiki_ynh/tree/testing).
2019-02-27 23:52:47 +01:00
2020-06-10 13:54:31 +02:00
To try the testing branch, please proceed like that.
2019-02-27 23:52:47 +01:00
```
2020-06-10 13:54:31 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/mediawiki_ynh/tree/testing --debug
or
sudo yunohost app upgrade mediawiki -u https://github.com/YunoHost-Apps/mediawiki_ynh/tree/testing --debug
2019-02-27 23:52:47 +01:00
```
2021-05-20 10:04:50 +02:00
2021-06-09 08:38:30 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps