> For the complete documentation index, see [llms.txt](https://helpcenter.gitprotect.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://helpcenter.gitprotect.io/backup-and-recovery/devops/github/backup/creating-a-backup-plan.md).

# Creating a backup plan

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

{% stepper %}
{% step %}
Login to **GitProtect Management Service**, open the **Plans** > **Backup** tab and click the <img src="/files/qBMQVDXoC7Lxera5vtkq" 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** environment you want to include in the backup process, and choose the repositories to back up.

{% hint style="warning" %}
In **GitProtect**, you can select repositories based on custom properties, but these properties **must be configured at the organization level in GitHub**. During synchronization, **GitProtect** 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 **Management Service**. For the feature to work correctly, **the token used for authorization must also include the read:org permission**.
{% endhint %}

<figure><img src="/files/nKpoMiLbqQam8Wf3Kzxh" alt=""><figcaption></figcaption></figure>

{% hint style="success" %}
Optionally, **GitProtect** allows you to protect the entire **GitHub** 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 **GitProtect worker**) allows you to perform cloud-to-cloud backups if you want to store your backups in the cloud.
{% endhint %}

<figure><img src="/files/CC7oZdGqj66XT9kNfXFy" alt=""><figcaption></figcaption></figure>
{% endstep %}

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

<figure><img src="/files/jak9or18kyGWfHGISGiu" 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="/files/jKcTXFJhl5ZoIlkAJhxv" 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="/files/g5fQzgljLBuFiU3WAxMK" 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="/pages/D9j2y4b4l51BnBsEIyA5" %}
[Cloud storage](/storage/cloud-storage.md)
{% endcontent-ref %}

{% content-ref url="/pages/9AZUD1hXe2mvU7ncAHPz" %}
[Scheduler & retention](/management/scheduler-and-retention.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://helpcenter.gitprotect.io/backup-and-recovery/devops/github/backup/creating-a-backup-plan.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.