Objectif

Ce module permet de sauvegarder vos dossiers et vos fichiers. La sauvegarde est lancée toutes les nuits à l'heure que vous souhaitez (Voir plus bas : "Comment paramétrer le fichier evt_xxx.ini ?"). L'arborescence de vos fichiers est conservée. Le module fait un tar puis un gzip pour optimiser la sauvegarde. Ensuite, le fichier final est copié par FTP sur le serveur de votre choix (sur votre espace free.fr si vous le souhaitez).

Version

La dernière release est la version 1.0

Pré-requis

tar.exe et gzip.exe sont deux utilitaires en ligne de commande. Ils sont utilisés par le module pour réduire la taille et le nombre de fichiers à transférer. Ces utilitaires sont livrés avec le module. Ils sont stockés dans le répertoire extensions du module.

Devices et Events utilisés par le module

Le module utilise un device Homeseer par grand thème de sauvegarde. Par exemple, dans le module tel que je vous le propose, vous trouvez ma configuration avec :
- Un virtual device pour la sauvegarde Homeseer,
- Un virtual device pour la sauvegarde de Apache, etc.

Grâce à ce module, vous pouvez suivre dans Homeseer l'état de la sauvegarde car le script change la valeur des devices à chaque étape.

Un seul évènement Homeseer est proposé par défaut. C'est un évènement qui lance la sauvegarde à une heure donnée. Vous pouvez le paramétrer comme vous le souhaitez. Personnellement, je l'utilise journalièrement.

Comment installer le module ?

Pour installer ce module, vous devez suivre les étapes suivantes:
- Arrêtez votre application Homeseer
- Vérifiez que vous avez installez un framework Domotics. Sinon faites le en suivant les instructions ...
- Vérifiez que vous avez un répertoire scripts\modules dans Homeseer. Sinon, créez le.
- Dézippez les fichiers dans le répertoire module. Vous devez avoir une structure C:\Program Files\Homeseer 2\scripts\modules\BACKUP.PC\scripts\*
- Ajoutez la ligne hs.run "modules\BACKUP.PC\scripts\install.vbs" dans votre fichier C:\Program Files\Homeseer 2\scripts\startup.txt.
- Editez les fichiers de propriétés (dev_*.ini et evt_*.ini) pour paramétrer le module en fonction de votre besoin)
- Créez un répertoire C:\BACKUP. Ce répertoire est utilisé pour préparer le backup avant d'uploader les fichiers sur votre serveur FTP. Ce répertoire restera vide, sauf pendant la sauvegarde.
- Redémarrez Homeseer
- Vérifiez que vos devices et votre évènement Homeseer ont été créés

Comment paramétrer le fichier Properties.ini ?

Le paramètre MODE=DATABASE permet de sauver les changements de status en base de données MYSQL (si votre framework est paramétré pour pointer sur une base de données). Si vous ne voulez pas utiliser de base de données, utilisez le paramètre MODE=ALONE .

Pour changer la verbosité des logs, il ya le paramètre suivant LEVEL=CRITICAL. Il peut prendre les valeurs INFORMATION, WARNING, CRITICAL ou SEVERE. En mode de production, je vous conseille de mettre la valeur CRITICAL. En mode de débuggage, vous pouvez mettre LEVEL=INFORMATION.

Le paramètre CONFIG=..\scripts\modules\BACKUP.PC\config\ ne doit pas changer, sauf si vous déplacer le module.

Le paramètre DEVICES=dev_z10.ini|dev_z11.ini|dev_z12.ini|dev_z13.ini|dev_z14.ini contient le nombre de logiciels que vous sauvegardez. Personnellement, dans ma configuration, Z10 concerne la sauvegarde Homeseer, Z11 => Apache, Z12 => MySQL, Z13 => Hamster, Z14 => Look n Stop.

Le paramètre EVENTS=evt_every_night.ini contient juste l'évènement qui va lancer la sauvegarde.

Le paramètre BACKUP_FOLDER=C:\Backup\ est le répertoire de travail pour générer le backup. Si vous décidez d'utiliser un autre répertoire, il faut changer ce paramètre.

