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

70 lines
2.5 KiB
Markdown
Raw Normal View History

2019-01-30 05:49:27 +01:00
# Wiki.js app for YunoHost
2019-01-29 21:56:56 +01:00
[![Integration level](https://dash.yunohost.org/integration/wikijs.svg)](https://dash.yunohost.org/appci/app/wikijs)
[![Install wikijs with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wikijs)
> *This package allow you to install wikijs 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.*
## Overview
An open source, modern and powerful wiki app built on Node.js, Git and Markdown for YunoHost.
2019-01-30 04:49:25 +01:00
2019-01-30 05:07:30 +01:00
**Wiki.js is still under development, all features not already implemented.**
2019-01-29 21:56:56 +01:00
2019-04-03 23:35:22 +02:00
**Wiki.js** require a dedicated **root domain**, eg. wikijs.domain.tld
2019-06-26 07:48:10 +02:00
**Shipped version:** 2.0.0-beta.208
2019-01-29 21:56:56 +01:00
2019-02-04 19:57:16 +01:00
## Screenshots
![wikijs-screenshot1](https://user-images.githubusercontent.com/30271971/52230053-b9ed3400-28b6-11e9-945e-355a752b8391.png)
![wikijs-screenshot2](https://user-images.githubusercontent.com/30271971/52230062-beb1e800-28b6-11e9-99c1-2bd04857600e.png)
2019-01-29 21:56:56 +01:00
## Demo
* [Official demo](https://docs-beta.requarks.io/)
## Documentation
* Official documentation: https://docs-beta.requarks.io/
## YunoHost specific features
#### Multi-users support
2019-02-05 20:32:36 +01:00
No LDAP and HTTP auth for now but planned to be supported.
The app can be used by multiple users?
2019-01-29 21:56:56 +01:00
#### Supported architectures
2019-05-15 14:00:19 +02:00
* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wikijs%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/wikijs/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wikijs%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wikijs/)
* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/wikijs%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/wikijs/)
2019-01-29 21:56:56 +01:00
## Limitations
* No known limitations.
## Links
* Report a bug: https://github.com/YunoHost-Apps/wikijs_ynh/issues
* App website: https://wiki.js.org/
* App GitHub website: https://github.com/Requarks/wiki
* YunoHost website: https://yunohost.org/
---
Developers info
----------------
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing).
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing --debug
or
sudo yunohost app upgrade wikijs -u https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing --debug
```