Interface utilisateur¶

Pré-requis techniques¶

Les agents Kiwi Cloud et Kiwi Santé sont disponibles pour les systèmes d’exploitation suivants :

Windows 64 bits et 32 bits : A partir de Windows 7
Windows Serveur : A partir de Windows 2012
Mac OS : Compatible Mac Sierra, High Sierra, Mojave et Catalina
Linux : Compatible Debian (sans interface graphique)
NAS Synology : DSM 6.2.4 et 7.x
NAS QNAP : A partir de QTS 4.1

⚠ Pour utiliser le logiciel Kiwi Backup, vous devez être en possession d’un numéro de contrat. Pour plus de renseignements : contact@kiwi-backup.com

Installation de l’interface utilisateur¶

Installation sous Windows¶

Connectez-vous sur le site www.kiwi-backup.com*. Sélectionnez Télécharger la solution et téléchargez la dernière version de Kiwi Cloud (données classiques) ou Kiwi Santé (architecture 32 ou 64 bits).

Alt text

*Ou utilisez votre lien dédié si vous utilisez la solution en marque blanche

Disponible pour Windows 64 bits.

Téléchargez l’installeur fourni et double-cliquez dessus. Suivez les instructions pour installer Kiwi Backup.

Utilisation Windows¶

Utilisez l’icône qui s’est ajoutée à votre bureau pour démarrer l’application.

Installation Mac¶

Connectez-vous sur le site www.kiwi-backup.com*. Sélectionnez Télécharger la solution et téléchargez la dernière version de Kiwi Cloud ou Kiwi Santé.

Alt text

Compatible Mac Sierra, High Sierra, Mojave, Catalina, Big Sur et Monterey.

À partir de Mojave, pour que Kiwi Backup puisse accéder à vos fichiers, vous devez donner à l’application l’accès complet au disque. Pour cela :

Cliquez sur l’icône Pomme en haut à gauche de l’écran, puis sur « Préférences système », « Sécurité et confidentialité ».
Sélectionnez l’onglet « Confidentialité ».
Choisissez « Accès complet au disque » dans la colonne de gauche, puis cliquez sur l’icône cadenas en-dessous de cette colonne.
Saisissez le mot de passe de l’administrateur de la machine puis cliquez sur « Déverrouiller ».
Cliquez sur « + ». Dans la fenêtre qui s’ouvre alors, cliquez sur « Applications » sur la gauche, sélectionnez « Kiwi Backup » dans la colonne centrale, puis cliquez sur « Ouvrir ».

Installation sous Linux¶

Disponible pour l’ensemble des OS basées sur Debian (dont Ubuntu), le dépôt Linux vous permet d’utiliser notre solution de sauvegarde en ligne de commande.

Récupérez la clé Kiwi Backup et ajoutez-la à votre trousseau APT :

curl https://apt.kiwi-backup.com/kiwi-backup.gpg | sudo apt-key add -

Éditez votre fichier sourcelist (le dépôt est étiqueté « jessie » mais est compatible avec les autres distributions Linux basées sur Debian 8+) :

echo 'deb [arch=amd64] https://apt.kiwi-backup.com/ jessie main' | sudo tee -a /etc/apt/sources.list

Mettez à jour les paquets :

sudo apt-get update

Enfin, installez kiwi4-cli :

sudo apt-get install kiwi4-cli

Désinstallation Linux¶

apt-get remove kiwi4-cli

Installation sous NAS Synology¶

Pré-requis¶

Version de DSM (système d’exploitation du NAS) : à ce jour, le paquet Kiwi Backup pour NAS Synology est compatible avec DSM 6.2.4 et DSM 7.0.

Architecture matérielle

Le paquet Kiwi Backup est compilé et publié spécifiquement pour de multiples architectures afin de permettre son installation sur des modèles de NAS utilisant des jeux d’instructions différents. Si le paquet n’est pas disponible pour le modèle de NAS que vous utilisez, n’hésitez pas à nous le signaler car nous pourrons vraisemblablement ajouter votre NAS à la liste des modèles supportés.

Installation¶

