rsync

提供: ArchWiki
2022年1月29日 (土) 17:57時点におけるShota (トーク | 投稿記録)による版 (→‎cp/mv の代わりとして使う: 英語版から翻訳して追加)
ナビゲーションに移動 検索に移動

関連記事

rsync は高速な差分ファイル転送を行うオープンソースのユーティリティです。

インストール

公式リポジトリから rsyncインストールしてください。

rsync をソースマシンと転送先マシンの両方にインストールする必要があります。

フロントエンド

  • Grsync — GTK フロントエンド
http://www.opbyte.it/grsync/ || grsync
  • gutback — シェルで書かれた rsync ラッパー
https://github.com/gutenye/gutbackup || gutbackupAUR
  • JotaSync — ​スケジューラ内蔵の rsync 用 Java Swing GUI
https://trixon.se/projects/jotasync/ || jotasyncAUR
  • luckyBackup — ​C++ で書かれた Qt フロントエンド
http://luckybackup.sourceforge.net/index.html || luckybackupAUR

​その他に rsync を使っているツールは以下の通りです: rdiff-backuposyncAUR

使用方法

さらに多くのサンプルを見たい場合は、Community ContributionsGeneral Programming フォーラムを検索してください。

cp/mv の代わりとして使う

ノート: cp/mv の代わりに rsync を使う事は異なるファイルシステム間では効果的ですが、同じファイルシステム上でコピーや移動する為には効果はないです。詳しくは [1] を参照してください。

rsync は cp または mv コマンドの上位互換として使うことができ、特に大きなファイルのコピーに役立ちます:

$ rsync -P source destination

-P オプションは --partial --progress と同じで、一部ずつファイルを転送して、転送中にプログレスバーを表示します。

ディレクトリを再帰的にコピーしたいときは -r --recursive オプションを使用し、相対パス名を使いたい時は -R を使います (転送先のフォルダでフォルダ全体の階層を再生成します)。

cp と同様にローカルにコピーする事に使えるだけでなく、例えば異なるホスト間といった、リモート同士でファイルをコピーする事にも使えます。リモートの場所はホスト-コロンシンタックスを使って指示できます:

$ rsync source host:destination

あるいは

$ rsync host:source destination

ネットワークを利用したファイルのやりとりには SSH をデフォルトで使い、host は実際のホスト名かもしくは .ssh/config で定義されたプロファイルやエイリアスで指示できます。

ローカルかリモートでのファイルのやりとりに関わらず、 rsync はまず始めにファイル情報を含むファイルリストを作成します (デフォルトでは、ファイル情報はサイズと最後に修正したタイムスタンプから成ります)。このファイルリストは次にファイルを構築する必要があるか否かの判断に利用されます。それぞれのファイルを構築する際には、それぞれのブロックが長さ S バイトでオーバーラップがなくまた長さ S で分割可能なようなオフセットを持つようにブロックに分けられ、弱いチェックサムと強いチェックサムを生成します。これら情報によって、rsync はファイル全体をやりとりすることなく巨大なファイルを構築することができます。実用的かつ数学的な詳細な説明は次にあるので参照してください: rsync がどのように動作するかrsync のアルゴリズム

実用的なデフォルトの設定を手早く使いたい場合は、次の様にしてエイリアスを定義できます:

cpr() {
  rsync --archive -hh --partial --info=stats1,progress2 --modify-window=1 "$@"
} 
mvr() {
  rsync --archive -hh --partial --info=stats1,progress2 --modify-window=1 --remove-source-files "$@"
}
  • -hh: 数を読み易いフォーマット (human-readable format) で出力します
  • --info=stats1,progress2: stats1 は rsync のファイル移行の統計を verbosity level 1 で出力します。progress2 は全やりとりの進捗を出力し、progress1 はファイル毎に進捗を出力します。
  • --modify-window=1: 2つのファイルのタイムスタンプを比較する際に 1秒以下の違いがあっても同じタイムスタンプとして処理します。
  • --remove-source-files: 正常にファイルのやりとりができた後に、ソースディレクトリからファイルを削除します。
ノート: ここでの「チェックサム」は --checksum オプションでの振る舞いとは読み替えできません。--checksum オプションはファイルの転送前に使用されるファイルスキップヒューリスティックに影響します。--checksum とは無関係に、「チェックサム」は、rsync がどのようにファイルを転送するかという意味で、ブロックに基づくファイル構築に常に使われます。

