> For AI agents: the complete documentation index is available at /resource/ucidm/docs/on-premise/1.8.0/llms.txt, the full documentation bundle is available at /resource/ucidm/docs/on-premise/1.8.0/llms-full.txt.

# リストア \{#restore}

`/opt/osstech/bin/ucidm-backup` にて取得したバックアップファイルをもとに、リストアする手順を示します。

## リストア手順 \{#restore-operation}

リストアスクリプト内で `docker` コマンドを実行します。
環境に応じて `docker` コマンドが実行可能なユーザーで作業してください。

バックアップファイルに含まれる以下のデータをリストアします。

- mongodb のドキュメントデータ
- rabbitmq の queue 一覧
- ucidm ホームディレクトリ配下のファイル群

`Apache` の設定ファイルはリストアされませんので、別途再配置を行ってください。

### 事前準備 \{#restore-pre-operation}

リストアコマンドを実行する前にいくつかの事前作業を行う必要があります。

#### ucidmパッケージのインストール \{#restore-pre-operation-install}

リストアコマンドを行う際は `osstech-ucidm` パッケージがインストール済みである必要があります。

[インストール](/resource/ucidm/docs/on-premise/1.8.0/install/index.md) の項を参照して、パッケージをインストールしてください。

[コンテナレジストリへアクセス設定](/resource/ucidm/docs/on-premise/1.8.0/configuration/compose.md) の項を参照して、 アクセス設定を行ってください。

### コマンド実行 \{#restore-exec}

`/opt/osstech/bin/ucidm-restore` コマンドを実行し、リストアを行ってください。

```
$ /opt/osstech/bin/ucidm-restore ucidm-backup-20241127173235.tar.zst

```

`done restore at <実行日時情報>` という出力があれば、
リストアは正常に完了しています。

### コンテナ起動 \{#container-restart}

リストア後コンテナを起動し、リストアが正常に行われたことを確認してください。

```
$ docker compose --file /var/opt/osstech/lib/ucidm/compose.yml up -d
```