Sur le site Kiwi Backup, connectez-vous sur Télécharger la solution le paquet SYNOLOGY correspondant à l’architecture du NAS à sauvegarder.

Se connecter à DSM (suivre la documentation de Synology) avec un compte administrateur du NAS.

Centre de paquets : ajout de la source de paquets Kiwi Backup Pour installer le paquet Kiwi Backup, il faut d’abord configurer le Centre de paquets pour qu’il ait connaissance du dépôt de paquets tiers de Kiwi Backup :

Ouvrir le Centre de paquets
Cliquer sur le bouton « Paramètres »
Aller dans l’onglet « Sources de paquets »
Cliquer sur « Ajouter »
Donner un nom à la source de paquets, par exemple « Paquets Kiwi Backup »
Comme emplacement, saisir « https://syno.kiwi-backup.com »
Cliquer sur OK deux fois

À faire également, sur DSM 6 uniquement :

Ouvrir le Centre de paquets
Cliquer sur « Paramètres »
Sélectionner l’onglet « Général »
Sélectionner « Synology Inc. et les éditeurs de confiance » comme valeur pour l’option « Niveau de confiance »

Centre de paquets : installation du paquet Kiwi Backup¶

Note préliminaire : Le paquet Kiwi Backup est compilé et publié spécifiquement pour de multiples architectures afin de permettre son installation des modèles NAS différents. N’hésitez pas à nous contacter si vous ne voyez pas apparaître le paquet suite à l’ajout du dépôt Kiwi Backup, nous pourrons vraisemblablement ajouter votre modèle de NAS à la liste des modèles supportés. Dans l’onglet « Communauté » du Centre de paquets apparaît le paquet « Kiwi Backup » (il est également possible d’utiliser la barre de recherches au-dessus pour faciliter la recherche). Cliquer sur « Installer ». [DSM 7+ uniquement] Le Centre de paquets prévient que le paquet n’a pas été développé par Synology. Cliquer sur « Accepter ». Cocher la case d’acceptation de la licence qui s’affiche, puis cliquer sur « Suivant ». Laisser cochée la case « Lancer après installation », puis cliquer sur « Effectué. » Le paquet Kiwi Backup nécessite l’ouverture d’un port (8183) sur le NAS pour pouvoir accéder à l’interface de l’application. Si le pare-feu intégré à DSM est configuré pour bloquer ce port, une fenêtre s’affiche pour permettre de reconfigurer automatiquement les règles du pare-feu. Cliquer simplement sur OK pour accepter les modifications.

Note : en cas d’activation du pare-feu après l’installation du paquet, ou en cas de blocage ultérieur du port 8183, il reste possible de l’ouvrir manuellement via Panneau de configuration > Sécurité > onglet Pare-feu > Modifier les règles

Le paquet est maintenant installé, mais il reste une étape avant de pouvoir l’utiliser.

Assignation des droits de lecture/écriture sur les volumes à sauvegarder¶

Pour que la sauvegarde fonctionne, il faut accorder à l’utilisateur « KiwiBackup » la permission d’accéder aux volumes qu’on cherche à sauvegarder. Cet utilisateur est créé automatiquement lors de l’installation ; c’est un utilisateur dit « système », il ne peut pas se connecter à DSM et ne sert qu’au paquet Kiwi Backup. Pour ce faire :

Aller dans « Panneau de configuration » > « Dossier partagé »
Pour chaque volume à sauvegarder :
- Cliquer sur le volume
- Cliquer sur le bouton « Modifier »
- Aller dans l’onglet « Permissions »
- Cliquer sur la liste déroulante et sélectionner « Utilisateur du système interne »
- Cocher la case « Lecture/écriture » à la ligne KiwiBackup
- Cliquer sur le bouton « Sauvegarder »

La permission de lecture permet d’accéder aux fichiers lors de la configuration et de l’exécution des sauvegardes. La permission d’écriture est nécessaire pour enregistrer l’archive générée sur le volume concerné en cas de restauration d’une sauvegarde antérieure.

Utilisation de l’application Kiwi Backup¶

Pour accéder à l’interface de Kiwi Backup, utiliser le menu principal de DSM en haut à gauche, et cliquer sur « Kiwi Backup ».

