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

Small fixes

Browse source
This commit is contained in:
ericgaspar 2020-09-25 17:19:02 +02:00
parent 4a0a6bb83e
commit e307c8bbc7
No known key found for this signature in database
GPG key ID: 574F281483054D44
7 changed files with 26 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
README.md
View file

@ -1,17 +1,16 @@
# Minchat for YunoHost
[![Integration level](https://dash.yunohost.org/integration/minchat.svg)](https://dash.yunohost.org/appci/app/minchat) ![](https://ci-apps.yunohost.org/ci/badges/minchat.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/minchat.maintain.svg)
[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP)
[![Install Minchat with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=minchat)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server.
> *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_ynh is a free minimalist chat application packaged for [Yunohost](https://yunohost.org).
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).
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).
**Shipped version:** 1.0
@ -20,23 +19,15 @@ It is based on [wojtek77/chat](https://github.com/wojtek77/chat), itself based o
## Features
- Simple web chat: only requires a browser ; no XMPP application
- 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
## Installation
#### On Yunohost
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`
Upgrade: `sudo yunohost app upgrade minchat -u https://github.com/chtixof/minchat_ynh`
#### Otherwise
Download, unzip and just copy the content of the `sources` folder to any folder of your web site.
## 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,*:`,
@ -49,7 +40,7 @@ In this example `auth = John:Game,John:Family,Mary:Game,Tim:Family,admin:*,*:Pub
## 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
- 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
@ -60,13 +51,13 @@ In this example `auth = John:Game,John:Family,Mary:Game,Tim:Family,admin:*,*:Pub
#### Multi-user support
Are LDAP and HTTP auth supported?
Can the app be used by multiple users?
* Are LDAP and HTTP auth supported? **No**
* Can the app be used by multiple users? **Yes**
#### Supported architectures
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/minchat%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/minchat/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/minchat%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/minchat/)
## Limitations
@ -76,26 +67,21 @@ Can the app be used by multiple users?
* Other info you would like to add about this app.
**More info on the documentation page:**
https://yunohost.org/packaging_apps
## Links
* Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
* App website: Link to the official website of this app.
* Upstream app repository: Link to the official repository of the upstream app.
* Report a bug: https://github.com/YunoHost-Apps/minchat_ynh/issues
* Upstream app repository: https://github.com/wojtek77/chat
* YunoHost website: https://yunohost.org/
---
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing).
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.
```
sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
sudo yunohost app install https://github.com/YunoHost-Apps/minchat_ynh/tree/testing --debug
or
sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
sudo yunohost app upgrade minchat -u https://github.com/YunoHost-Apps/minchat_ynh/tree/testing --debug
```

2
scripts/backup
View file

@ -55,4 +55,4 @@ ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
# END OF SCRIPT
#=================================================
ynh_print_info --message="Backup script completed for MinChat. (YunoHost will then actually copy those files to the archive)."
ynh_print_info --message="Backup script completed for Minchat. (YunoHost will then actually copy those files to the archive)."

8
scripts/change_url
View file

@ -24,7 +24,7 @@ app=$YNH_APP_INSTANCE_NAME
#=================================================
# LOAD SETTINGS
#=================================================
ynh_script_progression --message="Loading installation settings..." --time --weight=1
ynh_script_progression --message="Loading installation settings..." --weight=1
# Needed for helper "ynh_add_nginx_config"
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
@ -32,7 +32,7 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
#=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#=================================================
ynh_script_progression --message="Backing up the app before changing its url (may take a while)..." --time --weight=1
ynh_script_progression --message="Backing up Minchat before changing its URL..." --weight=1
# Backup the current version of the app
ynh_backup_before_upgrade
@ -98,7 +98,7 @@ fi
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --time --weight=1
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
@ -106,4 +106,4 @@ ynh_systemd_action --service_name=nginx --action=reload
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Change of URL completed for $app" --last
ynh_script_progression --message="Change of URL completed for Minchat" --last

2
scripts/install
View file

@ -113,4 +113,4 @@ ynh_systemd_action --service_name=nginx --action=reload
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Installation of MinChat completed" --last
ynh_script_progression --message="Installation of Minchat completed" --last

2
scripts/remove
View file

@ -57,4 +57,4 @@ ynh_system_user_delete --username=$app
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Removal of MinChat completed" --last
ynh_script_progression --message="Removal of Minchat completed" --last

4
scripts/restore
View file

@ -49,7 +49,7 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
#=================================================
# RESTORE THE APP MAIN DIR
#=================================================
ynh_script_progression --message="Restoring MinChat main directory..." --weight=2
ynh_script_progression --message="Restoring Minchat main directory..." --weight=2
ynh_restore_file --origin_path="$final_path"
@ -88,4 +88,4 @@ ynh_systemd_action --service_name=nginx --action=reload
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Restoration completed for MinChat" --last
ynh_script_progression --message="Restoration completed for Minchat" --last

4
scripts/upgrade
View file

@ -50,7 +50,7 @@ fi
#=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#=================================================
ynh_script_progression --message="Backing up the app before upgrading..." --weight=5
ynh_script_progression --message="Backing up Minchat before upgrading..." --weight=5
# Backup the current version of the app
ynh_backup_before_upgrade
@ -114,4 +114,4 @@ ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Upgrade of MinChat completed" --last
ynh_script_progression --message="Upgrade of Minchat completed" --last