​末尾のスラッシュに関する注意事項

Arch はデフォルトで GNU cp (GNU coreutils の一部) を使用します。 ただし、rsync は BSD cp の規則に従います。これは、末尾にスラッシュ 「/」 が付いたソースディレクトリに特別な処理を与えます。 しかし

$ rsync -r source destination

ディレクトリ "転送先/source" を "source" の内容で作成します。

$ rsync -r source/ destination

​は "source/" 内のすべてのファイルを "転送先" に直接コピーするが、その間にサブディレクトリは置かない。

$ rsync -r source/. destination

​この動作は GNU cp の動作とは異なります。GNU cp は "source" と "source/" を同じように扱います( "source/" ではありません)。​また、シェルによっては、タブを補完するディレクトリ名の末尾にスラッシュを自動的に付加するものもあります。​これらの要因のために、 rsync を初めて使う、あるいは時々使うユーザの間では、 rsync の異なる動作を忘れてしまい、コマンドラインの最後にあるスラッシュを忘れてしまうことで、混乱を招いたり、重要なファイルを上書きしたりする傾向があります。


したがって、rsync を呼び出す前に、ラッパースクリプトを使用して、末尾のスラッシュを自動的に削除することをお勧めします:

#!/bin/zsh
new_args=();
for i in "$@"; do
    case $i in /) i=/;; */) i=${i%/};; esac
    new_args+=$i;
done
exec rsync "${(@)new_args}"

このスクリプトをパスの通った場所に置き、シェルの init ファイル内で rsync というエイリアスが付けられます。

バックアップユーティリティとして使う

rsync プロトコルは簡単なバックアップ用途に使うことができ、最後にバックアップした時から変更が入ったファイルだけを転送します。このセクションでは rsync を使用するシンプルな定期バックアップスクリプトを説明します。基本的にリムーバブルディスクへのコピーに利用します。もっと詳しいサンプルやシステムファイルを保持するために必要なオプションは、rsync によるフルシステムバックアップを見て下さい。

自動バックアップ

このサンプルを使うには、スクリプトを /etc/cron.daily ディレクトリに作成して、インストール・設定がされている cron デーモンによって定期的にスクリプトは実行されます。cron の設定や使用方法はこの記事では割愛します。

まず、適当なコマンドオプションを含んだスクリプトを作成:

/etc/cron.daily/backup
#!/bin/bash
rsync -a --delete /folder/to/backup /location/of/backup &> /dev/null
-a 
ファイルをアーカイブする。ファイルの属性も保存 (ただし ACL やハードリンク、ケイパビリティなどの拡張属性は除外)
--delete 
バックアップ元で削除されたファイルはバックアップ先でも同じように削除する

ここで、/folder/to/backup はバックアップしたいものに (例えば /home)、/location/to/backup はバックアップの保存先に変更します (例えば /media/disk)。

最後に、スクリプトを実行可能にします:

# chmod +x /etc/cron.daily/backup

SSH を使った自動バックアップ

SSH を使ってリモートホストにバックアップする場合、以下のスクリプトを使用:

/etc/cron.daily/backup
#!/bin/bash
rsync -a --delete -e ssh /folder/to/backup remoteuser@remotehost:/location/to/backup &> /dev/null
-e ssh 
rsync に SSH を使うことを教える
remoteuser 
ホスト remotehost のユーザー
-a 
-rlptgoD オプションと同義 (recursive, links, perms, times, group, owner, devices)

NetworkManager を使った自動バックアップ

以下のスクリプトはケーブルを接続した時にバックアップを開始します。

まず、適当なコマンドオプションを含んだスクリプトを作成:

/etc/NetworkManager/dispatcher.d/backup
#!/bin/bash

if [ x"$2" = "xup" ] ; then
        rsync --force --ignore-errors -a --delete --bwlimit=2000 --files-from=files.rsync /folder/to/backup /location/to/backup
fi
-a 
-rlptgoD オプションと同義 (recursive, links, perms, times, group, owner, devices)
--files-from 
ファイルから /folder/to/backup の相対パスを読み込み
--bwlimit 
I/O 帯域を制限、キロバイト毎秒

また、書き込み権限は所有者 (root) だけに制限して下さい (詳しくは NetworkManager dispatcher を参照)。

