mirror of
https://github.com/YunoHost-Apps/minchat_ynh.git
synced 2024-09-03 19:36:29 +02:00
75 lines
3.6 KiB
Markdown
75 lines
3.6 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 for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/minchat)  
|
|
[](https://install-app.yunohost.org/?app=minchat)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install Minchat 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
|
|
|
|
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
|
|
|
|
**Shipped version:** 1.0~ynh4 *(:warning: This is the `testing` branch. The [`master` branch](https://github.com/YunoHost-Apps/minchat_ynh/tree/master) used in the catalog is currently on version 1.0\~ynh3.)*
|
|
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
### 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.
|
|
|
|
|
|
## Documentation and resources
|
|
|
|
* Official app website: <https://github.com/wojtek77/chat>
|
|
* Upstream app code repository: <https://github.com/wojtek77/chat>
|
|
* YunoHost documentation for this app: <https://yunohost.org/app_minchat>
|
|
* Report a bug: <https://github.com/YunoHost-Apps/minchat_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/minchat_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
``` bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/minchat_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade minchat -u https://github.com/YunoHost-Apps/minchat_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|