YunoHost-Apps/biboumi_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/biboumi_ynh.git synced 2024-09-03 18:15:58 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
Yunohost-Bot 2021-08-17 18:22:43 +00:00 • committed by Yunohost-Bot
parent 695eb61dc4
commit 6eea1ac02d
2 changed files with 81 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
README.md
View file

@ -1,47 +1,46 @@
<!--
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.
-->
# Biboumi for YunoHost # Biboumi for YunoHost
[![Integration level](https://dash.yunohost.org/integration/biboumi.svg)](https://dash.yunohost.org/appci/app/biboumi) ![](https://ci-apps.yunohost.org/ci/badges/biboumi.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/biboumi.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/biboumi.svg)](https://dash.yunohost.org/appci/app/biboumi) ![](https://ci-apps.yunohost.org/ci/badges/biboumi.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/biboumi.maintain.svg)
[![Install biboumi with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=biboumi) [![Install Biboumi with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=biboumi)
> *This package allows you to install Biboumi quickly and simply on a YunoHost server. *[Lire ce readme en français.](./README_fr.md)*
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
> *This package allows you to install Biboumi 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.*
## Overview ## Overview
Biboumi is an XMPP gateway for the IRC network. XMPP gateway for the IRC network.
**Shipped version:** 8.3~ynh1
## Disclaimers / important information
Once biboumi_ynh is installed you can use any XMPP client software to join IRC channels. Any IRC channel is seen as a standard XMPP chatroom (aka MUC) with a special name. Once biboumi_ynh is installed you can use any XMPP client software to join IRC channels. Any IRC channel is seen as a standard XMPP chatroom (aka MUC) with a special name.
The the name is formatted like this: `#channelname%ircservername@biboumi.yourdomain.tld`. The the name is formatted like this: `#channelname%ircservername@biboumi.yourdomain.tld`.
For example, if you have a YunoHost server hosting domain *example.net* and you want to join the channel *#yunohost* on *irc.freenode.net* you simply need to join the MUC `#yunohost%irc.freenode.net@biboumi.example.net`. For example, if you have a YunoHost server hosting domain *example.net* and you want to join the channel *#yunohost* on *irc.freenode.net* you simply need to join the MUC `#yunohost%irc.freenode.net@biboumi.example.net`.
**Shipped version:** 8.3 * Any known limitations, constrains or stuff not working, such as (but not limited to):
* Currently, Biboumi is only tested with one domain and it must be the main domain of your YunoHost server.
## Configuration * Other infos that people should be aware of, such as:
* You can configure Biboumi with the file `/etc/biboumi/biboumi.cfg`.
You can configure Biboumi with the file `/etc/biboumi/biboumi.cfg`. ## Documentation and resources
## Documentation * Official app website: https://biboumi.louiz.org/
* Official admin documentation: Official documentation: https://lab.louiz.org/louiz/biboumi/blob/8.3/doc/biboumi.1.rst
* Official documentation: https://lab.louiz.org/louiz/biboumi/blob/8.3/doc/biboumi.1.rst * Upstream app code repository: https://lab.louiz.org/louiz/biboumi
* YunoHost documentation for this app: https://yunohost.org/app_biboumi
#### Supported architectures * Report a bug: https://github.com/YunoHost-Apps/biboumi_ynh/issues
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/biboumi%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/biboumi/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/biboumi%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/biboumi/)
## Limitations
* Currently, Biboumi is only tested with one domain and it must be the main domain of your YunoHost server.
## Links
* Report a bug: https://github.com/YunoHost-Apps/biboumi_ynh/issues
* App website: https://biboumi.louiz.org/
* Upstream app repository: https://lab.louiz.org/louiz/biboumi/-/issues
* YunoHost website: https://yunohost.org/
---
## Developer info ## Developer info
@ -53,3 +52,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/biboumi_ynh/tree/test
or or
sudo yunohost app upgrade biboumi -u https://github.com/YunoHost-Apps/biboumi_ynh/tree/testing --debug sudo yunohost app upgrade biboumi -u https://github.com/YunoHost-Apps/biboumi_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** https://yunohost.org/packaging_apps

52
README_fr.md Normal file
View file

@ -0,0 +1,52 @@
# Biboumi pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/biboumi.svg)](https://dash.yunohost.org/appci/app/biboumi) ![](https://ci-apps.yunohost.org/ci/badges/biboumi.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/biboumi.maintain.svg)
[![Installer Biboumi avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=biboumi)
*[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer Biboumi rapidement et simplement sur un serveur YunoHost.
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble
Passerelle XMPP pour le réseau IRC.
**Version incluse :** 8.3~ynh1
## Avertissements / informations importantes
Once biboumi_ynh is installed you can use any XMPP client software to join IRC channels. Any IRC channel is seen as a standard XMPP chatroom (aka MUC) with a special name.
The the name is formatted like this: `#channelname%ircservername@biboumi.yourdomain.tld`.
For example, if you have a YunoHost server hosting domain *example.net* and you want to join the channel *#yunohost* on *irc.freenode.net* you simply need to join the MUC `#yunohost%irc.freenode.net@biboumi.example.net`.
* Any known limitations, constrains or stuff not working, such as (but not limited to):
* Currently, Biboumi is only tested with one domain and it must be the main domain of your YunoHost server.
* Other infos that people should be aware of, such as:
* You can configure Biboumi with the file `/etc/biboumi/biboumi.cfg`.
## Documentations et ressources
* Site officiel de l'app : https://biboumi.louiz.org/
* Documentation officielle de l'admin : Official documentation: https://lab.louiz.org/louiz/biboumi/blob/8.3/doc/biboumi.1.rst
* Dépôt de code officiel de l'app : https://lab.louiz.org/louiz/biboumi
* Documentation YunoHost pour cette app : https://yunohost.org/app_biboumi
* Signaler un bug : https://github.com/YunoHost-Apps/biboumi_ynh/issues
## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/biboumi_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit.
```
sudo yunohost app install https://github.com/YunoHost-Apps/biboumi_ynh/tree/testing --debug
ou
sudo yunohost app upgrade biboumi -u https://github.com/YunoHost-Apps/biboumi_ynh/tree/testing --debug
```
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps