东东's Blog

Backing Up Important Data with Restic

2025-04-03T21:00:00+08:00

I had been using Cryptomator for quite a long time to manage my content. Its advantage is that local data also requires a password to access. After encryption, the content can be placed on sync drives like Nutstore, Dropbox, etc., and uploaded to the cloud in real-time after each file addition or modification.

If you're storing content that doesn't need editing and you mainly add or replace resources, I would still highly recommend trying Cryptomator. It's well-suited for saving electronic scans, images, and spreadsheet documents.

However, on macOS, if you use software like Obsidian to manage your knowledge base and frequently need to edit content, editing text files after decrypting with Cryptomator becomes quite unfriendly. To avoid issues, when editing plain text files, I had to copy them out, edit them, and then replace the original files, which was quite cumbersome.

I happened to learn about Restic. If you want to encrypt and backup your Obsidian or other note-taking software vaults and upload them to cloud drives or S3-compatible platforms, then Restic is perfect for that.

Quick Start

Installing Restic

macOS

$ brew install restic

It supports mainstream operating systems. For details, see: https://restic.readthedocs.io/en/latest/020_installation.html

Initializing a Local Repository

Simply put, a repository is a folder for storing encrypted files. The initialization process generates some metadata.

$ restic init --repo ~/Documents/NoteE2EE
enter password for new repository:
enter password again:
created restic repository 0a40262533 at /Users/xxxxx/Documents/NoteE2EE

Please note that knowledge of your password is required to access
the repository. Losing your password means that your data is
irrecoverably lost.

Remember your password. Once forgotten, there's no way to decrypt the data.

Backing Up Data

Execute the command to back up the ~/Documents/Note folder to the ~/Documents/NoteE2EE repository.

$ restic -r ~/Documents/NoteE2EE backup ~/Documents/Note

On the first run, you can see the number of files and directories backed up, and the "snapshot" ID is displayed.

The command can be run multiple times (each run creates a snapshot).

Since it creates incremental backups, you don't need to worry about snapshots taking up too much space.

Use the following command to view the list of snapshots in the repository:

$ restic -r ~/Documents/NoteE2EE snapshots

This repository folder "NoteE2EE" contains encrypted content. Following the 3-2-1 principle, it can be safely stored on local hard drives, external drives, and cloud storage without worrying about data leaks.

Optimizing Backup Command Parameters

$ restic -r ~/Documents/NoteE2EE backup ~/Documents/Note \
    --pack-size 32 \
    --exclude="*.tmp" \
    --iexclude="*.LOG" \
    --limit-upload 1024 \
    --json

Good use of the --pack-size parameter can effectively control the number of target files, preventing large files from being split into too many small files. Historical files won't be affected; it only impacts the current incremental backup.

Corresponding to --limit-upload, there's a --limit-download parameter for limiting download speed.

If you're developing small tools based on Restic, the --json parameter is quite necessary:

{"message_type":"status","percent_done":0,"total_files":29,"total_bytes":204482794}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0.2808864315308279,"total_files":41,"files_done":13,"total_bytes":333776710,"bytes_done":93753349}
{"message_type":"status","percent_done":1,"total_files":41,"files_done":41,"total_bytes":333776710,"bytes_done":333776710}
{"message_type":"summary","files_new":0,"files_changed":0,"files_unmodified":41,"dirs_new":0,"dirs_changed":2,"dirs_unmodified":8,"data_blobs":0,"tree_blobs":2,"data_added":756,"data_added_packed":608,"total_files_processed":41,"total_bytes_processed":333776710,"total_duration":5.552792709,"backup_start":"2025-04-02T18:30:04.949151+08:00","backup_end":"2025-04-02T18:30:10.501995+08:00","snapshot_id":"74e465ed71f7fb5b7abb562d4cb9d067f20d89a1a9f3ed4ed32a0bc73e8abab1"}

Based on this data, you can create progress bars and display the volume of backed-up files.

More Backend Storage Types

Using the command restic init --repo ~/Documents/NoteE2EE, we created a local repository.

Below is an example of an S3-compatible storage:

# Setting environment variables
$ export AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
$ export AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
$ export AWS_DEFAULT_REGION=cn-east-1

# Initializing repository and backup
$ restic -r s3:https://s3.bitiful.net/note-e2ee init
$ restic -r s3:https://s3.bitiful.net/note-e2ee --verbose backup ~/Documents/Note

Note: If the AWS_DEFAULT_REGION environment variable is not set, us-east-1 will be used as the default value.

For other platforms and storage options like Amazon S3, Backblaze B2, Google Cloud, etc., refer to the documentation: https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html

Snapshot Management

Keeping Recent Snapshots

We might run backup on a schedule, but too many backups can be overwhelming. Run the following command to keep only the 7 most recent snapshots:

$ restic -r [repository path] forget --keep-last 7 --prune

Snapshot Tags

You can specify multiple tags when backing up (--tag "v1.0" --tag "daily"):

$ restic -r ~/Documents/NoteE2EE backup --tag "v1.0" ~/Documents/Note

You can also modify tags for existing snapshots:

# Add a tag
$ restic -r ~/Documents/NoteE2EE tag --add "important" 8c5c9d50

