Aller au contenu principal

Installation

Installation de Sync-in avec Docker Compose.

Sync-in est distribué sous forme d’une image Docker officielle, disponible sur Docker Hub : https://hub.docker.com/r/syncin/server

Cette image est spécifiquement conçue pour être déployée et exécutée dans un environnement Docker Compose.

📋 Prérequis​

⚙️ Configuration matérielle minimale​

  • RAM : 1 Go
  • CPU : 1 cores/vCPU
  • Espace disque : 2 Go

🐳 Docker Compose​

Cette configuration repose sur des fichiers Docker Compose utilisant l’extension x-include.
Vous aurez besoin de :

  • Docker Engine version 24 ou supérieure
  • Docker Compose version 2.20 ou supérieure

✅ Vous pouvez vérifier les versions installées avec :

docker --version
docker compose version

🔗 Si Docker n’est pas installé, suivez le guide d'installation officiel de Docker.

📦 Fichiers de configuration​

Pour récupérer les fichiers Docker Compose de Sync-in (sync-in-docker) depuis https://github.com/Sync-in/server/releases, utilisez l’une des méthodes suivantes :

  • curl et unzip : 
    curl -L -o sync-in-docker.zip \
    https://github.com/Sync-in/server/releases/latest/download/sync-in-docker.zip && \
    unzip sync-in-docker.zip
  • ou avec curl et tar: 
    curl -L -o sync-in-docker.tar.gz \
    https://github.com/Sync-in/server/releases/latest/download/sync-in-docker.tar.gz && \
    tar zxvf sync-in-docker.tar.gz

Vous devriez obtenir la structure suivante dans le répertoire sync-in-docker :

├── config
│   ├── collabora
│   │   └── docker-compose.collabora.yaml
│   ├── nginx
│   │   ├── collabora.conf
│   │   ├── docker-compose.nginx.yaml
│   │   ├── nginx.conf
│   │   └── onlyoffice.conf
│   ├── onlyoffice
│   │   └── docker-compose.onlyoffice.yaml
│   └── sync-in-desktop-releases
│       ├── docker-compose.sync-in-desktop-releases.yaml
│       └── update.sh
├── docker-compose.yaml
└── environment.yaml

Vous pouvez vérifier la structure et le contenu depuis le dépôt GitHub.

🚀 Démarrage rapide​

1. Secrets par défaut​

Accédez au répertoire Docker Compose :

cd sync-in-docker

Avant de démarrer le serveur, veillez à remplacer les secrets par défaut pour des raisons de sécurité.

Modifiez le fichier environment.yaml :

auth:
  encryptionKey: "changeEncryptionKeyWithStrongKey"
  token:
    access:
      secret: "changeAccessWithStrongSecret"
    refresh:
      secret: "changeRefreshWithStrongSecret"
mysql:
  # Utilisez le mot de passe root défini dans docker-compose.yaml
  url: mysql://root:MySQLRootPassword@mariadb:3306/sync_in

Puis, modifiez le fichier docker-compose.yaml pour vous assurer que le mot de passe MySQL correspond :

services:
  mariadb:
    environment:
      MYSQL_ROOT_PASSWORD: "MySQLRootPassword"
Sécurité

Utilisez des chaînes longues et générées aléatoirement pour vos secrets afin de garantir une sécurité maximale.

info

N’oubliez pas d’ajouter des guillemets si vos mots de passe contiennent des caractères spéciaux.

astuce

Vous pouvez utiliser des variables d’environnement pour configurer les secrets précédemment définis.
Consultez la section Variables d’environnement pour plus de détails

2. Lancer le serveur Sync-in​

Pour définir vos propres identifiants administrateur au premier lancement, utilisez :

INIT_ADMIN=true INIT_ADMIN_LOGIN='user' INIT_ADMIN_PASSWORD='password' docker compose up -d

Remplacez user et password par les identifiants souhaités.

Si vous ne définissez pas ces variables et lancez simplement :

INIT_ADMIN=true docker compose up -d

Le serveur utilisera les identifiants administrateur par défaut :

  • Login : sync-in
  • Mot de passe : sync-in
attention

Important : Pour des raisons de sécurité, il est fortement recommandé de modifier ces identifiants dès votre première connexion.

info

Pour vérifier le statut des conteneurs : docker compose ps

3. Accéder à l’interface Web​

Une fois le serveur lancé, ouvrez votre navigateur à l’adresse suivante :

http://localhost:8080

Connectez-vous en utilisant les identifiants administrateur définis à l’étape 2.