mirror of
https://github.com/YunoHost-Apps/wikijs_ynh.git
synced 2024-09-03 20:36:09 +02:00
77 lines
2.7 KiB
Markdown
77 lines
2.7 KiB
Markdown
# Usage of this package (REMOVE THIS SECTION BEFORE RELEASE)
|
|
- [X] Copy this app before working on it.
|
|
- [X] Edit `conf/nginx.conf` file to match application prerequisites.
|
|
- [ ] Edit `manifest.json` with application specific information.
|
|
- [ ] Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts.
|
|
- [X] Add a `LICENSE` file for the package.
|
|
- [X] Edit `README.md`.
|
|
|
|
# Example app for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/wikijs)
|
|
[](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.
|
|
|
|
**Wiki.js is still under development, all features not already implemented.**
|
|
|
|
**Shipped version:** 2.0.0-beta.11
|
|
|
|
## Licence
|
|
|
|
**LICENCE:** AGPL-3.0-or-later
|
|
|
|
## Demo
|
|
|
|
* [Official demo](https://docs-beta.requarks.io/)
|
|
|
|
## Configuration
|
|
|
|
How to configure this app: by an admin panel, a plain file with SSH, or any other way.
|
|
|
|
## Documentation
|
|
|
|
* Official documentation: https://docs-beta.requarks.io/
|
|
|
|
## YunoHost specific features
|
|
|
|
#### Multi-users support
|
|
|
|
Are LDAP and HTTP auth supported?
|
|
Can the app be used by multiple users?
|
|
|
|
#### Supported architectures
|
|
|
|
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/wikijs/)
|
|
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/wikijs/)
|
|
* Jessie x86-64b - [](https://ci-stretch.nohost.me/ci/apps/wikijs/)
|
|
|
|
## 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
|
|
```
|