# Creating a backup plan

## Backup plan setup <a href="#backup_plan_creation" id="backup_plan_creation"></a>

{% stepper %}
{% step %}
Login to [**XMS**](#user-content-fn-1)[^1], open the **Plans** > **Backup** tab and click the <img src="https://319733277-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0CBTl43C3OO6ySL1DJ6k%2Fuploads%2FG60IcZIZSkSASo1Tgv0I%2Fimage.png?alt=media&#x26;token=a71e483f-b35f-4096-b430-3baf005fbf4c" alt="" data-size="original"> **Add plan** button in the top bar.
{% endstep %}

{% step %}
Select **GitHub** from the list.
{% endstep %}

{% step %}
Select (or add) the **GitHub Enterprise** environment you want to include in the backup process, and choose the repositories to back up.

{% hint style="warning" %}
In **Xopero ONE**, you can select repositories based on custom properties, but these properties **must be configured at the organization level in GitHub**. During synchronization, **Xopero ONE** retrieves the property definitions from the organization and the assigned values from the repositories. After synchronization, the panel displays a list of all properties fetched from every organization on the **GitHub** side that was added to **XMS**. For the feature to work correctly, **the token used for authorization must also include the read:org permission**.
{% endhint %}

<figure><img src="https://319733277-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0CBTl43C3OO6ySL1DJ6k%2Fuploads%2FxF7Wj5EX2a883gaRnhYG%2Fimage.png?alt=media&#x26;token=15cb8086-9520-4b83-a919-e11cedd6cfaa" alt=""><figcaption></figcaption></figure>

{% hint style="success" %}
Optionally, **Xopero ONE** allows you to protect the entire **GitHub Enterprise** environment.
{% endhint %}
{% endstep %}

{% step %}
Specify a name for the backup plan.
{% endstep %}

{% step %}
Select the appropriate metadata that you want to back up. Here, you can also change the **default worker**, which is the device directly responsible for the backup process of your repositories.

{% hint style="success" %}
You can have multiple workers and assign different workers to each backup plan.
{% endhint %}

{% hint style="info" %}
It is worth noting that the **cloud worker** (a cloud-installed **Xopero ONE** worker) allows you to perform cloud-to-cloud backups if you want to store your backups in the cloud.
{% endhint %}

<figure><img src="https://319733277-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0CBTl43C3OO6ySL1DJ6k%2Fuploads%2FSYMTV9vksqA7ietJ4Rgh%2Fimage.png?alt=media&#x26;token=f2685bce-f124-41cb-9975-e8eb2b722e78" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Select one of the locations assigned to your **Xopero ONE** instance as storage.

<figure><img src="https://319733277-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0CBTl43C3OO6ySL1DJ6k%2Fuploads%2FhATeIpLGTmMYFtosDBbe%2Fimage.png?alt=media&#x26;token=2b34310d-9818-4149-9a6d-538cc9cb5b0a" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Customize the scheduler and specify how long your data should be retained. If needed, adjust the advanced settings to suit your needs.

<figure><img src="https://319733277-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0CBTl43C3OO6ySL1DJ6k%2Fuploads%2FWBzkgKREflmuntsVfbU3%2Fimage.png?alt=media&#x26;token=c39f8da0-e6fe-4dfe-beef-f29a8db5b711" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
If necessary, adjust the advanced settings such as encryption, error handling, or bandwidth limits to fit your requirements.

<figure><img src="https://319733277-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0CBTl43C3OO6ySL1DJ6k%2Fuploads%2FfOf8At5ni1Ehp82IYM36%2Fimage.png?alt=media&#x26;token=55316ef1-25a9-40f8-ac28-d524ca7e0213" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Double-check your data and click **Save** to create the backup plan.
{% endstep %}
{% endstepper %}

***

## Useful links and items

{% content-ref url="../../../../storage/cloud-storage" %}
[cloud-storage](https://helpcenter.xopero.com/xopero-one-en/storage/cloud-storage)
{% endcontent-ref %}

{% content-ref url="../../../../deployment-and-configuration/xopero-one-worker" %}
[xopero-one-worker](https://helpcenter.xopero.com/xopero-one-en/deployment-and-configuration/xopero-one-worker)
{% endcontent-ref %}

{% content-ref url="../../../../management/scheduler-and-retention" %}
[scheduler-and-retention](https://helpcenter.xopero.com/xopero-one-en/management/scheduler-and-retention)
{% endcontent-ref %}

[^1]: Xopero ONE Management Service


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://helpcenter.xopero.com/xopero-one-en/backup-and-recovery/devops/github-enterprise/backup/creating-a-backup-plan.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