# Remove a tag
$ restic -r ~/Documents/NoteE2EE tag --remove "important" 43547193

# Set multiple tags
$ restic -r ~/Documents/NoteE2EE tag --set "important,project2" a1ff1a78

It's worth noting that after each modification, the snapshot ID will change.

Verifying Backup Integrity

Backups stored in the cloud can't guarantee 100% file preservation or prevent damage. You can verify integrity using the check command:

$ restic -r ~/Documents/NoteE2EE check

Now let's simulate "damage". For example, find a file in the data directory within the NoteE2EE directory, modify its filename by adding an underscore at the beginning to simulate file damage/loss.

Running the check command again shows that the repository is abnormal and needs repair, which is expected.

Restoring Snapshots to a Specific Directory

View existing snapshots:

$ restic -r ~/Documents/NoteE2EE snapshots

Export a specific snapshot:

$ restic -r ~/Documents/NoteE2EE restore 5fcd966f --target ~/Downloads/NoteRestore/

5fcd966f is the snapshot ID, which can be found using the snapshots command; additionally, the NoteRestore directory will be created automatically if it doesn't exist.

If your repository is large and you only want to export certain files or directories, use the following command:

$ restic -r ~/Documents/NoteE2EE restore 5fcd966f --target ~/Downloads/NoteRestore/ --include Epub电子书

In this case, "--include Epub电子书" refers to a folder in the root directory of the repository.

Using "copy" Instead of "backup"

If you only have one encrypted repository, using backup each time works fine. However, if you follow the 3-2-1 principle for backups and have multiple encrypted repositories, running backup multiple times to different repositories is inefficient.

In this case, you need to use copy, which ensures strict data consistency and performs well:

$ restic init --repo ~/Documents/NoteE2EE-copy

$ restic -r ~/Documents/NoteE2EE-copy copy --from-repo ~/Documents/NoteE2EE

From an AI summary (which I think is quite good):

If you need to synchronize data between multiple Restic repositories, copy is always the preferred choice—it acts like a professional "data mover" between repositories, while backup is like a "collector" for original data.

Give Restic Browser a Try

If you're not a fan of command-line operations, you can try this open-source tool: emuell/restic-browser

Developed with Rust + TypeScript, it's only a few megabytes in size and has read-only functionality. As the name "Browser" suggests, it allows you to browse encrypted repositories and makes it more convenient to look for files in snapshots.

You Might Also Need Autorestic

Documentation: Autorestic Quick Start

Autorestic is a wrapper around the amazing restic. While being amazing the restic cli can be a bit overwhelming and difficult to manage if you have many different location that you want to backup to multiple locations. This utility is aimed at making this easier 🙂

Autorestic is a wrapper developed around the excellent restic tool. Although the restic command-line tool itself is outstanding, when you need to synchronize backup data from multiple different locations to multiple storage targets, its operation can seem complex and difficult to manage. This tool aims to simplify this process, making multi-target backup management easier and more convenient.

Installation

$ brew install autorestic

Configuration File

Create a configuration file with the following content:

version: 2
backends:
  note_primary:
    type: local
    path: "~/Documents/NoteE2EE"
    env:
      RESTIC_PASSWORD: "your-restic-vault-password"
  note_backup:
    type: local
    path: "~/Documents/NoteE2EE-copy"
    env:
      RESTIC_PASSWORD: "your-restic-vault-password"

locations:
  notes:
    from: "~/Documents/Note"
    to:
      - note_primary
      - note_backup
    options:
      forget:
        keep-last: 7

Change the configuration file permissions (recommended):

$ chmod 600 ~/.autorestic.yml

Locations and Backends

In Autorestic, Location describes the backup content and target (from / to), and Backend defines the backup destination.

Configuration Verification

$ autorestic check

Everything is fine.

Manual Backup Execution

Complete backup:

$ autorestic backup -a

Specific Location backup:

$ autorestic backup -l notes

Output:

Currently, this solution perfectly fits my needs and is easy to use. I'll update this post with any additional information after using it for a while.

References

Sauvegarder des données importantes avec Restic

2025-04-03T21:00:00+08:00

J'ai utilisé Cryptomator pendant assez longtemps pour gérer mes contenus. Son avantage est que les données locales nécessitent également un mot de passe pour y accéder. Une fois chiffrées, ces données peuvent être synchronisées vers Nutstore, Dropbox ou d'autres services cloud, avec un téléversement en temps réel après chaque modification.

Si vous stockez des fichiers qui ne nécessitent pas d'édition fréquente et que vous ajoutez ou remplacez principalement des ressources, je recommande vivement Cryptomator. Il est idéal pour sauvegarder des documents numérisés, des images et des tableaux.

Cependant, sous macOS, si vous utilisez des logiciels comme Obsidian pour gérer votre base de connaissances et que vous modifiez fréquemment vos fichiers, l'édition de texte avec Cryptomator devient peu pratique. Pour éviter les problèmes, je devais copier le contenu, le modifier, puis remplacer le fichier original, ce qui était assez fastidieux.

J'ai découvert par hasard Restic. Si vous souhaitez sauvegarder et chiffrer votre coffre-fort Obsidian pour l'envoyer vers un cloud ou une plateforme S3, Restic est parfaitement adapté.