systemd と inotify を使った自動バックアップ

ノート:
  • inotify と systemd の制限により (この質問と答え を参照)、再帰的なファイルシステムの監視は不可能です。ディレクトリとその中身を監視することはできますが、サブディレクトリにまで再帰的に実行してその中身を監視することはされません。監視するディレクトリは全て明示的に指定する必要があります (ディレクトリが既に指定した監視ディレクトリの下にあっても記述する必要がある)。
  • このセットアップは systemd/ユーザーインスタンスをベースにしています。

cron の実装など、スケジュールによって適宜バックアップを実行するのではなく、バックアップするファイルに変更があった度にバックアップを実行することが可能です。systemd.path ユニットは inotify を使ってファイルシステムを監視し、systemd.service と一緒に使うことでファイルシステムのイベントに合わせてあらゆるプロセスを開始することができます (この場合は rsync のバックアップ)。

まず、バックアップするファイルを監視する systemd.path ファイルを作成:

~/.config/systemd/user/backup.path
[Unit]
Description=Checks if paths that are currently being backed up have changed

[Path]
PathChanged=%h/documents
PathChanged=%h/music

[Install]
WantedBy=default.target

そして変更を検出した時に実行される systemd.service ファイルを作成します。デフォルトで、パスユニット (ここでは backup.path) と同じ名前の、拡張子が .path ではなく .service のサービスファイルが実行されます (ここでは backup.service)。

ノート: rsync コマンドを複数実行する必要がある場合は、Type=oneshot を使って下さい。実行する rsync ごとに、複数の ExecStart= パラメータを指定することができます。もしくは、cron スクリプトなど、バックアップ作業を全て実行するスクリプトを書いても良いでしょう。
~/.config/systemd/user/backup.service
[Unit]
Description=Backs up files

[Service]
ExecStart=/usr/bin/rsync %h/./documents %h/./music -CERrltm --delete ubuntu:

これで後は通常の systemd サービスと同じように backup.path を起動・有効化するだけです。ファイルの変更の監視を始めて backup.service を自動的に起動します:

systemctl --user start backup.path
systemctl --user enable backup.path

一週間ごとに差分バックアップ

完全なバックアップを作成して一週間ごとに差分バックアップを行う rsync のオプションです。

まず、適当なコマンドオプションを含むスクリプトを作成:

/etc/cron.daily/backup
#!/bin/bash

DAY=$(date +%A)

if [ -e /location/to/backup/incr/$DAY ] ; then
  rm -fr /location/to/backup/incr/$DAY
fi

rsync -a --delete --inplace --backup --backup-dir=/location/to/backup/incr/$DAY /folder/to/backup/ /location/to/backup/full/ &> /dev/null
--inplace 
--partial で指定先のファイルを直接更新

スナップショットバックアップ

同じアイデアを使ってファイルのスナップショットのツリーを作ることができます。言い換えれば、ファイルのコピーが含まれる日付順のディレクトリです。コピーはハードリンクで作られ、変更があったファイルだけが場所を取ります。これは Apple の TimeMachine で使われているアイデアです。

シンプルに実装したのが以下のスクリプトになります:

/usr/local/bin/rsnapshot.sh
#!/bin/bash

## my own rsync-based snapshot-style backup procedure
## (cc) marcio rps AT gmail.com

# config vars

SRC="/home/username/files/" #dont forget trailing slash!
SNAP="/snapshots/username"
OPTS="-rltgoi --delay-updates --delete --chmod=a-w"
MINCHANGES=20

# run this process with real low priority

ionice -c 3 -p $$
renice +12  -p $$

# sync

rsync $OPTS $SRC $SNAP/latest >> $SNAP/rsync.log

# check if enough has changed and if so
# make a hardlinked copy named as the date

COUNT=$( wc -l $SNAP/rsync.log|cut -d" " -f1 )
if [ $COUNT -gt $MINCHANGES ] ; then
        DATETAG=$(date +%Y-%m-%d)
        if [ ! -e $SNAP/$DATETAG ] ; then
                cp -al $SNAP/latest $SNAP/$DATETAG
                chmod u+w $SNAP/$DATETAG
                mv $SNAP/rsync.log $SNAP/$DATETAG
               chmod u-w $SNAP/$DATETAG
         fi
fi

