mirror of
https://github.com/YunoHost/doc.git
synced 2024-09-03 20:06:26 +02:00
Merge pull request #2109 from pp-r/init.-of-missing-docs-up-to-the-letter-D
Init. of missing docs up to the letter d
This commit is contained in:
Éric Gaspar
GitHub
commit
0966ca566c
6 changed files with 373 additions and 0 deletions
23
pages/04.applications/10.docs/dispatch/app_dispatch.fr.md
Normal file
23
pages/04.applications/10.docs/dispatch/app_dispatch.fr.md
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
title: Dispatch
|
||||
template: docs
|
||||
taxonomy:
|
||||
category: docs, apps
|
||||
routes:
|
||||
default: '/app_dispatch'
|
||||
---
|
||||
|
||||
[](https://install-app.yunohost.org/?app=dispatch) [](https://dash.yunohost.org/appci/app/dispatch)
|
||||
|
||||
### Index
|
||||
|
||||
- [Liens utiles](#liens-utiles)
|
||||
|
||||
*Dispatch* est un client graphique IRC basé sur une application web.
|
||||
|
||||
## Liens utiles
|
||||
|
||||
+ Site web : [github.com/khlieng/dispatch](https://github.com/khlieng/dispatch)
|
||||
+ Démonstration : [Démo](https://dispatch.khlieng.com/)
|
||||
+ Dépôt logiciel de l'application : [github.com - YunoHost-Apps/dispatch](https://github.com/YunoHost-Apps/dispatch_ynh)
|
||||
+ Remonter un bug ou une amélioration en créant un ticket (issue) : [github.com - YunoHost-Apps/dispatch/issues](https://github.com/YunoHost-Apps/dispatch_ynh/issues)
|
||||
23
pages/04.applications/10.docs/dispatch/app_dispatch.md
Normal file
23
pages/04.applications/10.docs/dispatch/app_dispatch.md
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
title: Dispatch
|
||||
template: docs
|
||||
taxonomy:
|
||||
category: docs, apps
|
||||
routes:
|
||||
default: '/app_dispatch'
|
||||
---
|
||||
|
||||
[](https://install-app.yunohost.org/?app=dispatch) [](https://dash.yunohost.org/appci/app/dispatch)
|
||||
|
||||
### Index
|
||||
|
||||
- [Useful links](#useful-links)
|
||||
|
||||
*Dispatch* is a web-based IRC graphical client.
|
||||
|
||||
## Useful links
|
||||
|
||||
+ Website: [github.com/khlieng/dispatch](https://github.com/khlieng/dispatch)
|
||||
+ Demonstration: [Demo](https://dispatch.khlieng.com/)
|
||||
+ Application software repository: [github.com - YunoHost-Apps/dispatch](https://github.com/YunoHost-Apps/dispatch_ynh)
|
||||
+ Fix a bug or an improvement by creating a ticket (issue): [github.com - YunoHost-Apps/dispatch/issues](https://github.com/YunoHost-Apps/dispatch_ynh/issues)
|
||||
129
pages/04.applications/10.docs/domoticz/app_domoticz.fr.md
Normal file
129
pages/04.applications/10.docs/domoticz/app_domoticz.fr.md
Normal file
|
|
@ -0,0 +1,129 @@
|
|||
---
|
||||
title: Domoticz
|
||||
template: docs
|
||||
taxonomy:
|
||||
category: docs, apps
|
||||
routes:
|
||||
default: '/app_domoticz'
|
||||
---
|
||||
|
||||
[](https://install-app.yunohost.org/?app=domoticz) [](https://dash.yunohost.org/appci/app/domoticz)
|
||||
|
||||
### Index
|
||||
|
||||
- [Liens utiles](#liens-utiles)
|
||||
|
||||
*Domoticz* est un système domotique open source très léger qui vous permet de surveiller et de configurer divers appareils.
|
||||
|
||||
### Avertissements/informations importantes
|
||||
|
||||
Domoticz est un système de domotique permettant de controler différents objets et de recevoir des données de divers senseurs Il peut par exemple être utilisé avec :
|
||||
|
||||
des interrupteurs
|
||||
des senseurs de portes
|
||||
des sonnettes d'entrées
|
||||
des systèmes de sécurité
|
||||
des stations météo pour les UV, la pluie, le vent...
|
||||
des sondes de températures
|
||||
des sondes d'impulsions
|
||||
des voltmètres et bien d'autres
|
||||
|
||||
Version incluse : Toujours la dernière version stable. La dernière version compilée est récupérée dans ce répertoire lors de l'installation. Une fois installée, les mises à jour de l'application sont gérées depuis les menus de l'application elle même. Le script de mise à jour YunoHost mettra uniquement à jour de nouvelles version du package.
|
||||
|
||||
Le broker MQTT Mosquitto est intégré au package et nécessite un sous-domaine ou un domaine distinct. Il est optionnel et si vous indiquez lors de l'installation le même domaine que le domaine principal, il ne sera pas installé.
|
||||
|
||||
### Configuration
|
||||
|
||||
#### Broker MQTT Mosquitto
|
||||
|
||||
À l'installation, un broker MQTT, Mosquitto, est installé en même temps que Domoticz. La version installée est celle du dépot officiel du projet, et non des dépots Debian. Ce broker nécessite un domaine ou un sous-domaine particulier pour fonctionner (ex : mqtt.your.domain.tld). Il est nécessaire de créer ce domaine auparavant.
|
||||
|
||||
##### Ajout dans Domoticz
|
||||
|
||||
Pour pouvoir l'utiliser, vous devez paramétrer la communication avec entre Domoticz et le broker en suivant la documentation de Domoticz dans la partie Add hardware "MQTT Client Gateway". Les utilisateurs et mot de passe du broker sont automatiquement générés lors de l'installation. Vous pouvez les récupérer avec
|
||||
```
|
||||
sudo yunohost app setting domoticz mqtt_user
|
||||
sudo yunohost app setting domoticz mqtt_pwd
|
||||
```
|
||||
|
||||
##### Publier/souscrire
|
||||
|
||||
Par défaut, Mosquitto va écouter sur deux ports :
|
||||
|
||||
Le 1883 sur localhost en protocole MQTT
|
||||
Le 8883 en protocole WebSocket. NGINX redirige le port 443 externe vers ce port en interne. Pour publier/souscrire sur un topic depuis l'exterieur, vous devez donc utiliser un programme supportant le protocole WebSocket (ex : la bibliothèque Python paho-mqtt).
|
||||
|
||||
##### Mosquitto_pub et mosquitto_sub
|
||||
|
||||
Ces deux programmes ne supportent pas le protocole WebSocket mais uniquement le MQTT : le paramétrage de base ne vous autorise donc pas à les utiliser pour communiquer depuis un client externe. Si vous les utilisez directement depuis votre serveur, ce genre de syntaxe devrait marcher :
|
||||
|
||||
`mosquitto_pub -u *user* -P *password* -h mqtt.your.domain.tld -p 1883 -t 'domoticz/in' -m '{ "idx" : 1, "nvalue" : 0, "svalue" : "25.0" }'`
|
||||
|
||||
De la même manière :
|
||||
|
||||
`mosquitto_sub -u *user* -P *password* -h mqtt.your.domain.tld -p 1883 -t 'domoticz/out'`
|
||||
|
||||
Si vous souhaitez ouvrir le protocole MQTT depuis l'extérieur afin de pouvoir les utiliser depuis un autre serveur, il vous faudra :
|
||||
|
||||
ouvrir le port 1883 sur le firewall YunoHost (attention, risque de sécurité)
|
||||
autoriser les adresses IP souhaitées dans la configuration de Mosquitto
|
||||
paramétrer le TLS dans la configuration de Mosquitto en donnant accès au crt.pem et key.pem de votre domaine MQTT en les paramétrant respectivement avec les variables certfile et keyfile. Ceci est obligatoire pour sécuriser la connexion.
|
||||
|
||||
##### Mise à jour depuis les versions n'ayant pas Mosquitto
|
||||
|
||||
Si vous êtes sur le package ynh3 ou inférieur, Mosquitto n'est pas installé par défaut. De même si vous avez choisi de ne pas indiquer de domaine pour Mosquitto lors de l'installation initiale. Pour pouvoir l'installer après coup, effectuez les actions suivantes :
|
||||
|
||||
créez un domaine ou sous-domaine pour recevoir les informations (par exemple : 'mqtt.your.domain.tld')
|
||||
connecter vous en ligne de commande à votre serveur
|
||||
tapez la commande suivante : `yunohost app setting domoticz mqtt_domain -v mqtt.your.domain.tld`
|
||||
Procédez à la mise à jour. Si vous êtes déjà sur la dernière version, utiliser la commmande suivante : `yunohost app upgrade domoticz --force`
|
||||
|
||||
### Configuration
|
||||
|
||||
#### Capteurs, langue...
|
||||
|
||||
Toute la configuration de l'application a lieu dans l'application elle-même.
|
||||
|
||||
#### Access et API
|
||||
|
||||
Par défaut, l'accès aux API JSON est autorisé sur cette URL `/votredomaine.tld/api_/chemindedomoticz`. Donc, si vous accédez à domoticz par `https://votredomaine.tld/domoticz`, utilisez le chemin suivant pour l'api : `/votredomaine.tld/api_/domoticz/json.htm?votrecommandeapi`
|
||||
|
||||
Par défaut, seuls la mise à jour de capteur et les interrupteurs sont autorisés. Pour autoriser une nouvelle commande, vous devez (pour l'instant) manuellement éditer le fichier de configuration NGINX :
|
||||
|
||||
`sudo nano /etc/nginx/conf.d/yourdomain.tld.d/domoticz.conf`
|
||||
|
||||
Puis éditer le bloc suivant en y ajoutant le regex de la commmande à autoriser :
|
||||
```
|
||||
#set the list of authorized json command here in regex format
|
||||
#you may retrieve the command from https://www.domoticz.com/wiki/Domoticz_API/JSON_URL's
|
||||
#By default, sensors updates and toggle switch are authorized
|
||||
if ( $args ~* type=command¶m=udevice&idx=[0-9]*&nvalue=[0-9]*&svalue=.*$|type=command¶m=switchlight&idx=[0-9]*&switchcmd=Toggle$) {
|
||||
set $api "1";
|
||||
}
|
||||
```
|
||||
|
||||
Par exemple, pour ajouter la commmande json pour retrouver le statut d'un équipement (`/json.htm?type=devices&rid=IDX`),il faut modifier la ligne comme ceci :
|
||||
```
|
||||
#set the list of authorized json command here in regex format
|
||||
#you may retrieve the command from https://www.domoticz.com/wiki/Domoticz_API/JSON_URL's
|
||||
#By default, sensors updates and toggle switch are authorized
|
||||
if ( $args ~* type=command¶m=udevice&idx=[0-9]*&nvalue=[0-9]*&svalue=.*$|type=command¶m=switchlight&idx=[0-9]*&switchcmd=Toggle$|type=devices&rid=[0-9]* ) {
|
||||
set $api "1";
|
||||
}
|
||||
```
|
||||
Toutes les adresses IPv4 du réseau local (192.168.0.0/24) et toutes les adresses IPv6 sont autorisées pour l'API. À ma connaissance, il n'y a pas moyen d'effectuer un filtre pour les adresses IPv6 sur le réseau local, vous pouvez donc retirer leur autorisation en enlevant ou en commentant la ligne suivante dans `/etc/nginx/conf.d/yourdomain.tld.d/domoticz.conf` :
|
||||
|
||||
`allow ::/1;`
|
||||
|
||||
Ceci autorisera seulement les adresses IPv4 local a accéder aux API de Domoticz. Vous pouvez ajouter des adresses IPv6 de la même façon.
|
||||
|
||||
### Limitations
|
||||
|
||||
Pas de gestion d'utilisateurs ni d'intégration LDAP. L'application ne prévoit pas de gérer les utilisateurs par LDAP, donc le package non plus.
|
||||
Un backup ne peut pas être restauré sur un type de machine différente de celle d'origine (x86, arm...) car les sources compilées doivent être différentes
|
||||
|
||||
## Liens utiles
|
||||
|
||||
+ Site web : [domoticz.com](https://domoticz.com/)
|
||||
+ Dépôt logiciel de l'application : [github.com - YunoHost-Apps/domoticz](https://github.com/YunoHost-Apps/domoticz_ynh)
|
||||
+ Remonter un bug ou une amélioration en créant un ticket (issue) : [github.com - YunoHost-Apps/domoticz/issues](https://github.com/YunoHost-Apps/domoticz_ynh/issues)
|
||||
136
pages/04.applications/10.docs/domoticz/app_domoticz.md
Normal file
136
pages/04.applications/10.docs/domoticz/app_domoticz.md
Normal file
|
|
@ -0,0 +1,136 @@
|
|||
---
|
||||
title: Domoticz
|
||||
template: docs
|
||||
taxonomy:
|
||||
category: docs, apps
|
||||
routes:
|
||||
default: '/app_domoticz'
|
||||
---
|
||||
|
||||
[](https://install-app.yunohost.org/?app=domoticz) [](https://dash.yunohost.org/appci/app/domoticz)
|
||||
|
||||
### Index
|
||||
|
||||
- [Useful links](#useful-links)
|
||||
|
||||
*Domoticz* is a very light weight open sources home automation system that lets you monitor and configure miscellaneous devices.
|
||||
|
||||
### Disclaimers/important information
|
||||
|
||||
Domoticz is a Home Automation system design to control various devices and receive input from various sensors. For example this system can be used with:
|
||||
|
||||
Light switches
|
||||
Door sensors
|
||||
Doorbells
|
||||
Security devices
|
||||
Weather sensors like: UV/Rain/Wind Meters
|
||||
Temperature Sensors
|
||||
Pulse Meters
|
||||
Voltage/AD Meters and more
|
||||
|
||||
Shipped version: Always the last stable one. The last compiled version is retrieved from this directory during install. Once installed, updates from the uptream app are managed from within the app. YunoHost upgrade script will only upgrade the YunoHost package.
|
||||
|
||||
The MQTT broker Mosquitto is integrated into the package. It requires its own domain or subdomain. It's an optional setting: during install if you set the same domaine as your main app domain, it won't be installed.
|
||||
|
||||
### Configuration
|
||||
|
||||
#### Broker Mosquitto
|
||||
|
||||
During installation, a MQTT broker, Mosquitto, is installed at the same time as Domoticz. The installed version is the one from the official project repo and not from Debian ones. This broker requires a dedicated domain or subdomain to work (ex : mqtt.your.domain.tld): creating this domain prior installation is a prerequisite.
|
||||
|
||||
##### Adding in Domoticz
|
||||
|
||||
To use Mosquitto, you need to customize the communication between Domoticz and the broker by following the Domoticz documentation, part Add hardware "MQTT Client Gateway". User and password are automatically generated during installation, you may retrieve them with
|
||||
```
|
||||
sudo yunohost app setting domoticz mqtt_user
|
||||
sudo yunohost app setting domoticz mqtt_pwd
|
||||
```
|
||||
|
||||
##### Publish/Subscribe
|
||||
|
||||
By default, Mosquitto will listen on two ports:
|
||||
|
||||
1883 on localhost using mqtt protocol
|
||||
8883 using websocket protocol. NGINX redirect external port 443 to this internal port.
|
||||
|
||||
Hence, To publish/subscribe on a topic from the outside, you have to use a software supporting WebSocket protocol (ex: paho-mqtt Python library).
|
||||
|
||||
##### Mosquitto_pub et mosquitto_sub
|
||||
|
||||
These two tools do not support WebSocket protocol, only direct MQTT: base settings will not allow communication from an outside device. If you're using them directly from your server, this kind of syntax should work:
|
||||
```
|
||||
mosquitto_pub -u *user* -P *password* -h mqtt.your.domain.tld -p 1883 -t 'domoticz/in' -m '{ "idx" : 1, "nvalue" : 0, "svalue" : "25.0" }'
|
||||
```
|
||||
In the same way:
|
||||
|
||||
```
|
||||
mosquitto_sub -u *user* -P *password* -h mqtt.your.domain.tld -p 1883 -t 'domoticz/out'
|
||||
```
|
||||
|
||||
If you wish to open direct MQTT protocol from an outside device, you'll need to:
|
||||
|
||||
open port 1883 on Yunohost firewall (Attention, security risk)
|
||||
Allows IP addresses in mosquitto configuration for this listener
|
||||
Set the TLS setting in mosquitto configuration by giving access to crt.pem and key.pem from your MQTT domain by setting respective certfile et keyfile variables. This is mandatory to ensure a secure connection.
|
||||
|
||||
##### Upgrade from version without Mosquitto
|
||||
|
||||
If you have package ynh3 or below, Mosquitto is not installed by default. If you have chosen to not set a domain during initial installation also. So, if you need to activate mosquitto in retrospect, do following actions:
|
||||
|
||||
Create a domain or a subdomain (for example : 'mqtt.your.domain.tld')
|
||||
Connect to your server in command line
|
||||
Type following command: `yunohost app setting domoticz mqtt_domain -v mqtt.your.domain.tld`
|
||||
Upgrade domoticz to last package. If you're already on the last package version, use the following command: `yunohost app upgrade domoticz --force`
|
||||
|
||||
### Configuration
|
||||
|
||||
Sensors, language...
|
||||
|
||||
Main configuration of the app take place inside the app itself.
|
||||
|
||||
#### Access and API
|
||||
|
||||
By default, access for the JSON API is allowed on following path `/yourdomain.tld/api_/domoticzpath`. So if you access domoticz via `https://mydomainname.tld/domoticz`, use the following webpath for the api: `/mydomainname.tld/api_/domoticz/json.htm?yourapicommand`
|
||||
|
||||
By default, only sensor updates and switch toogle are authorized. To authorized a new command, you have (for now) to manually update the NGINX config file:
|
||||
|
||||
sudo nano `/etc/nginx/conf.d/yourdomain.tld.d/domoticz.conf`
|
||||
|
||||
Then edit the following block by adding the regex of the command you want to allow:
|
||||
|
||||
#set the list of authorized json command here in regex format
|
||||
#you may retrieve the command from https://www.domoticz.com/wiki/Domoticz_API/JSON_URL's
|
||||
#By default, sensors updates and toggle switch are authorized
|
||||
```
|
||||
if ( $args ~* type=command¶m=udevice&idx=[0-9]*&nvalue=[0-9]*&svalue=.*$|type=command¶m=switchlight&idx=[0-9]*&switchcmd=Toggle$) {
|
||||
set $api "1";
|
||||
}
|
||||
```
|
||||
For example, to add the JSON command to retrieve the status of a device (`/json.htm?type=devices&rid=IDX`),modify the line as this:
|
||||
|
||||
#set the list of authorized json command here in regex format
|
||||
#you may retrieve the command from https://www.domoticz.com/wiki/Domoticz_API/JSON_URL's
|
||||
#By default, sensors updates and toggle switch are authorized
|
||||
```
|
||||
if ( $args ~* type=command¶m=udevice&idx=[0-9]*&nvalue=[0-9]*&svalue=.*$|type=command¶m=switchlight&idx=[0-9]*&switchcmd=Toggle$|type=devices&rid=[0-9]* ) {
|
||||
set $api "1";
|
||||
}
|
||||
```
|
||||
|
||||
All IPv4 addresses within the local network (192.168.0.0/24) and all IPv6 addresses are authorized as API. As far as I know, there is no way to filter for IPv6 address on local network: You may remove the authorization by removing or commenting this line in `/etc/nginx/conf.d/yourdomain.tld.d/domoticz.conf`:
|
||||
|
||||
`allow ::/1;`
|
||||
|
||||
This will authorized only IPv4 within local network to access your Domoticz API. You may add individual IPv6 address in the same way.
|
||||
|
||||
### Limitations
|
||||
|
||||
No user management nor LDAP integration This function is not planned to be implemented into the app, hence it's not planned into the package neither.
|
||||
Backup cannot be restored on a different machine type (arm, x86...) as compiled sources are different
|
||||
|
||||
|
||||
## Useful links
|
||||
|
||||
+ Website: [domoticz.eu (en)](https://domoticz.eu/site/)
|
||||
+ Application software repository: [github.com - YunoHost-Apps/domoticz](https://github.com/YunoHost-Apps/domoticz_ynh)
|
||||
+ Fix a bug or an improvement by creating a ticket (issue): [github.com - YunoHost-Apps/domoticz/issues](https://github.com/YunoHost-Apps/domoticz_ynh/issues)
|
||||
31
pages/04.applications/10.docs/droppy/app_droppy.fr.md
Normal file
31
pages/04.applications/10.docs/droppy/app_droppy.fr.md
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
title: Droppy
|
||||
template: docs
|
||||
taxonomy:
|
||||
category: docs, apps
|
||||
routes:
|
||||
default: '/app_droppy'
|
||||
---
|
||||
|
||||
[](https://install-app.yunohost.org/?app=droppy) [](https://dash.yunohost.org/appci/app/droppy)
|
||||
|
||||
### Index
|
||||
|
||||
- [Liens utiles](#liens-utiles)
|
||||
|
||||
*Droppy* est un serveur de stockage de fichiers auto-hébergé avec une interface web et des capacités pour éditer des fichiers et visualiser des médias directement dans le navigateur.
|
||||
|
||||
### Avertissements / informations importantes
|
||||
|
||||
Le développement de Droppy a été abandonné par son auteur, et son dépôt de code a été archivé. N'attendez pas de future mise à jour, ni correctifs de sécurité.
|
||||
|
||||
### Configuration
|
||||
|
||||
Comment configurer cette application : un fichier de configuration /var/www/droppy/config/config.json en SSH.
|
||||
Les fichiers partagés sont stockés dans le répertoire suivant : /home/yunohost.app/droppy/files/
|
||||
|
||||
## Liens utiles
|
||||
|
||||
+ Site web : [github.com/silverwind/droppy](https://github.com/silverwind/droppy)
|
||||
+ Dépôt logiciel de l'application : [github.com - YunoHost-Apps/droppy](https://github.com/YunoHost-Apps/droppy_ynh)
|
||||
+ Remonter un bug ou une amélioration en créant un ticket (issue) : [github.com - YunoHost-Apps/droppy/issues](https://github.com/YunoHost-Apps/droppy_ynh/issues)
|
||||
31
pages/04.applications/10.docs/droppy/app_droppy.md
Normal file
31
pages/04.applications/10.docs/droppy/app_droppy.md
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
title: Droppy
|
||||
template: docs
|
||||
taxonomy:
|
||||
category: docs, apps
|
||||
routes:
|
||||
default: '/app_droppy'
|
||||
---
|
||||
|
||||
[](https://install-app.yunohost.org/?app=droppy) [](https://dash.yunohost.org/appci/app/droppy)
|
||||
|
||||
### Index
|
||||
|
||||
- [Useful links](#useful-links)
|
||||
|
||||
*Droppy* is a self-hosted file storage server with a web interface and capabilities to edit files and view media directly in the browser.
|
||||
|
||||
### Disclaimers / important information
|
||||
|
||||
Development of Droppy has been abandoned by its author, and its repository has been archived. Expect no future updates nor security fixes.
|
||||
|
||||
### Configuration
|
||||
|
||||
How to configure this app: a JSON configuration file with SSH. `/var/www/droppy/config/config.json.`
|
||||
Shared files are stored in the following directory: `/home/yunohost.app/droppy/files`
|
||||
|
||||
## Useful links
|
||||
|
||||
+ Website: [github.com/silverwind/droppy](https://github.com/silverwind/droppy)
|
||||
+ Application software repository: [github.com - YunoHost-Apps/droppy](https://github.com/YunoHost-Apps/droppy_ynh)
|
||||
+ Fix a bug or an improvement by creating a ticket (issue): [github.com - YunoHost-Apps/droppy/issues](https://github.com/YunoHost-Apps/droppy_ynh/issues)
|
||||
Loading…
Reference in a new issue