Drive Garage avec Rclone (guide avancé)

Public visé: des utilisateurs sous Linux n'ayant pas peur de la ligne de commande.

Objectif:

Attention: ce tutoriel vous permet d'accéder à un dossier partagé depuis plusieurs machines. Cependant, Garage n'est pas capable de gérer l'édition en simultané d'un document depuis plusieurs lieux différents. Avec la méthode présentée ici, ne modifiez jamais un fichier stocké sur Garage depuis plusieurs ordinateurs en même temps: vous pourriez perdre des données!

En cas de problème avec ce tutoriel: rappporter votre souci sur le chan Matrix #tech:deuxfleurs.fr ou directement par mail à alex [at] adnab.me.

1. Obtenir des clefs d'accès Garage

La première étape consiste à obtenir vos clefs d'accès Garage. Pour l'instant la procédure n'est pas encore automatisée: vous devez demander à un administrateur qu'il vous envoie ces clefs manuellement. Demandez-lui également de créer un "bucket" pour vos fichiers personnels: pour l'instant vous ne pouvez pas encore le faire vous-même.

Vous devriez obtenir une paire de clefs de la forme suivante:

2. Configurer rclone

Avant de suive ce guide, assurez-vous que la commande rclone est installée sur votre système Linux.

La première étape consiste à configurer rclone pour accéder à vos dossier stockés sur Garage. Cette configuration est suffisante dans un premier temps si vous ne souhaitez pas chiffrer vos fichiers sur le serveur. La section suivante est optionnelle et permettera d'introduire la couche de chiffrement.

2.1. Configurer le backend Garage

Créez le fichier ~/.config/rclone/rclone.conf si celui-ci n'existe pas. Ensuite, modifiez ce fichier pour y ajouter la section suivante:

[grgdf]
type = s3
provider = Other
env_auth = false
access_key_id = GKae0f36c...
secret_access_key = ae6df87221edd...
endpoint = https://garage.deuxfleurs.fr
region = garage

Précisez les bonnes valeurs de access_key_id et secret_access_key que vous avez obtenu dans la phase 1.

Ensuite, testez votre configuration en faisant rclone lsd grgdf:. Vous devriez avoir une sortie ressemblant à ceci:

$ rclone lsd grgdf:
          -1 2021-11-24 17:10:05        -1 alex.perso
$

Ce résultat indique que vous disposez d'un bucket (un dossier de premier niveau) sur le stockage, ici appellé alex.perso. Celui-ci a été créé par un administrateur et vous ne pouvez pas en créer d'autre vous-même. Retenez son nom pour l'étape suivante.

2.2. Configurer la couche de chiffrement rclone

Pour cette étape, nous allons utiliser l'assistant de configuration interactif de rclone. Si vous ne souhaitez pas utiliser le chiffrement, cette étape est optionnelle, mais elle est en réalité simple à réaliser donc je vous conseille de le faire.

Prenez garde à copier vos mots de passez de chiffrement à plusieurs endroits : si vous les perdez, vos données deviendront définitivement illisibles !

Pour lancer l'assistant interactif, tapez rclone config dans un terminal. Ensuite, entrez les valeurs suivantes:

Vous pouvez vérifier que votre configuration a bien réussi en affichant le contenu du fichier ~/.config/rclone/rclone.conf. Vous devriez y voir une section comme la suivante:

[grgdfcrypt]
type = crypt
remote = grgdf:alex.perso
password = <...>
password2 = <...>

Pour tester que votre dossier chiffré est bien configuré, vous pouvez par exemple:

3. Configurer un service systemd utilisateur

Nous allons maintenant faire en sorte que vos dossiers Garage apparaissent comme des disques réseau montés sur votre système de fichier, ce qui vous permettera d'y accéder depuis votre explorateur de fichier comme s'il s'agissait de dossiers normaux.

Pour commencer, choissez un endroit où monter votre disque réseau. Dans cet exemple, j'utiliserai $HOME/mnt/grgdf pour le dossier non chiffré, et $HOME/mnt/grgdfcrypt pour le dossier chiffré. Créez ces deux dossier vides:

mkdir -p $HOME/mnt/grgdf
mkdir -p $HOME/mnt/grgdfcrypt

Créez ensuite le fichier ~/.config/systemd/user/rclone-mount@.service et copiez-y le contenu suivant:

[Unit]
Description=Mount a directory using rclone
After=network.target

[Service]
ExecStartPre=sh -c "fusermount -u ${HOME}/mnt/%i || exit 0"
ExecStart=/usr/bin/rclone mount --vfs-cache-mode minimal --cache-dir ${HOME}/.cache/rclone/%i %i: ${HOME}/mnt/%i

RestartSec=10
Restart=always

[Install]
WantedBy=default.target

Vous pouvez ensuite monter ("activer") vos dossiers Garage avec l'une des commandes suivantes:

Pour que ceux-ci soient montés automatiquement en permanence, tapez:

Pour tester le fonctionnement de votre dossier Garage, vous pouvez naviguer dans ce dossier avec votre explorateur de fichier, tenter d'y copier des fichiers, etc.

4. Configurer une seconde machine pour accéder au dossier

Vous pouvez assez facilement configurer une seconde machine pour accéder au même dossier partagé sur Garage. Pour cela, reprenez le fichier ~/.config/rclone/rclone.conf de votre premère machine et copiez-le au même endroit sur votre seconde machine. Vous pouvez ensuite réaliser sur votre deuxième machine les étapes mentionnées dans la section 3 pour le service systemd.

ATTENTION: Garage ne supporte pas l'édition simultanée d'un document depuis plusieurs machines. Si vous ouvrez un fichier pour le modifier en même temps sur des machines différentes, vous prenez le risque de perdre des données. Pour utiliser votre dossier Garage comme un lieu de travail collaboratif, assurez-vous que des personnes différentes devant modifier un même fichier prendront chacun leur tour bien défini pour le faire.

Références