diff --git a/README.md b/README.md index 742e71f..6279947 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ Minchat is a free minimalist chat application. It is based on [wojtek77/chat](ht - 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` +Example : `https://__DOMAIN____PATH__/minchat/?room=Living&name=John` - Optionaly multi room **Shipped version:** 1.0~ynh4 diff --git a/README_fr.md b/README_fr.md index d10b337..e579708 100644 --- a/README_fr.md +++ b/README_fr.md @@ -16,16 +16,16 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po ## Vue d’ensemble -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). +Minchat est une application de chat minimaliste. Elle est basé sur [wojtek77/chat](https://github.com/wojtek77/chat), elle-même basé sur [le tutoriel de Gabriel Nava](http://code.tutsplus.com/tutorials/how-to-create- une-simple-application-de-chat-basée sur le Web--net-5931). -### Features +### Caractéristiques -- 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 +- Chat Web simple : nécessite uniquement un navigateur ; pas d'application XMPP. +- Pas besoin de s'inscrire pour les utilisateurs. J'ai juste besoin de l'adresse Web. Mais contrôle d'autorisation facultatif. +- À la connexion, la page est alimentée avec les messages du jour +- Les arguments sont dans l'URL en tant qu'arguments *get*, afin que vous puissiez partager l'URL ou en faire un favori pour éviter de remplir un formulaire. +Exemple : `https://__DOMAIN____PATH__/minchat/?room=Living&name=John` +- En option multi-pièces **Version incluse :** 1.0~ynh4 diff --git a/doc/ADMIN.md b/doc/ADMIN.md index f8ba288..42c5af2 100644 --- a/doc/ADMIN.md +++ b/doc/ADMIN.md @@ -1,6 +1,6 @@ ### 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. +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 `__INSTALL_DIR__/conf/setup.ini` (if missing, copy it from `__INSTALL_DIR__/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,*:`: diff --git a/doc/ADMIN_fr.md b/doc/ADMIN_fr.md new file mode 100644 index 0000000..c6d9af9 --- /dev/null +++ b/doc/ADMIN_fr.md @@ -0,0 +1,17 @@ +### Installation + +La configuration est facultative. Si vous la laissez tel quel, il reste une seule salle sans nom, ouverte à tous les utilisateurs. Si vous souhaitez personnaliser le contrôle d'accès, éditez le fichier `__INSTALL_DIR__/conf/setup.ini` (s'il est manquant, copiez-le depuis `__INSTALL_DIR__/conf/sample/setup.ini`). Le paramètre intéressant est `auth` qui indique quel utilisateur est autorisé à accéder à quelle salle. + +Dans cet exemple `auth = John:Game,John:Family,Mary:Game,Tim:Family,admin:*,*:Public,*:` : + +- `John:Game,John:Family` = John peut accéder à la salle de jeux, à la salle familiale +- `Mary:Game` = Mary peut accéder à la salle de jeux +- `Tim:Family` = Tim peut accéder à la salle familiale +- `admin:*` = l'administrateur peut accéder à toutes les salles +- `*:Public` = tout le monde peut accéder à la salle publique +- `*:` = tout le monde peut accéder à la salle sans nom + +### Conseils pour les utilisateurs + +- Les URL que vous envoyez sont liées ou transformées en images lorsqu'elles sont précédées d'un `!` +- Si plusieurs salles sont autorisées par l'administrateur dans le fichier `setup.ini`, vous pouvez avoir plusieurs onglets ouverts sur différentes salles dans le même navigateur. \ No newline at end of file diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index 2804c90..e9e8ab8 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -6,5 +6,5 @@ Minchat is a free minimalist chat application. It is based on [wojtek77/chat](ht - 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` +Example : `https://__DOMAIN____PATH__/minchat/?room=Living&name=John` - Optionaly multi room \ No newline at end of file diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md new file mode 100644 index 0000000..5cd4dbe --- /dev/null +++ b/doc/DESCRIPTION_fr.md @@ -0,0 +1,10 @@ +Minchat est une application de chat minimaliste. Elle est basé sur [wojtek77/chat](https://github.com/wojtek77/chat), elle-même basé sur [le tutoriel de Gabriel Nava](http://code.tutsplus.com/tutorials/how-to-create- une-simple-application-de-chat-basée sur le Web--net-5931). + +### Caractéristiques + +- Chat Web simple : nécessite uniquement un navigateur ; pas d'application XMPP. +- Pas besoin de s'inscrire pour les utilisateurs. J'ai juste besoin de l'adresse Web. Mais contrôle d'autorisation facultatif. +- À la connexion, la page est alimentée avec les messages du jour +- Les arguments sont dans l'URL en tant qu'arguments *get*, afin que vous puissiez partager l'URL ou en faire un favori pour éviter de remplir un formulaire. +Exemple : `https://__DOMAIN____PATH__/minchat/?room=Living&name=John` +- En option multi-pièces \ No newline at end of file