このスクリプトを systemd のタイマーユニットから実行することで、ぐっとシンプルにできます。

システムのフルバックアップ

このセクションでは、 rsync を使用して、選択したいくつかのディレクトリを除く / ツリー全体のコピーを転送する方法について説明します。 このアプローチは、 dd を使用した ディスクのクローン よりも優れていると考えられます。これは、異なるサイズ、パーティションテーブル、およびファイルシステムを使用できるため、 cp-aを使用したコピーよりも優れているためです も同様です。これにより、ファイルのアクセス許可、属性、 アクセス制御リスト および 拡張属性 をより細かく制御できるようになります。

rsync はシステムの実行中でも機能しますが、転送中に変更されたファイルは転送される場合とされない場合があり、転送されたファイルを使用する一部のプログラムの未定義の動作を引き起こす可能性があります。

このアプローチは、既存のインストールを新しい HDD または SSD に移行する場合に適しています。

rootとして次のコマンドを実行して、rsyncがすべてのシステムファイルにアクセスし、所有権を保持できることを確認します:

# rsync -aAXHv --exclude={"/dev/*","/proc/*","/sys/*","/tmp/*","/run/*","/mnt/*","/media/*","/lost+found"} / /path/to/backup

-aAX のオプションセットを使用することにより、ファイルはアーカイブモードで転送され、シンボリックリンク、デバイス、アクセス許可、所有権、変更時間、 ACL、 および拡張属性が保持されます。 ターゲット ファイルシステム がこの機能をサポートしていると仮定します。 オプション -H はハードリンクを保持しますが、より多くのメモリを使用します。

--exclude オプションを指定すると、指定したパターンに一致するファイルが除外されます。​ディレクトリ /dev}、 /proc/sys/tmp/run は上記のコマンドに含まれますが、これらのディレクトリの 内容 は除外されます。​これは、起動時にはディレクトリが作成されますが、ディレクトリ自体は作成されないためです。​/lost+foundはファイルシステム固有です。​上記のコマンドは、 bashおよび zsh シェルの両方で使用できるブレース展開に依存します。​別の シェル を使用する場合は、 --exclude パターンを手動で繰り返す必要があります。​除外パターンを引用符で囲むと、 シェル による展開が回避されます。これは、たとえば SSH のバックアップ時に必要です。​除外パスの最後に * を指定すると、ディレクトリ自体がまだ存在しない場合でも作成されます。

ノート:
  • /mnt または /media 以外の場所でシステムをバックアップする場合は、無限ループを回避するために、除外パターンのリストにシステムを追加することを忘れないでください。
  • システムにバインドマウントがある場合は、それらも除外して、バインドマウントされたコンテンツが1回だけコピーされるようにする必要があります。

