YunoHost-Apps/minchat_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/minchat_ynh.git synced 2024-09-03 19:36:29 +02:00
Code Issues Activity Actions
Minimalist chat for YunoHost
102 commits 2 branches 0 tags 243 KiB
Shell 100%
Find a file
yunohost-bot 3551292a34 Auto-update README
2023-10-31 14:22:37 +00:00
.github [autopatch] Update issue and PR templates 2021-05-13 17:49:29 +02:00
conf 4.3 2021-11-22 13:10:22 +01:00
doc apply example 2022-10-01 08:52:00 +02:00
scripts apply example 2022-10-01 08:52:00 +02:00
check_process Update check_process 2021-11-22 13:10:45 +01:00
LICENSE [fix] manifest.json & LICENSE file 2017-05-08 17:14:38 +02:00
manifest.json Update manifest.json 2022-10-01 18:09:03 +02:00
README.md Auto-update README 2023-10-31 14:22:37 +00:00
README_fr.md Auto-update README 2023-10-31 14:22:37 +00:00

README.md

Minchat for YunoHost

Integration level Working status Maintenance status

Install Minchat with YunoHost

Lire ce readme en français.

This package allows you to install Minchat quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Minchat is a free minimalist chat application. It is based on wojtek77/chat, itself based on Gabriel Nava's tutorial.

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

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

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

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