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

58 lines
2.4 KiB
Markdown
Raw Normal View History

2021-07-03 16:04:56 +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-01-29 23:34:36 +01:00
# Converse for YunoHost
2022-08-07 21:03:42 +02:00
[![Integration level](https://dash.yunohost.org/integration/converse.svg)](https://dash.yunohost.org/appci/app/converse) ![Working status](https://ci-apps.yunohost.org/ci/badges/converse.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/converse.maintain.svg)
2021-01-29 23:34:36 +01:00
[![Install Converse with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=converse)
*[Lire ce readme en français.](./README_fr.md)*
2021-07-03 16:04:56 +02:00
> *This package allows you to install Converse 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.*
2021-01-29 23:34:36 +01:00
## Overview
2021-09-03 11:53:41 +02:00
Converse is a free and open-source XMPP chat client written in JavaScript which can be tightly integrated into any website.
The benefit of using converse.js as opposed to relying on a SaaS (software-as-a-service) solution, is that your users can have a much more customized, streamlined and integrated webchat experience and that you have control over the data. The latter being a requirement for many sites dealing with sensitive information.
### Features
- File sharing (not working yet)
- End to end message encryption (XEP-0384 OMEMO)
- Open chats via URL
- Notifications
- Multilingual Support
- Moderating chatrooms
- Passwordless login with client certificates
2021-01-29 23:34:36 +01:00
2022-05-05 23:07:25 +02:00
**Shipped version:** 9.1.1~ynh1
2021-01-29 23:58:27 +01:00
2021-07-03 16:04:56 +02:00
**Demo:** https://inverse.chat/
## Documentation and resources
2021-01-29 23:34:36 +01:00
2022-08-07 21:03:42 +02:00
* Official app website: <http://conversejs.org>
* Official admin documentation: <https://conversejs.org/docs/html/index.html>
* Upstream app code repository: <https://github.com/conversejs/converse.js>
* YunoHost documentation for this app: <https://yunohost.org/app_converse>
* Report a bug: <https://github.com/YunoHost-Apps/converse_ynh/issues>
2021-01-29 23:34:36 +01:00
2021-07-03 16:04:56 +02:00
## Developer info
2021-01-29 23:34:36 +01:00
2021-07-03 16:04:56 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/converse_ynh/tree/testing).
2021-01-29 23:34:36 +01:00
To try the testing branch, please proceed like that.
2022-08-07 21:03:42 +02:00
``` bash
2021-01-29 23:34:36 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/converse_ynh/tree/testing --debug
or
sudo yunohost app upgrade converse -u https://github.com/YunoHost-Apps/converse_ynh/tree/testing --debug
```
2021-07-03 16:04:56 +02:00
2022-08-07 21:03:42 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>