Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Instruction for full restore #516

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion docs/third_party/borgmatic/third_party-borgmatic.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,36 @@ docker compose restart borgmatic-mailcow
Restoring a backup assumes you are starting off with a fresh installation of mailcow, and you currently do not have
any custom data in your maildir or your mailcow database.

### Restore All

!!! warning
Running this command will overwrite all volumes and recreate the whole mailcow system! Do not run this unless you actually
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that the part of "Running this command will overwrite all volumes" is incorrect. See #522

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thx for contribution. I will test recovery on my system. I'll let you know when I've done that.

intend to recover the mailcow system from a backup.

If you need to restore the whole mailcow system you need to start only three containers of the mailcow stack. Before running a restore you must make all volumes writeable in `docker-compose.override.yml` by removing the `ro` flag from the volume:

```
docker compose up -d mysql-mailcow borgmatic-mailcow
```

Execute following two commands, to restore the whole Mailcow Installation:

```
docker compose exec borgmatic-mailcow borgmatic extract --path mnt/source --archive latest
```
```
docker compose exec borgmatic-mailcow borgmatic restore --archive latest
```

Alternatively you can specify any archive name from the list of archives (see
[Listing all available archives](#listing-all-available-archives))

After the commands are executed successfully, you must stop the containers and restart the whole mailcow stack. The mailcow system should now be restored.

```
docker compose down && docker compose up -d
```

### Restore maildir

!!! warning
Expand Down Expand Up @@ -259,4 +289,4 @@ To fetch the keyfile run:
docker compose exec borgmatic-mailcow borg key export --paper [email protected]:mailcow
```

Where `[email protected]:mailcow` is the URI to your repository.
Where `[email protected]:mailcow` is the URI to your repository.