Quick Start

Installation de Restic

macOS

$ brew install restic

Compatible avec la plupart des systèmes d'exploitation, voir : https://restic.readthedocs.io/en/latest/020_installation.html

Initialisation d'un dépôt local

Un dépôt est simplement un dossier qui stocke vos fichiers chiffrés. L'initialisation crée des métadonnées nécessaires.

$ restic init --repo ~/Documents/NoteE2EE
enter password for new repository:
enter password again:
created restic repository 0a40262533 at /Users/xxxxx/Documents/NoteE2EE

Please note that knowledge of your password is required to access
the repository. Losing your password means that your data is
irrecoverably lost.

N'oubliez pas votre mot de passe, car les données chiffrées seront irrécupérables en cas d'oubli.

Sauvegarde des données

Exécutez cette commande pour sauvegarder le dossier ~/Documents/Note dans le dépôt ~/Documents/NoteE2EE

$ restic -r ~/Documents/NoteE2EE backup ~/Documents/Note

À la première exécution, vous verrez le nombre de fichiers et répertoires sauvegardés, ainsi que l'ID du "snapshot" (instantané) créé.

La commande peut être exécutée plusieurs fois (chaque exécution crée un nouveau snapshot)

Comme les sauvegardes sont incrémentielles, ne vous inquiétez pas de l'espace disque.

Utilisez cette commande pour afficher la liste des snapshots dans le dépôt:

$ restic -r ~/Documents/NoteE2EE snapshots

Le dossier "NoteE2EE" contient vos données chiffrées. Vous pouvez le stocker en toute sécurité sur votre disque dur local, un disque externe ou un cloud, selon le principe 3-2-1, sans craindre de fuites de données.

Optimisation des paramètres de sauvegarde

$ restic -r ~/Documents/NoteE2EE backup ~/Documents/Note \
    --pack-size 32 \
    --exclude="*.tmp" \
    --iexclude="*.LOG" \
    --limit-upload 1024 \
    --json

L'option --pack-size permet de contrôler efficacement le nombre de fichiers cibles, évitant que les gros fichiers ne soient divisés en trop de petits fichiers. Les fichiers historiques ne sont pas affectés, seule la sauvegarde incrémentielle actuelle l'est.

En complément de --limit-upload, il existe un paramètre --limit-download pour limiter la vitesse de téléchargement.

Si vous développez des outils basés sur Restic, le paramètre --json est très utile:

{"message_type":"status","percent_done":0,"total_files":29,"total_bytes":204482794}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0.2808864315308279,"total_files":41,"files_done":13,"total_bytes":333776710,"bytes_done":93753349}
{"message_type":"status","percent_done":1,"total_files":41,"files_done":41,"total_bytes":333776710,"bytes_done":333776710}
{"message_type":"summary","files_new":0,"files_changed":0,"files_unmodified":41,"dirs_new":0,"dirs_changed":2,"dirs_unmodified":8,"data_blobs":0,"tree_blobs":2,"data_added":756,"data_added_packed":608,"total_files_processed":41,"total_bytes_processed":333776710,"total_duration":5.552792709,"backup_start":"2025-04-02T18:30:04.949151+08:00","backup_end":"2025-04-02T18:30:10.501995+08:00","snapshot_id":"74e465ed71f7fb5b7abb562d4cb9d067f20d89a1a9f3ed4ed32a0bc73e8abab1"}

Ces données permettent de créer des barres de progression et d'afficher le volume des fichiers sauvegardés.

Plus de types de stockage (Backends)

La commande restic init --repo ~/Documents/NoteE2EE a créé un dépôt local.

Voici un exemple pour un stockage compatible S3:

# Configuration des variables d'environnement
$ export AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
$ export AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
$ export AWS_DEFAULT_REGION=cn-east-1

# Initialisation du dépôt et sauvegarde
$ restic -r s3:https://s3.bitiful.net/note-e2ee init
$ restic -r s3:https://s3.bitiful.net/note-e2ee --verbose backup ~/Documents/Note

Note: Si la variable AWS_DEFAULT_REGION n'est pas définie, us-east-1 sera utilisé par défaut.

Pour d'autres plateformes comme Amazon S3, Backblaze B2, Google Cloud, consultez: https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html

Gestion des snapshots

Conservation des snapshots récents

Si vous exécutez backup régulièrement, vous pouvez avoir trop de sauvegardes. Cette commande permet de ne conserver que les 7 derniers snapshots:

$ restic -r [chemin_du_dépôt] forget --keep-last 7 --prune

Étiquettes de snapshot

Vous pouvez spécifier plusieurs étiquettes lors de la sauvegarde (--tag "v1.0" --tag "daily"):

$ restic -r ~/Documents/NoteE2EE backup --tag "v1.0" ~/Documents/Note

Vous pouvez également modifier les étiquettes des snapshots existants:

# Ajouter une étiquette
$ restic -r ~/Documents/NoteE2EE tag --add "important" 8c5c9d50

# Supprimer une étiquette
$ restic -r ~/Documents/NoteE2EE tag --remove "important" 43547193

# Définir plusieurs étiquettes
$ restic -r ~/Documents/NoteE2EE tag --set "important,project2" a1ff1a78

