# World Backups

## Getting started

Before creating any backups, ensure that the [`backups`](https://buildsystem.eintosti.de/config#backup) section in the `config.yml` file is properly configured.

## Creating a backup

### Automatically

When enabled in the config, backups are automatically created in the defined interval.\
If `backup.auto-backup.only-active-worlds` is set to `true`, the time until a backup will be only created is only incremented as long as a builder (i.e. player who can modify the world) is present in the world.

### Manually

Players with the permission `buildsystem.backup.create` can manually create a backup of the world they are in using `/worlds backup create`.

## Viewing backups

Creators of a world (or players with the `buildsystem.admin` bypass permission) can view the backups of the world they are in using `/worlds backup`. Additionally, they will need the permission: `buildsystem.backup`.

<figure><img src="https://497964470-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV2RuUggaaq5upHxVqTiN%2Fuploads%2Fqc9wZrjD8dd95CjE1XVC%2F460225069-36ac7c5e-d0d8-4ef8-a419-1aad3389ae03.png?alt=media&#x26;token=69b437cf-8d7f-4348-b34e-83f0e953be28" alt="" width="375"><figcaption></figcaption></figure>

Each backup item's name will have the date and time at which it is was created.

## Restoring a backup

{% hint style="danger" %}
Restoring a backup of the server's main world (often `world`) can lead to issues and is not advised. If you decide to do so, make sure to restart the server immediately after.
{% endhint %}

To restore a world to a backup, simply click on the desired backup within the backups overview. You will then be prompted to confirm the action since it cannot be reverted.

<figure><img src="https://497964470-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FV2RuUggaaq5upHxVqTiN%2Fuploads%2Fje2DPskLhmGIhSDBtjYJ%2F459605232-766bd063-0028-4382-bc74-158c12f26711.png?alt=media&#x26;token=32e8c171-0439-48cc-9f2e-a01b28dfab78" alt="" width="375"><figcaption></figcaption></figure>