Aller au contenu principal

Guide de migration V2

Ce guide a pour objectif d'accompagner la migration de Sync-in de la version 1.x vers la version 2.x.

Mise à jour du serveur

Les étapes à suivre varient selon le mode d'installation choisi lors du déploiement de Sync-in.

Docker Compose

Serveur

Pour mettre à jour l'image Docker, éditez le fichier docker-compose.yaml et définissez la version de l'image sur 2 :

services:
sync_in:
image: syncin/server:2

Puis lancez la mise à jour du service :

docker compose pull sync_in && docker compose up -d && docker image prune -f

Dépôt des applications de bureau (optionnel)

Si vous l'utilisez, éditez docker-compose.sync-in-desktop-releases.yaml et définissez la version de l'image sur 2:

services:
sync_in_desktop_releases:
image: syncin/desktop-releases:2

Puis lancez la commande ./config/sync-in-desktop-releases/update.sh depuis le dossier contenant le fichier docker-compose.yaml.

Node Package Manager

À la racine du package NPM, éditez le fichier package.json et mettez à jour la version vers ^2.0.0:

{
"dependencies": {
"@sync-in/server": "^2.0.0"
}
}

Puis installez la nouvelle version du package :

rm -rf node_modules package-lock.json && npm install

Mise à jour des applications de bureau

Les applications de bureau en version 1.x restent compatibles avec un serveur en version 2.x pour les serveurs déjà enregistrés.

En revanche, pour réauthentifier ou enregistrer des serveurs depuis les applications, les clients doivent être mis à jour vers la version 2.x.

⚠️ Les applications de bureau en version 1.x ne se mettront pas à jour vers la version 2.x automatiquement.

Depuis la page de téléchargement, vous pouvez télécharger la dernière version des applications.

Changements incompatibles

Configuration du serveur

Certaines sections du fichier de configuration environment.yaml ont été réorganisées et renommées afin d'améliorer la lisibilité et la cohérence de la configuration.

  • La clé auth.method est renommée en auth.provider:

    auth:
    # method: mysql
    provider: mysql
  • La clé auth.ldap.adminGroup est déplacée vers auth.ldap.options.adminGroup:

    auth:
    ldap:
    # adminGroup: admin
    options:
    adminGroup: admin

Améliorations

Configuration Reverse Proxy

La configuration Nginx fournie avec le package Docker Compose a été simplifiée.
Si vous avez utilisé le modèle de configuration Nginx pour l'adapter à votre reverse proxy, veillez à reporter ces modifications ou leurs équivalents dans votre configuration.

Modification de l'en-tête X-Forwarded-Proto

  • La directive suivante doit être utilisée :

    proxy_set_header X-Forwarded-Proto $scheme;
  • Elle remplace l'ancienne configuration :

    proxy_set_header X-Forwarded-Proto $xfp;
  • La partie ci-dessous peut-être supprimée de la configuration :

      map $request_uri $xfp {
    # This header must be null on webdav uri
    # It causes authentication failures with Microsoft-WebDAV-MiniRedir (Windows)
    ~^/webdav(?:/.*)? "";
    default $scheme;
    }

Cette simplification corrige certaines incompatibilités liées à WebDAV, allège la configuration Nginx et uniformise la gestion de l'en-tête X-Forwarded-Proto.