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

Readme updated

Browse source
This commit is contained in:
Chtixof 2015-04-12 10:47:53 +02:00
parent 9c5ae60eeb
commit 7ed567ad0a
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -13,10 +13,10 @@ Example : `https://yourdomain.org/minchat/?room=Living&name=John`
- Optionaly multi room - Optionaly multi room
## Installation ## Installation
### On Yunohost #### On Yunohost
Via the admin web console, type in: <https://github.com/chtixof/minchat_ynh> Via the admin web console, type in: <https://github.com/chtixof/minchat_ynh>
Or on ssh : `sudo yunohost app install https://github.com/chtixof/minchat_ynh` Or on ssh : `sudo yunohost app install https://github.com/chtixof/minchat_ynh`
### Otherwise #### Otherwise
Download, unzip and just copy the content of the `sources` folder to any folder of your web site. Download, unzip and just copy the content of the `sources` folder to any folder of your web site.
## Setup ## 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`. The interesting parameter is `auth` that indicates which user is authorized to which room. 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`. The interesting parameter is `auth` that indicates which user is authorized to which room.
@ -29,4 +29,8 @@ In this example `auth = John:Game,Mary:Game,John:Family,Tim:Family,admin:,:Publi
- other users can only acccess the Public room - other users can only acccess the Public room
## Screen shot ## Screen shot
![screenshot](https://raw.githubusercontent.com/chtixof/databank/master/minchat_ynh/minchat_ynh_screenshot01.gif) ![screenshot](https://raw.githubusercontent.com/chtixof/databank/master/minchat_ynh/minchat_ynh_screenshot01.gif)
## Hints for users
- The URLs you send are linked or transformed to images when preceeding 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