mirror of
https://github.com/YunoHost-Apps/minchat_ynh.git
synced 2024-09-03 19:36:29 +02:00
75 lines
3.5 KiB
Markdown
75 lines
3.5 KiB
Markdown
<!--
|
||
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.
|
||
-->
|
||
|
||
# Minchat pour YunoHost
|
||
|
||
[](https://dash.yunohost.org/appci/app/minchat)  
|
||
[](https://install-app.yunohost.org/?app=minchat)
|
||
|
||
*[Read this readme in english.](./README.md)*
|
||
|
||
> *Ce package vous permet d'installer Minchat 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
|
||
|
||
Minchat is a free minimalist chat application. It is based on [wojtek77/chat](https://github.com/wojtek77/chat), itself based on [Gabriel Nava's tutorial](http://code.tutsplus.com/tutorials/how-to-create-a-simple-web-based-chat-application--net-5931).
|
||
|
||
### Features
|
||
|
||
- Simple web chat: only requires a browser ; no XMPP application.
|
||
- No need for users to register. Just need the web address. But optional authorisation control.
|
||
- On connection, the page is fed with the messages of the day
|
||
- Args are in the URL as *get* arguments, so that you can share the URL or make it a favorite to avoid filling a form.
|
||
Example : `https://yourdomain.org/minchat/?room=Living&name=John`
|
||
- Optionaly multi room
|
||
|
||
**Version incluse :** 1.0~ynh3
|
||
|
||
|
||
## Captures d'écran
|
||
|
||
|
||
|
||
## Avertissements / informations importantes
|
||
|
||
### Setup
|
||
|
||
The setup is optional. If you leave it as is, there is a single unnamed room, opened to all users. If you want to customize the access control, edit the file `conf/setup.ini` (if missing, copy it from `conf/sample/setup.ini`). The interesting parameter is `auth` that indicates which user is authorized to which room.
|
||
|
||
In this example `auth = John:Game,John:Family,Mary:Game,Tim:Family,admin:*,*:Public,*:`,
|
||
- `John:Game,John:Family` = John can access the Game room, the Family room
|
||
- `Mary:Game` = Mary can access the Game room
|
||
- `Tim:Family` = Tim can access the Family room
|
||
- `admin:*` = admin can access all rooms
|
||
- `*:Public` = everybody can acccess the Public room
|
||
- `*:` = everybody can access the unnamed room
|
||
|
||
### Hints for users
|
||
|
||
- The URLs you send are linked or transformed to images when preceeded by a `!`
|
||
- If multiple rooms are allowed by the administrator in the `setup.ini`, you can have several tabs opened to different rooms in the same browser.
|
||
|
||
|
||
## Documentations et ressources
|
||
|
||
* Site officiel de l'app : <https://github.com/wojtek77/chat>
|
||
* Dépôt de code officiel de l'app : <https://github.com/wojtek77/chat>
|
||
* Documentation YunoHost pour cette app : <https://yunohost.org/app_minchat>
|
||
* Signaler un bug : <https://github.com/YunoHost-Apps/minchat_ynh/issues>
|
||
|
||
## Informations pour les développeurs
|
||
|
||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/minchat_ynh/tree/testing).
|
||
|
||
Pour essayer la branche testing, procédez comme suit.
|
||
|
||
``` bash
|
||
sudo yunohost app install https://github.com/YunoHost-Apps/minchat_ynh/tree/testing --debug
|
||
ou
|
||
sudo yunohost app upgrade minchat -u https://github.com/YunoHost-Apps/minchat_ynh/tree/testing --debug
|
||
```
|
||
|
||
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>
|