# Minchat for YunoHost [![Integration level](https://dash.yunohost.org/integration/minchat.svg)](https://dash.yunohost.org/appci/app/minchat) ![Working status](https://ci-apps.yunohost.org/ci/badges/minchat.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/minchat.maintain.svg) [![Install Minchat with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](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 ## Screenshots ![Screenshot of Minchat](./doc/screenshots/minchat_ynh_screenshot01.gif) ## 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: * Upstream app code repository: * YunoHost documentation for this app: * Report a bug: ## 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:**