Notez que l'ID du snapshot change après chaque modification.

Vérification de l'intégrité des sauvegardes

Les sauvegardes stockées sur le cloud ne sont pas garanties à 100% contre la perte ou la corruption. La commande check permet de vérifier l'intégrité:

$ restic -r ~/Documents/NoteE2EE check

Simulons maintenant une "corruption" en modifiant le nom d'un fichier dans le répertoire data de NoteE2EE, en ajoutant un underscore au début pour simuler une perte ou corruption:

En exécutant à nouveau la commande check, un message indique que le dépôt est anormal et nécessite une réparation, comme prévu:

Restauration d'un snapshot dans un répertoire spécifique

Visualisation des snapshots existants:

$ restic -r ~/Documents/NoteE2EE snapshots

Exportation d'un snapshot spécifique:

$ restic -r ~/Documents/NoteE2EE restore 5fcd966f --target ~/Downloads/NoteRestore/

5fcd966f est l'ID du snapshot, que vous pouvez trouver avec la commande snapshots. Le répertoire NoteRestore sera créé automatiquement s'il n'existe pas.

Si votre dépôt est volumineux et que vous souhaitez restaurer uniquement certains fichiers ou dossiers:

$ restic -r ~/Documents/NoteE2EE restore 5fcd966f --target ~/Downloads/NoteRestore/ --include Epub电子书

"Epub电子书" est un dossier situé à la racine du dépôt.

Utiliser copy plutôt que backup

Si vous n'avez qu'un seul dépôt chiffré, utilisez simplement backup à chaque fois. Mais si vous suivez le principe 3-2-1 avec plusieurs dépôts chiffrés, il n'est pas efficace d'exécuter backup plusieurs fois vers différents dépôts.

Dans ce cas, utilisez copy, qui garantit une cohérence stricte des données avec d'excellentes performances:

$ restic init --repo ~/Documents/NoteE2EE-copy

$ restic -r ~/Documents/NoteE2EE-copy copy --from-repo ~/Documents/NoteE2EE

Résumé de l'IA (que je trouve pertinent):

Si vous devez synchroniser des données entre plusieurs dépôts Restic, copy est toujours le meilleur choix — il fonctionne comme un "transporteur de données" professionnel entre dépôts, tandis que backup est un "collecteur" orienté vers les données brutes.

Essayez Restic Browser

Si vous n'aimez pas les opérations en ligne de commande, essayez cet outil open source: emuell/restic-browser

Développé avec Rust + TypeScript, il ne pèse que quelques mégaoctets et offre uniquement des fonctions de lecture. Comme son nom "Browser" l'indique, il permet de parcourir les dépôts chiffrés et facilite la recherche de fichiers dans les snapshots.

Vous pourriez aussi avoir besoin d'Autorestic

Documentation: Autorestic Quick Start

Autorestic est un wrapper autour de l'étonnant restic. Bien qu'étant remarquable, l'interface en ligne de commande de restic peut être un peu intimidante et difficile à gérer si vous avez plusieurs emplacements différents que vous souhaitez sauvegarder vers plusieurs destinations. Cet utilitaire vise à faciliter ce processus 🙂

Autorestic est un wrapper développé autour de l'excellent outil restic. Bien que l'outil en ligne de commande restic soit exceptionnel, il peut devenir complexe et difficile à gérer lorsque vous devez synchroniser des sauvegardes de plusieurs emplacements vers différentes destinations. Cet utilitaire vise à simplifier ce processus, rendant la gestion des sauvegardes multi-cibles plus facile et plus agréable.

Installation

$ brew install autorestic

Fichier de configuration

Créez un fichier de configuration avec le contenu suivant:

version: 2
backends:
  note_primary:
    type: local
    path: "~/Documents/NoteE2EE"
    env:
      RESTIC_PASSWORD: "your-restic-vault-password"
  note_backup:
    type: local
    path: "~/Documents/NoteE2EE-copy"
    env:
      RESTIC_PASSWORD: "your-restic-vault-password"

locations:
  notes:
    from: "~/Documents/Note"
    to:
      - note_primary
      - note_backup
    options:
      forget:
        keep-last: 7

Modifiez les permissions du fichier de configuration (recommandé):

$ chmod 600 ~/.autorestic.yml

Location et Backend

Dans Autorestic, Location décrit le contenu et la destination de la sauvegarde (from / to), tandis que Backend définit la destination de sauvegarde.

Vérification de la configuration

$ autorestic check

Everything is fine.

Exécution manuelle de la sauvegarde

Sauvegarde complète:

$ autorestic backup -a

Sauvegarde d'une Location spécifique:

$ autorestic backup -l notes

Sortie:

Cette solution répond parfaitement à mes besoins actuels et est suffisamment facile à utiliser. Je mettrai à jour cet article après l'avoir utilisée pendant un certain temps si j'ai des compléments à ajouter.

Références

Resticで重要なデータをバックアップする

2025-04-03T21:00:00+08:00

以前はかなり長い間、Cryptomatorを使ってコンテンツを管理していました。Cryptomatorの利点は、ローカルデータにアクセスするにもパスワードが必要なことです。暗号化されたコンテンツはNutstore、Dropboxなどの同期ドライブに置いておけば、ファイルを追加または変更するたびにリアルタイムでクラウドにアップロードできます。

