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

45 lines
1.9 KiB
Markdown
Raw Normal View History

2023-01-14 16:41:14 +01: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.
-->
2023-01-14 17:19:04 +01:00
# Bonfire for YunoHost
2023-01-14 16:41:14 +01:00
2023-01-14 17:19:04 +01:00
[![Integration level](https://dash.yunohost.org/integration/bonfire.svg)](https://dash.yunohost.org/appci/app/bonfire) ![Working status](https://ci-apps.yunohost.org/ci/badges/bonfire.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/bonfire.maintain.svg)
[![Install Bonfire with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=bonfire)
2023-01-14 16:41:14 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2023-01-14 17:19:04 +01:00
> *This package allows you to install Bonfire quickly and simply on a YunoHost server.
2023-01-14 16:41:14 +01:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2023-01-14 17:19:04 +01:00
Federated social networking server built on ActivityPub open protocol
2023-01-14 16:41:14 +01:00
2023-01-14 17:19:04 +01:00
**Shipped version:** 0.1~ynh1
2023-01-14 16:41:14 +01:00
2023-01-14 17:19:04 +01:00
**Demo:** https://playground.bonfire.cafe/
2023-01-14 16:41:14 +01:00
## Documentation and resources
2023-01-14 17:19:04 +01:00
* Official app website: <https://bonfirenetworks.org/>
* Official user documentation: <https://bonfirenetworks.org/docs/>
* Official admin documentation: <https://bonfirenetworks.org/docs/>
* Upstream app code repository: <https://github.com/bonfire-networks/bonfire-app>
* YunoHost documentation for this app: <https://yunohost.org/app_bonfire>
* Report a bug: <https://github.com/YunoHost-Apps/bonfire_ynh/issues>
2023-01-14 16:41:14 +01:00
## Developer info
2023-01-14 17:19:04 +01:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/bonfire_ynh/tree/testing).
2023-01-14 16:41:14 +01:00
To try the testing branch, please proceed like that.
``` bash
2023-01-14 17:19:04 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/bonfire_ynh/tree/testing --debug
2023-01-14 16:41:14 +01:00
or
2023-01-14 17:19:04 +01:00
sudo yunohost app upgrade bonfire -u https://github.com/YunoHost-Apps/bonfire_ynh/tree/testing --debug
2023-01-14 16:41:14 +01:00
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>