L’utilisation de l’interface est inchangée par rapport à l’agent Kiwi Backup standard, merci de vous référer directement à sa documentation.

Comme d’habitude le serveur de backup doit être joignable via le port 4443 en sortie, ce qui signifie que vous devrez vraisemblablement ouvrir ce port sur votre routeur / box internet. N’hésitez pas à nous contacter si vous rencontrez des difficultés à effectuer cette manipulation.

Note à propos du périmètre de la sauvegarde¶

Le paquet Kiwi Backup est prévu pour sauvegarder les fichiers figurant dans les « dossiers partagés » Synology. Il n’est pas possible de sauvegarder l’intégralité du système de fichiers.

En revanche DSM prévoit la possibilité d’enregistrer sa configuration sous la forme d’un fichier « .dss » (voir https://kb.synology.com/fr-fr/DSMUC/help/DSMUC/AdminCenter/system_configbackup?version=). Il est possible et recommandé d’inclure ce fichier dans une sauvegarde afin de ne pas avoir à reconfigurer votre NAS en cas de problème.

Cycle de vie du paquet¶

Dans le Centre de paquets, il est possible d’arrêter puis de relancer le paquet Kiwi Backup. À moins d’une demande explicite du support technique, il est déconseillé de désactiver le paquet. Celui-ci est conçu pour fonctionner en permanence, sans quoi l’accès à l’interface de Kiwi Backup sera impossible et les sauvegardes ne pourront pas démarrer de façon planifiée.

Mise à jour du paquet¶

Pour mettre à jour Kiwi Backup :

Ouvrir le Centre de paquets
Sélectionner l’onglet « Installé »
Cliquer sur la case « Kiwi Backup » (ne pas cliquer directement sur le bouton à l’intérieur de cette case)
Cliquer sur le bouton « Mettre à jour » et suivre les éventuelles instructions qui s’affichent.

Si la mise à jour n’apparaît pas :

Le Centre de paquets met parfois plusieurs dizaines de minutes avant de détecter une mise à jour. Patienter est donc parfois la meilleure solution pour voir apparaître une mise à jour qui vient tout juste d’être publiée. Si après ce délai d’attente le paquet n’apparaît toujours pas, redémarrer le NAS permet généralement de régler le problème.
Vérifier que le paquet souhaité est bien disponible pour votre modèle de NAS : à l’aide d’un navigateur, visiter https://syno.kiwi-backup.com/ et cliquer sur le modèle de NAS Synology concerné pour voir si un paquet existe pour ce modèle et quelle est sa dernière version. Si aucun paquet n’est disponible pour votre modèle, n’hésitez pas à nous contacter car nous pourrons vraisemblablement en mettre un à votre disposition.

Note : l’option de mise à jour automatique est réservée aux packages de Synology et n’est malheureusement pas disponible pour le package Kiwi Backup.

Désinstallation¶

Pour désinstaller le paquet Kiwi Backup :

Ouvrir le Centre de paquets
Sélectionner l’onglet « Installé »
Cliquer sur la case « Kiwi Backup » (ne pas cliquer directement sur le bouton à l’intérieur de cette case)
Cliquer sur le triangle à côté du menu déroulant présent à proximité du logo Kiwi Backup, et choisir « Désinstaller »
Confirmer la désinstallation du paquet

La configuration de vos backups est conservée de façon à ce que vous n’ayez pas à tout reconfigurer en cas d’installation d’une nouvelle version de Kiwi Backup.

En cas de mise à niveau de DSM 6 à DSM 7¶

DSM 7 impose aux développeurs de paquets plusieurs restrictions qui n’avaient pas cours avec DSM 6. Une mise à niveau de DSM 6 vers 7 demande donc de désinstaller puis réinstaller le paquet Kiwi Backup pour pouvoir continuer à l’utiliser. Lors de la désinstallation, la configuration de Kiwi Backup sera conservée et réutilisée dans la nouvelle version du paquet.

Pour plus d’informations¶

Aide en ligne de DSM : https://kb.synology.com/fr-fr/DSM/help/DSM

Installation sous NAS QNAP¶

Pré-requis¶

Version de QTS (système d’exploitation du NAS) : à ce jour, le paquet Kiwi Backup pour NAS QNAP est compatible avec QTS 4.1 et suivants.

Architecture matérielle

Le paquet Kiwi Backup est compilé et publié spécifiquement pour de multiples architectures afin de permettre son installation des modèles NAS utilisant des jeux d’instructions différents. Si le paquet n’est pas disponible pour le modèle de NAS que vous utilisez, n’hésitez pas à nous le signaler car nous pourrons vraisemblablement ajouter votre NAS à la liste des modèles supportés.

Installation¶

Sur le site Kiwi Backup, connectez-vous sur Télécharger la solution le paquet QNAP correspondant à l’architecture du NAS à sauvegarder.

Se connecter à QTS (suivre la documentation de QNAP) avec un compte administrateur du NAS.

Procédez à l’installation manuelle du paquet :

Dans l’App Center, cliquer sur le bouton « Paramètres ». Cocher la case « Autoriser l’installation d’applications sans une signature numérique valide » puis cliquer sur « Appliquer »
Dans l’App Center, cliquer sur le bouton « installer manuellement » qui se trouve en haut à droite. Cliquer sur « Parcourir… », chercher et ouvrir le fichier de paquet KiwiBackup_….qpkg correspondant à l’architecture du NAS, puis cliquer sur « Installer ». Confirmer l’installation en cliquant sur « OK ».
Dans la fenêtre qui apparaît, cocher la case « Je comprends les risques et je souhaite installer cette application. » puis cliquer sur « Installer ».

Configuration du NAS¶

Le paquet Kiwi Backup nécessite l’ouverture du port 8183 pour pouvoir accéder à l’interface de l’application. La configuration par défaut de QTS ne bloque pas ce port, mais si le pare-feu intégré à QTS ou toute autre application installée (QuFirewall…) le bloque, il vous faudra l’ouvrir. N’hésitez pas à contacter notre support technique en cas de besoin.

Le paquet est maintenant installé, mais il reste une étape avant de pouvoir l’utiliser.

Utilisation de l’application Kiwi Backup¶

Pour accéder à l’interface de Kiwi Backup, utiliser le menu principal de QTS en haut à gauche, et cliquer sur « Kiwi Backup ». L’utilisation de l’interface est inchangée par rapport à l’agent Kiwi Backup standard, merci de vous référer directement à sa documentation.

Comme d’habitude le serveur de backup doit être joignable via le port 4443 en sortie, ce qui signifie que vous devrez vraisemblablement ouvrir ce port sur votre routeur / box internet. N’hésitez pas à nous contacter si vous rencontrez des difficultés à effectuer cette manipulation.

Note à propos du périmètre de la sauvegarde

Le paquet Kiwi Backup est prévu pour sauvegarder les fichiers figurant sur les volumes du NAS, ce qui n’inclut pas la configuration du système. En revanche QTS prévoit la possibilité d’enregistrer sa configuration sous la forme d’un fichier « .bin » (voir https://docs.qnap.com/nas-outdated/4.1/SMB/fr/index.html?backup_restore.htm). Il est possible et recommandé d’inclure ce fichier dans une sauvegarde afin de ne pas avoir à reconfigurer manuellement votre NAS en cas de problème.

Cycle de vie du paquet¶

Dans le Centre de paquets, il est possible d’arrêter puis de relancer le paquet Kiwi Backup. À moins d’une demande explicite du support technique, il est déconseillé de désactiver le paquet. Celui-ci est conçu pour fonctionner en permanence, sans quoi l’accès à l’interface de Kiwi Backup sera impossible et les sauvegardes ne pourront pas démarrer de façon planifiée.

Désinstallation¶

Pour désinstaller le paquet Kiwi Backup :

Ouvrir l’App Center
Sélectionner l’onglet « Mes applications »
Sous l’icône Kiwi Backup, cliquer sur le menu déroulant « v », puis sur « Supprimer ». Confirmer la désinstallation en cliquant sur « OK ».

La configuration de vos backups est conservée de façon à ce que vous n’ayez pas à tout reconfigurer en cas d’installation d’une nouvelle version de Kiwi Backup.

Mise à jour du paquet¶

Pour effectuer une mise à jour du paquet Kiwi Backup à une version plus récente que celle qui est installée :

Suivre la procédure de désinstallation ci-dessus pour supprimer la version actuelle de Kiwi Backup
Suivre la procédure d’installation ci-dessus pour télécharger et installer la nouvelle version de Kiwi Backup

La configuration de votre sauvegarde sera conservée malgré cette mise à jour.

Pour plus d’informations¶

Aide en ligne de QTS : https://docs.qnap.com/operating-system/qts/5.0.x/fr-fr

Enregistrement d’une machine¶

Pour créer un compte, complétez les informations demandées :

Nom de machine : en général, il s’agit du nom du possesseur du PC. A vous de choisir.
Clé de contrat : elle est à récupérer sur l’interface d’administration dans l’onglet « gestion des contrats »
L’adresse du pool en fonction de la plateforme de sauvegarde :
- plateforme Kiwi Cloud : https://pool4.kiwi-backup.com
- plateforme Kiwi Santé : https://pool.sante.kiwi-backup.com

alt text

Validez les infos en cliquant « Enregistrer ». Vous arrivez sur la page d’accueil : la pastille verte indique le port nécessaire à la sauvegarde de vos données (4443).

Paramétrage d’une sauvegarde¶

Choix des dossiers à sauvegarder¶

Une fois votre machine enregistrée, cliquez sur l’onglet « sauvegarde » pour configurer la sauvegarde.

L’arborescence de vos dossiers est affichée sur la partie gauche de l’écran. Il vous suffit de dérouler le ou les disques correspondants et de cocher les dossiers et fichiers à sauvegarder. Si vous voulez exclure un dossier ou un fichier, vous pouvez les décocher.

Alt text

Les dossiers à sauvegarder et à exclure s’affichent à droite de l’écran, dans « Paramètres ».

Alt text

Type de fichiers à exclure : Saisissez directement les extensions de fichier que vous ne voulez pas sauvegarder. Par exemple, pour tous les fichiers .bak, renseignez *.bak.

Disques montés¶

Cela permet de rendre accessible une partie réseau qui n’est pas physiquement présente sur la machine. Choisissez le disque, le chemin UNC et notez le mot de passe s’il y’en a un. Apparaîtra ensuite le disque dans l’arborescence (comme les disques physiques sur la machine)

Alt text

Calcul du volume à sauvegarder¶

Vous pouvez calculer le nombre de fichiers et le volume des données paramétré, cliquez sur « calcul ». Le résultat s’affiche en bas à gauche de votre écran. Pour rappel, la 1ère sauvegarde est complète. Lors des prochaines sauvegardes, seuls les blocs des fichiers modifiés seront transférés et non les fichiers entiers. Nous vous recommandons d’utiliser cette fonction avant la première sauvegarde, ceci vous permettra d’avoir une progression de cette dernière (nombre de fichiers traités / total).

Alt text

Choix de l’heure de sauvegarde¶

Choisissez ensuite l’heure de sauvegarde. Précisez plutôt un horaire dans la nuit, pas en heure pleine afin de limiter l’utilisation de la bande passante.

Alt text

Paramètres avancés¶

Les 3 paramètres avancés vous permettent par exemple d’éteindre le poste après la sauvegarde (sur Windows) ou activer le VSS de Windows (seulement en cas de fichiers ouverts).

Alt text

Lancement de la sauvegarde¶

La sauvegarde est maintenant paramétrée. Elle se lancera à l’heure prévue. Pour la lancer immédiatement, cliquez sur « lancer la sauvegarde ». Une barre de progression va s’afficher.

Alt text

Mails d’alertes¶

Une fois la sauvegarde effectuée, vous réceptionnerez un mail d’alerte indiquant si elle s’est bien déroulée ou non.

Alt text

Jeux de sauvegarde¶

Vous pouvez ajouter plusieurs jeux de sauvegarde. Par exemple, le CRM peut être sauvegardé à midi et le reste des fichiers le soir. Avoir plusieurs jeux de sauvegarde permet également d’optimiser l’utilisation de la bande passante.

Alt text

Cliquez sur « Backup 1 » puis sur « gestion ». Il vous suffit de renseigner le nom de votre jeu de sauvegarde.

Alt text

Restauration d’une sauvegarde¶

Choix des dossiers à restaurer¶

Commencez par vous rendre dans le menu « restauration ». Le bloc de gauche comporte l’ensemble des sauvegardes effectuées avec les dates et les heures auxquelles ces dernières ont été exécutées. Vous avez accès à un historique de 90 jours. Cliquez ensuite sur le jour de la sauvegarde à restaurer. L’ensemble des dossiers et des sous-dossiers sauvegardés se déroulent ; il vous suffit de sélectionner les dossiers ou fichiers à restaurer. Une fois sélectionnés, ces derniers s’affichent à droite de l’écran.

Alt text

Choix de l’emplacement de restauration¶

2 emplacements de restauration sont proposés :

Le premier est l’emplacement d’origine. Pour ce faire cliquez « restaurer au même endroit ».

Alt text

Attention, cette action écrasera les données existantes et les remplacera par les données restaurées.

Le deuxième choix est l’emplacement spécifique en cliquant sur « répertoire de restauration » qui permet de créer un dossier où seront placées les données

Alt text

Lancement de la restauration¶

Cliquez sur « lancer la restauration ». Une barre de progression va s’afficher.

Utilisation avancée¶

Interface ligne de commande (CLI)¶

L’interface en ligne de commande de Kiwi Backup permet de piloter l’ensemble des opérations d’enregistrement, de sauvegarde et de restauration. Celà facilite l’intégration dans vos propres script d’installation ou dans un process de sauvegarde plus large.

Afficher l’aide:¶

a tout moment vous pouvez obtenir l’ensemble des commandes disponible avec la commande suivante:

kiwi.exe --help

Pour le détail d’une commande vous pouvez préciser la commande avant le –help

kiwi.exe install --help

Enregistrement d’une machine¶

kiwi.exe install --name toto --key CLEFCONTRAT --server pool.sante.kiwi-backup.com --jobid monjob

les options sont optionnelles. Si vous ne les spécifiez pas, le programme vous les demandera interractivement.

Lancer un backup¶

kiwi.exe backup --jobid monjob

Si on ne spécifie pas le jobid, il utilise celui par défaut ( backup1 )

Restauration¶

kiwi.exe restore /chemin/du/fichier/ou/dossier --jobid --dest --bid

Example:

 kiwi.exe restore /home/user1/toto --jobid backup1 --dest /home/user1/resto/ --bid 456456456456456

Synchronisation¶

kiwi.exe sync --jobid]

Example:

kiwi synchro --jobid backup1

Update Client¶

kiwi.exe update

Informations (emplacement du fichier de conf/logs)¶

kiwi.exe info

structure du fichier de configuration¶

___:
    default_server: ""
    security:
        auth_user: ""
        auth_pass: ""
        salt: ""
backup1:
    key: backup1
    files:
        exclude: []
        excludepattern: []
        include: []
        includepattern: []
        use_vss: 0
    label: backup1
    params:
        clientid:
        clientkey:
        registered: true
        server: https://pool4.kiwi-backup.com:4443
        servers: null
        total_size: 0
        total: 0
        active: 1
    scheduler:
        hour: "14"
        min: "55"
    security:
        max_recv_speed: 0
        max_send_speed: 0
    shutdown_after_backup: null
    remote_disk: []
    script:
        before_backup: ""
        after_backup: ""

Fichier de configuration¶

Voici la liste des emplacement du fichier de configuration de kiwi

OS	Chemin par défaut
Windows	C:\ProgramData\Kiwi-Backup\backup\kiwi.conf
Mac	/Library/Application Support/backup/kiwi.conf
Linux Debian-based	/etc/kiwi.conf
QNAP	/etc/config/kiwi.conf
Synology	/var/packages/KiwiBackup/etc/kiwi.conf

Alterer l’emplacement du datadir de kiwi sous windows¶

Pour changer l’emplacement du dossier de data kiwi il faut créer la variable d’environement KIWI_ALT_DATADIR et lui passer en paramettre le chemin du nouvelle emplacement.