保存するコンテンツが編集する必要のない増分ファイルで、主に追加・置換するだけなら、私はCryptomatorを試すことを強くお勧めします。電子スキャン、画像、スプレッドシートなどのリソースを保存するのに適しています。

しかし、macOSでObsidianなどのソフトウェアを使って知識ベースを管理し、頻繁に編集する必要がある場合、Cryptomatorで復号化した後のテキストファイルの編集は非常に不便です。問題を避けるために、プレーンテキストファイルを編集するときは、コピーして編集した後、元のファイルを置き換える必要がありました。これはかなり面倒です。

偶然、Resticについて知りました。ObsidianなどのノートソフトウェアのVaultを暗号化してバックアップし、クラウドドライブやS3などのクラウドプラットフォームにアップロードしたい場合、Resticが最適です。

クイックスタート

Resticのインストール

macOS

$ brew install restic

主要なオペレーティングシステムをサポートしています。詳細は：https://restic.readthedocs.io/en/latest/020_installation.html

ローカルリポジトリの初期化

リポジトリは簡単に言えば、暗号化されたファイルを保存するためのフォルダです。初期化プロセスでは、いくつかのメタデータが生成されます。

$ restic init --repo ~/Documents/NoteE2EE
enter password for new repository:
enter password again:
created restic repository 0a40262533 at /Users/xxxxx/Documents/NoteE2EE

Please note that knowledge of your password is required to access
the repository. Losing your password means that your data is
irrecoverably lost.

パスワードを覚えておいてください。一度忘れると、暗号化されたデータを復号化する方法はなくなります。

データのバックアップ

コマンドを実行して、~/Documents/Noteフォルダを~/Documents/NoteE2EEリポジトリにバックアップします。

$ restic -r ~/Documents/NoteE2EE backup ~/Documents/Note

初回実行時には、バックアップされたファイルとディレクトリの数が表示され、「スナップショット」IDがエコーされます。

コマンドは複数回実行できます（実行するたびに新しいスナップショットが作成されます）。

増分バックアップなので、スナップショットが大量のスペースを占めることを心配する必要はありません。

以下のコマンドを使用して、リポジトリ内のスナップショットリストを表示できます。

$ restic -r ~/Documents/NoteE2EE snapshots

このリポジトリフォルダ「NoteE2EE」は暗号化されたコンテンツです。3-2-1原則に従って、ローカルディスク、外部ディスク、クラウドドライブに安全に保存でき、データ漏洩を心配する必要はありません。

バックアップコマンドパラメータの最適化

$ restic -r ~/Documents/NoteE2EE backup ~/Documents/Note \
    --pack-size 32 \
    --exclude="*.tmp" \
    --iexclude="*.LOG" \
    --limit-upload 1024 \
    --json

--pack-sizeパラメータを上手く使用すると、ターゲットファイルの数を効果的に制御でき、大きなファイルが多くの小さなファイルに分割されるのを防ぎます。履歴ファイルは影響を受けず、現在の増分バックアップにのみ影響します。

--limit-uploadに対応して、ダウンロード速度を制限するための--limit-downloadパラメータもあります。

Resticをベースに小さなツールを開発する場合は、--jsonパラメータが非常に重要です。

{"message_type":"status","percent_done":0,"total_files":29,"total_bytes":204482794}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0.2808864315308279,"total_files":41,"files_done":13,"total_bytes":333776710,"bytes_done":93753349}
{"message_type":"status","percent_done":1,"total_files":41,"files_done":41,"total_bytes":333776710,"bytes_done":333776710}
{"message_type":"summary","files_new":0,"files_changed":0,"files_unmodified":41,"dirs_new":0,"dirs_changed":2,"dirs_unmodified":8,"data_blobs":0,"tree_blobs":2,"data_added":756,"data_added_packed":608,"total_files_processed":41,"total_bytes_processed":333776710,"total_duration":5.552792709,"backup_start":"2025-04-02T18:30:04.949151+08:00","backup_end":"2025-04-02T18:30:10.501995+08:00","snapshot_id":"74e465ed71f7fb5b7abb562d4cb9d067f20d89a1a9f3ed4ed32a0bc73e8abab1"}

このデータに基づいて、進捗バーを作成したり、バックアップファイルのデータ量を表示したりできます。

その他のバックエンドストレージタイプ

restic init --repo ~/Documents/NoteE2EEコマンドを使用して、ローカルリポジトリを作成しました。

以下はS3互換ストレージの例です。

# 環境変数の設定
$ export AWS_ACCESS_KEY_ID=<YOUR_ACCESS_KEY_ID>
$ export AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
$ export AWS_DEFAULT_REGION=cn-east-1

# リポジトリの初期化とバックアップ
$ restic -r s3:https://s3.bitiful.net/note-e2ee init
$ restic -r s3:https://s3.bitiful.net/note-e2ee --verbose backup ~/Documents/Note

注意：AWS_DEFAULT_REGION環境変数が設定されていない場合、デフォルトとしてus-east-1が使用されます。

Amazon S3、Backblaze B2、Google Cloudなどの他のプラットフォームとストレージについては、以下のドキュメントを参照してください：https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html