スワップファイル を使用する場合は、必ず除外してください。

  • /home/ ディレクトリをバックアップするかどうかを検討してください。 データが含まれている場合は、システムよりもかなり大きくなる可能性があります。 それ以外の場合は、 /home/*/.thumbnails/*, /home/*/.cache/mozilla/*, /home/*/.cache/chromium/*, と /home/*/.local/share/Trash/* などの重要でないサブディレクトリを除外することを検討してください。 /home/*/.local/share/Trash/* は、システムにインストールされているソフトウェアによって異なります。
  • GVFS がインストールされている場合、 rsync エラーを防ぐために、 /home/*/.gvfs を除外する必要があります。
  • Dhcpcd ≥9.0.0 がインストールされている場合は、 /var/lib/dhcpcd/* ディレクトリを除外します。これは、いくつかのシステムディレクトリをサブディレクトリとしてマウントするためです。

追加の rsync オプションを含めるか、次のようないくつかを削除することをお勧めします。 完全なリストについては、 rsync(1) を参照してください。

  • メモリが非常に少ないシステムで実行している場合は、 -H オプションを削除することを検討してください。ただし、最近のほとんどのマシンでは問題ありません。使用するソフトウェアによっては、ファイルシステムに多くのハードリンクが存在する可能性があります(たとえば、 Flatpak を使用している場合)。多くのハードリンクは /usr/ ディレクトリの下にあります。
  • これを同じバックアップディレクトリで複数回実行している場合は、rsync の --delete オプションを追加することをお勧めします。この場合、ソースパスが /* で終わっていないことを確認してください。そうでない場合、このオプションはソースディレクトリのサブディレクトリ内のファイルにのみ影響しますが、存在するファイルには影響しません。ソースディレクトリ内に直接。
  • 仮想ディスク、 Docker イメージなどのスパースファイルを使用する場合は、 -S オプションを追加する必要があります。
  • --numeric-ids オプションは、ユーザー名とグループ名のマッピングを無効にします。代わりに、数値のグループ ID とユーザー ID が転送されます。これは、 SSH を介してバックアップする場合、またはライブシステムを使用して別のシステムディスクをバックアップする場合に役立ちます。
  • -v の代わりに -info=progress2 オプションを選択すると、転送されるファイルのリストではなく、全体的な進行状況情報と転送速度が表示されます。
  • 再帰時にファイルシステムの境界を越えないようにするには、オプション -x/--one-file-system を追加します。これにより、階層内のマウントポイントをバックアップできなくなります。

バックアップを復元する

バックアップを復元する場合は、実行されたのと同じ rsync コマンドを使用しますが、ソースと宛先を逆にします。

ファイルシステムのクローニング

rsync は、ファイルシステムのメタデータを含む可能な限り多くの情報を保持しながら、ファイルシステム内のすべてのデータのコピーを実行する方法を提供します。 これは、ソースファイルシステムと宛先ファイルシステムが同じタイプである必要がないファイルシステムレベルでのデータ複製の手順です。 バックアップ、ファイルシステムの移行、またはデータ復旧に使用できます。

rsync の "アーカイブ" モードは、アクセス制御リスト、拡張属性、スパースファイルプロパティなどの特別なファイルシステムメタデータはバックアップされません。 ファイルシステムレベルでのクローンを成功させるには、いくつかのオプションを追加する必要があります。

rsync -qaHAXS SOURCE_DIR DESTINATION_DIR

それらの意味は (manpageから):

--hard-links, -H         preserve hard links
--acls, -A               preserve ACLs (implies --perms)
--xattrs, -X             preserve extended attributes
--sparse, -S             turn sequences of nulls into sparse blocks

さらに、コピーから除外するツリーの下に他のファイルシステムがマウントされている場合は、 -x を使用します。 生成されたコピーは、 diff の再帰オプションを使用して、ファイルシステムレベルで簡単に再読み取りおよびチェックできます(たとえば、データ回復の試行後)。

diff -r SOURCE_DIR DESTINATION_DIR

rsync を使用し、 新しいハードウェアに移行する で説明されているように fstabブートローダー を更新することで、ファイルシステムの移行を成功させることができます。 これは基本的に、ルートファイルシステムを別のルートファイルシステムに変換する時にも適しています。

rsync デーモン

rsync は、ポート 873 で待機しているサーバー上でデーモンとして実行できます。

​テンプレート /etc/rsyncd.conf を編集して共有を構成し、 rsyncd.serviceスタート します。

ノート: rsync 3.2.0-1 の時点で、パッケージはアップストリーム systemd ユニットファイル rsyncd.servicersyncd@.service を採用しました。 ProtectHome の変更についてコメントがあり、 [Service] セクションのセキュリティ機能 ProtectSystem=full は引き続きアクティブです。 これにより、 /boot//etc/、 および /usr/ ディレクトリが読み取り専用になります。 rsyncd 書き込みシステムディレクトリが必要な場合は、ユニットを 編集 して、オーバーライドするスニペットの [Service] セクションで ProtectSystem=off を設定できます。

クライアントからの使用

例:サーバーコンテンツの一覧表示:

$ rsync rsync://server/share

クライアントからサーバーにファイルを転送する:

$ rsync local-file rsync://server/share/

ポート 873 とユーザー認証を開くための iptables を検討してください。

ノート: ユーザー認証を含むすべての転送データは暗号化されていません。

設定例

ファイルのリストから共有する

/etc/rsyncd.conf
...

# Needed when crossing filesystem boundaries.
#use chroot  = no
read only = yes

...

[sync]
    path         = /
# List of files to copy.
    include from = /backup.list
# Exclude the rest.
    exclude      = *

ファイルリスト内では、ワイルドカード *** が使用されている場合を除き、すべての 中間パス が必要です:

/backup.list
/etc/
/etc/conf.d/
/etc/conf.d/hwclock
/etc/fonts/***

参照