Les paramètres (XCOPY_BIN, COPY_BIN, DISK, TMP_FOLDER, TAR_BIN et GZ_BIN) n'ont pas besoin d'être changé. Il vous faut juste vérifier que ROOT_FOLDER=\Progra~1\HomeSe~1\scripts\modules\BACKUP.PC\ existe bien dans votre cas.

Enfin, si vous souhaitez que votre fichier de backup soit copié sur un serveur FTP, il vous faut changer les paramètres suivants : HOST_TO=nom.de.votre.server, USERNAME=votre.compte.ftp, PASSWORD=votre.password.ftp, REMOTE_FOLDER=le.répertoire.de.destination

Le paramètre WAKEUP=FALSE n'est pas encore utilisé dans la cadre de cette version.

Comment paramétrer le fichier dev_xxx.ini ?

Vous avez besoin d'un fichier dev_xxx.ini par logiciel sauvegardé. Chaque dev_xxx.ini représente un virtual device Homeseer. Il contiendra le status de sauvegarde de votre logiciel. Notamment la date de dernière sauvegarde.

CAN_DIM=false permet de créer un device DIMable. Dans notre cas, le device donne juste un status de sauvegarde. Donc on laisse la valeur false.

HC=Z, DC=10, LOCATION=Sauvegarde, DEV_TYPE_STRING=Virtual, NAME=Homeseer, REF=26010 sont les paramètres généraux de votre device. Vous pouvez changer les valeurs que vous voulez.

MISC permet de préciser votre device (Voir l'aide de Homeseer). Si vous utilisez MISC=&H8, le device ne sera plus loggué dans Homeseer. De nombreuses autres options existent dans l'aide de Homeseer.

STATUS_SUPPORT, VALUES, BUTTONS, GRAPHICS, PARAM4 à PARAM10 ne sont pas utilisés dans cette version.

La Valeur par défaut de votre device est donné par DEFAULT_STATUS= , DEFAULT_STRING=No Backup, DEFAULT_VALUE=. Cette valeur est juste utilisée lors de la création du device.

PARAM2 donne le nom du sous répertoire de sauvegarde. C'est en fait le nom de votre logiciel. Exemple PARAM2=Homeseer2.backup.

PARAM1 contient la série de fichiers et de répertoires que vous voulez sauvegarder. Exemple PARAM1=scripts,C:\Progra~1\Homese~1\scripts\* permet de sauver tous les fichiers de C:\Progra~1\Homese~1\scripts\ dans un sous répertoire \Homeseer2.backup\scripts. Si vous voulez sauver plusieurs sous répertoires, vous pouvez enchainer vos souhaits dans PARAM1 en les séparant pas un |.

Enfin, le PARAM3 permet de lancer un pré-traitement avant de sauvegarder les fichiers. Par exemple, si vous utilisez une base de données, vous pouvez lancer un pré-traitement qui sauve vos bases dans un fichier dump. Puis la sauvegarde prend le dump et le compresse. C'est ce que je fais avec mon device dev_z12.ini (PARAM3=C:\Progra~1\Homese~1\scripts\modules\BACKUP.PC\scripts\export-dbs.bat).

Comment paramétrer le fichier evt_xxx.ini ?

Les propriétés NAME et GROUP sont modifiables pour que vous renommiez l'évènement à votre guise.

MISC permet de préciser votre évènement (Voir l'aide de Homeseer pour trouver les valeurs applicables). Si vous utilisez MISC=&H4000, l'évènement ne sera plus loggué dans Homeseer. De nombreuses autres options existent dans l'aide de Homeseer.

EVT_TIME=02:30 est mon heure de sauvegarde. Vous pouvez utiliser l'heure qui convient le mieux.

Problèmes connus ou Astuces

J'utilise ce module depuis des mois sans aucun soucis. J'ai par contre trouvé une ou deux fois que le répertoire c:\backup n'était pas vide. Dans ce cas, n'hésitez pas à la vider car ce n'est pas normal. Ca n'arrive pas bien souvent. Pas assez souvent pour comprendre le problème.