スナップショット管理

最近のスナップショットを保持する

定期的にbackupを実行してバックアップすることがありますが、バックアップが多すぎると煩わしくなります。以下のコマンドを実行すると、最新の7つのスナップショットのみを保持できます。

$ restic -r [リポジトリパス] forget --keep-last 7 --prune

スナップショットのタグ

バックアップ時に複数のタグを指定できます（--tag "v1.0" --tag "daily"）。

$ restic -r ~/Documents/NoteE2EE backup --tag "v1.0" ~/Documents/Note

既存のスナップショットのタグを変更することもできます。

# タグを追加
$ restic -r ~/Documents/NoteE2EE tag --add "important" 8c5c9d50

# タグを削除
$ restic -r ~/Documents/NoteE2EE tag --remove "important" 43547193

# 複数のタグを設定
$ restic -r ~/Documents/NoteE2EE tag --set "important,project2" a1ff1a78

注目すべきは、変更するたびにスナップショットIDが変わることです。

バックアップの整合性チェック

クラウドに保存されたバックアップは、ファイルが100％失われないことや損傷しないことを保証できません。checkコマンドを使用して検証できます。

$ restic -r ~/Documents/NoteE2EE check

ここで「損傷」をシミュレートしてみましょう。例えば、NoteE2EEディレクトリ内のdataディレクトリにあるファイルを見つけ、ファイル名を変更して、先頭にアンダースコアを追加し、ファイルの損傷/損失をシミュレートします。

checkコマンドを再度実行すると、リポジトリが異常であり、修復が必要であることが表示されます。これは予想通りです。

スナップショットを特定のディレクトリに復元する

既存のスナップショットを表示：

$ restic -r ~/Documents/NoteE2EE snapshots

特定のスナップショットをエクスポート：

$ restic -r ~/Documents/NoteE2EE restore 5fcd966f --target ~/Downloads/NoteRestore/

5fcd966fはスナップショットIDで、snapshotsコマンドで確認できます。また、NoteRestoreディレクトリが存在しない場合は自動的に作成されます。

リポジトリが大きく、特定のファイルやディレクトリのみをエクスポートしたい場合は、次のコマンドを使用します。

$ restic -r ~/Documents/NoteE2EE restore 5fcd966f --target ~/Downloads/NoteRestore/ --include Epub电子书

ここでの「--include Epub电子书」は、リポジトリのルートディレクトリにあるフォルダを指します。

「copy」を使用して「backup」の代わりに

暗号化されたリポジトリが1つしかない場合は、毎回backupを使用すれば問題ありません。しかし、3-2-1原則に従ってバックアップし、複数の暗号化リポジトリがある場合、異なるリポジトリに対して複数回backupを実行するのは効率的ではありません。

この場合、copyを使用する必要があります。これにより、データの厳密な一貫性が保証され、パフォーマンスも優れています。

$ restic init --repo ~/Documents/NoteE2EE-copy

$ restic -r ~/Documents/NoteE2EE-copy copy --from-repo ~/Documents/NoteE2EE

AIからの要約（私は良いと思います）：

複数のResticリポジトリ間でデータを同期する必要がある場合、copyは常に最適な選択です—それはリポジトリ間のプロフェッショナルな「データ移動者」のように機能し、backupは元のデータの「コレクター」のようなものです。

Restic Browserを試してみる

コマンドライン操作が好きでない場合は、このオープンソースツールを試してみることができます：emuell/restic-browser

Rust + TypeScriptで開発され、サイズは数メガバイトしかなく、読み取り専用機能しかありません。「Browser」という名前が示すように、暗号化されたリポジトリを閲覧でき、スナップショット内のファイルを探すのに便利です。

Autoresticも必要かもしれません

ドキュメント：Autorestic クイックスタート

Autorestic is a wrapper around the amazing restic. While being amazing the restic cli can be a bit overwhelming and difficult to manage if you have many different location that you want to backup to multiple locations. This utility is aimed at making this easier 🙂

Autoresticは、優れたresticツールを基に開発されたラッパーです。resticコマンドラインツール自体は素晴らしいですが、複数の異なる場所からのバックアップデータを複数のストレージターゲットに同期する必要がある場合、その操作は複雑で管理が難しくなる可能性があります。このツールは、このプロセスを簡素化し、マルチターゲットバックアップ管理をより簡単で便利にすることを目的としています。

インストール

$ brew install autorestic

設定ファイル

以下の内容で設定ファイルを作成します：

version: 2
backends:
  note_primary:
    type: local
    path: "~/Documents/NoteE2EE"
    env:
      RESTIC_PASSWORD: "your-restic-vault-password"
  note_backup:
    type: local
    path: "~/Documents/NoteE2EE-copy"
    env:
      RESTIC_PASSWORD: "your-restic-vault-password"

locations:
  notes:
    from: "~/Documents/Note"
    to:
      - note_primary
      - note_backup
    options:
      forget:
        keep-last: 7

設定ファイルのパーミッションを変更（推奨）：

$ chmod 600 ~/.autorestic.yml

LocationとBackend

Autoresticでは、Locationはバックアップのコンテンツとターゲット（from / to）を記述し、Backendはバックアップの宛先を定義します。

