2021-05-30 09:32:45 +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.
|
|
|
|
-->
|
|
|
|
|
2021-03-25 17:00:29 +01:00
|
|
|
# NodeBB for YunoHost
|
2017-04-08 01:04:30 +02:00
|
|
|
|
2021-03-25 17:00:29 +01:00
|
|
|
[![Integration level](https://dash.yunohost.org/integration/nodebb.svg)](https://dash.yunohost.org/appci/app/nodebb) ![](https://ci-apps.yunohost.org/ci/badges/nodebb.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/nodebb.maintain.svg)
|
2021-05-30 09:32:45 +02:00
|
|
|
[![Install NodeBB with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=nodebb)
|
2017-04-28 18:23:20 +02:00
|
|
|
|
2021-03-25 17:00:29 +01:00
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
2017-04-28 18:23:20 +02:00
|
|
|
|
2021-05-30 09:32:45 +02:00
|
|
|
> *This package allows you to install NodeBB quickly and simply on a YunoHost server.
|
2021-03-25 17:00:29 +01:00
|
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
2021-08-31 16:18:13 +02:00
|
|
|
NodeBB is built using the Node.js server-side Javascript platform, delivering unmatched performance.
|
|
|
|
Building on this high performance platform means fast and dependable performance that will support even the biggest and most active community.
|
2021-03-25 17:00:29 +01:00
|
|
|
|
2022-01-21 21:02:26 +01:00
|
|
|
**Shipped version:** 1.19.1~ynh1
|
2021-03-25 17:00:29 +01:00
|
|
|
|
2021-05-30 09:32:45 +02:00
|
|
|
**Demo:** https://try.nodebb.org
|
2021-03-25 17:00:29 +01:00
|
|
|
|
2021-05-30 09:32:45 +02:00
|
|
|
## Screenshots
|
2021-03-25 17:00:29 +01:00
|
|
|
|
2021-09-25 13:04:44 +02:00
|
|
|
![](./doc/screenshots/screenshot.png)
|
2021-03-25 17:00:29 +01:00
|
|
|
|
2021-05-30 10:10:11 +02:00
|
|
|
## Disclaimers / important information
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-05-30 09:32:45 +02:00
|
|
|
## Documentation and resources
|
2021-03-25 17:00:29 +01:00
|
|
|
|
2021-05-30 09:32:45 +02:00
|
|
|
* Official app website: https://nodebb.org
|
2021-09-01 16:31:57 +02:00
|
|
|
* Official admin documentation: https://docs.nodebb.org
|
|
|
|
* Upstream app code repository: https://github.com/NodeBB/NodeBB
|
2021-05-30 09:32:45 +02:00
|
|
|
* YunoHost documentation for this app: https://yunohost.org/app_nodebb
|
|
|
|
* Report a bug: https://github.com/YunoHost-Apps/nodebb_ynh/issues
|
2021-03-25 17:00:29 +01:00
|
|
|
|
|
|
|
## Developer info
|
|
|
|
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/nodebb_ynh/tree/testing).
|
|
|
|
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
```
|
|
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/nodebb_ynh/tree/testing --debug
|
|
|
|
or
|
|
|
|
sudo yunohost app upgrade nodebb -u https://github.com/YunoHost-Apps/nodebb_ynh/tree/testing --debug
|
|
|
|
```
|
2017-04-28 18:23:20 +02:00
|
|
|
|
2021-05-30 09:32:45 +02:00
|
|
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|