設定の検証

$ autorestic check

Everything is fine.

手動バックアップの実行

完全バックアップ：

$ autorestic backup -a

特定のLocationバックアップ：

$ autorestic backup -l notes

出力：

現在、このソリューションは私のニーズに完全に合っており、使いやすいです。しばらく使用した後、追加情報があれば更新します。

参考

使用 Restic 来备份重要数据

2025-04-03T21:00:00+08:00

之前使用了相当长一段时间的 Cryptomator 管理内容，它有个好处是本地数据也需要密码才能访问，加密后的内容放到坚果云、Dropbox 等同步盘，每次添加或修改文件后就可以实时上传到网盘

如果存储的内容是无需编辑的增量文件，平时也主要是增加、替换资源，那我还是很推荐试试 Cryptomator，它很适合保存电子扫描件、图像、表格文档这类资源

但在 macOS 下，如果你使用 Obsidian 等软件管理知识库，并且有频繁的编辑需求，使用 Cryptomator 解密后的文本内容编辑就很不友好，为了避免出现异常，编辑纯文本文件时，我不得不把它复制出来，编辑后再替换原有文件，这就很有些麻烦

无意间了解到 Restic，如果你想要对 Obsidian 等笔记软件的 Vault 进行加密备份、上传到网盘、S3 等云平台，那么 Restic 正适合

Quick Start

安装 Restic

macOS

$ brew install restic

支持主流操作系统，详见：https://restic.readthedocs.io/en/latest/020_installation.html

初始化本地存储库

存储库简单来说就是一个文件夹，用来存储加密后的文件，初始化的过程会生成一些元数据

$ restic init --repo ~/Documents/NoteE2EE
enter password for new repository:
enter password again:
created restic repository 0a40262533 at /Users/xxxxx/Documents/NoteE2EE

Please note that knowledge of your password is required to access
the repository. Losing your password means that your data is
irrecoverably lost.

记住密码，遗忘后加密数据将再无解密途径

备份数据

执行命令将 ~/Documents/Note 文件夹备份到 ~/Documents/NoteE2EE 存储库

$ restic -r ~/Documents/NoteE2EE backup ~/Documents/Note

首次运行可以看到它备份的文件和目录数，回显了 “snapshot” 快照的 ID

命令可以多次运行（每运行一次创建一个快照）

因为是增量创建，无需担心快照会占用过大空间

使用以下命令可以查看存储库中的快照列表

$ restic -r ~/Documents/NoteE2EE snapshots

这个存储库文件夹 “NoteE2EE” 是加密后的内容，可以根据 3-2-1 原则，安全的存放在本地硬盘、移动硬盘、网盘中，无需担心数据泄露

备份命令参数优化

$ restic -r ~/Documents/NoteE2EE backup ~/Documents/Note \
    --pack-size 32 \
    --exclude="*.tmp" \
    --iexclude="*.LOG" \
    --limit-upload 1024 \
    --json

善用 --pack-size 参数可以有效控制目标文件数量，避免大文件被拆成特别多的小文件，历史文件不会受到影响，只会影响当次增量的备份

与 --limit-upload 相对应的，有一个 --limit-download 参数，用于限制下载速度

如果基于 Restic 开发一些小工具，那么 --json 参数很有必要

{"message_type":"status","percent_done":0,"total_files":29,"total_bytes":204482794}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0,"total_files":41,"total_bytes":333776710}
{"message_type":"status","percent_done":0.2808864315308279,"total_files":41,"files_done":13,"total_bytes":333776710,"bytes_done":93753349}
{"message_type":"status","percent_done":1,"total_files":41,"files_done":41,"total_bytes":333776710,"bytes_done":333776710}
{"message_type":"summary","files_new":0,"files_changed":0,"files_unmodified":41,"dirs_new":0,"dirs_changed":2,"dirs_unmodified":8,"data_blobs":0,"tree_blobs":2,"data_added":756,"data_added_packed":608,"total_files_processed":41,"total_bytes_processed":333776710,"total_duration":5.552792709,"backup_start":"2025-04-02T18:30:04.949151+08:00","backup_end":"2025-04-02T18:30:10.501995+08:00","snapshot_id":"74e465ed71f7fb5b7abb562d4cb9d067f20d89a1a9f3ed4ed32a0bc73e8abab1"}

基于这些数据可以做进度条、展示备份文件的数据量

快照管理

保留最近的快照

我们可能定时/定期运行 backup 进行备份，但过多的备份会让人困扰，运行以下命令只保留最近的 7 个快照

$ restic -r [仓库路径] forget --keep-last 7 --prune

快照的标签

可以在备份的同时指定多个标签（--tag "v1.0" --tag "daily"）

$ restic -r ~/Documents/NoteE2EE backup --tag "v1.0" ~/Documents/Note

也可以对已存在的快照标签进行修改

# 追加标签
$ restic -r ~/Documents/NoteE2EE tag --add "important" 8c5c9d50

# 移除标签
$ restic -r ~/Documents/NoteE2EE tag --remove "important" 43547193

# 设置多个标签
$ restic -r ~/Documents/NoteE2EE tag --set "important,project2" a1ff1a78

值得注意的是，每次修改后，快照的 ID 会发生变化

备份完整性核对

存储在网盘上的备份，并不能保证文件百分百不丢失或损毁，通过 check 命令可以进行核对

$ restic -r ~/Documents/NoteE2EE check

现在人为“损坏”，例如找到 NoteE2EE 目录内 data 目录下的一个文件，修改文件名，在前方添加一个下划线，模拟文件损坏/丢失

再次运行 check 命令，提示存储库异常，需要修复，符合预期

下载快照到指定目录

查看现有快照

$ restic -r ~/Documents/NoteE2EE snapshots

导出指定快照

$ restic -r ~/Documents/NoteE2EE restore 5fcd966f --target ~/Downloads/NoteRestore/

5fcd966f 为快照 ID，通过 snapshots 命令可以查询到；另外 NoteRestore 目录如果不存在会自动创建

当你的存储库很大，只想要导出部分文件、目录，使用以下命令

$ restic -r ~/Documents/NoteE2EE restore 5fcd966f --target ~/Downloads/NoteRestore/ --include Epub电子书

其中的「--include Epub电子书」，这个目录是存储库根目录下的一个文件夹

此时使用 copy 而非 backup

如果你仅有一个加密后的存储库，那么每次备份使用 backup 即可，如果根据 3-2-1 原则备份，存在多个加密后的存储库，那么肯定不适合重复运行 backup 多次提交到不同的存储库

这时候需要使用 copy，它会保证严格数据一致性，且性能很好

$ restic init --repo ~/Documents/NoteE2EE-copy

$ restic -r ~/Documents/NoteE2EE-copy copy --from-repo ~/Documents/NoteE2EE

来自 AI 的总结（我觉着说的挺好）：

如果需要在多个Restic仓库间同步数据，copy 永远是首选——它像专业的仓库间「数据搬运工」，而 backup 则是面向原始数据的「采集器」。

不妨试试 Restic Browser

如果你不是很喜欢命令行操作，那么可以试试这个开源小工具：emuell/restic-browser

使用 Rust + TypeScript 开发，只有几兆大小，只有只读功能，正如工具名中的 “Browser”，可以浏览加密后的存储库，再从快照中翻文件的时候会方便些

可能你也需要 Autorestic

文档地址：Autorestic Quick Start

Autorestic is a wrapper around the amazing restic. While being amazing the restic cli can be a bit overwhelming and difficult to manage if you have many different location that you want to backup to multiple locations. This utility is aimed at making this easier 🙂

Autorestic 是基于卓越的 restic 工具开发的封装器。尽管 restic 命令行工具本身非常出色，但当您需要将多个不同位置的备份数据同步至多个存储目标时，其操作可能会显得复杂且难以管理。本工具旨在简化这一流程，让多目标备份管理变得更加轻松便捷。

安装

$ brew install autorestic

配置文件

创建配置文件，内容如下

version: 2
backends:
  note_primary:
    type: local
    path: "~/Documents/NoteE2EE"
    env:
      RESTIC_PASSWORD: "your-restic-vault-password"
  note_backup:
    type: local
    path: "~/Documents/NoteE2EE-copy"
    env:
      RESTIC_PASSWORD: "your-restic-vault-password"

locations:
  notes:
    from: "~/Documents/Note"
    to:
      - note_primary
      - note_backup
    options:
      forget:
        keep-last: 7

修改配置文件权限（建议）

$ chmod 600 ~/.autorestic.yml

Location 与 Backend

在 Autorestic 中，Location 描述了备份的内容和目标（from / to），Backend 定义了备份的目标

配置检验

$ autorestic check

Everything is fine.

手动执行备份

全部备份

$ autorestic backup -a

特定 Location 备份

$ autorestic backup -l notes

输出

目前这个方案很切合我的需求，且足够易用，后续使用一段时间有补充再更新

东东's Blog

Backing Up Important Data with Restic

Quick Start

Optimizing Backup Command Parameters

More Backend Storage Types

Snapshot Management

Verifying Backup Integrity

Restoring Snapshots to a Specific Directory

Using "copy" Instead of "backup"

Give Restic Browser a Try

You Might Also Need Autorestic

References

Sauvegarder des données importantes avec Restic

Quick Start

Optimisation des paramètres de sauvegarde

Plus de types de stockage (Backends)

Gestion des snapshots

Vérification de l'intégrité des sauvegardes

Restauration d'un snapshot dans un répertoire spécifique

Utiliser copy plutôt que backup

Essayez Restic Browser

Vous pourriez aussi avoir besoin d'Autorestic

Références

Resticで重要なデータをバックアップする

クイックスタート

バックアップコマンドパラメータの最適化

その他のバックエンドストレージタイプ

スナップショット管理

バックアップの整合性チェック

スナップショットを特定のディレクトリに復元する

「copy」を使用して「backup」の代わりに

Restic Browserを試してみる

Autoresticも必要かもしれません

参考

使用 Restic 来备份重要数据

Quick Start

备份命令参数优化

更多 Backends 存储类型

快照管理

备份完整性核对

下载快照到指定目录

此时使用 copy 而非 backup

不妨试试 Restic Browser

可能你也需要 Autorestic

参考