1 of 14

GitLab

Integration

Required permissions

Account

To log in to your account, Xopero ONE requires the following permissions:

Access the authenticated user’s API — Xopero needs read and write access to the API, including:
1. All groups and projects.
2. The container registry.
3. The package registry.

The following permissions are the minimum needed to register the Xopero ONE application in your account and access repositories:

read_api
read_repository

By creating Personal Access Token, you can assign various types of permissions. Below is a list of permissions that will allow you to backup the repository metadata you are interested in in your organization.

read_api - Read permission required to assign an organization to GitLab.

api - Grants complete read/write access to the API, including all groups and projects.

read_repository - it is required to access the list of repositories and to be able to back them up.

write_repository - it is required to access to restore repository.

read_registry - grants read access to a Container Registry images if a project is private and authorization is required.

By creating a personal access token, you can assign different types of permissions. The following permissions allow you to back up the repository metadata in your organization:

read_api — required to assign an organization to GitLab.
api — grants full read/write access to the API, including all groups and projects.
read_repository — required to access the list of repositories and perform backups.
write_repository — required to restore a repository.

Rate limits

Rate limits are implemented to ensure the stability and security of the system, as excessive requests could overload or destabilize the application. For detailed information on GitLab rate limits, refer to .

Adding GitLab (cloud) organization to Xopero ONE

This article explains how to add a GitLab (cloud) organization to the Xopero ONE platform to protect repositories or restore existing backups.

Using OAuth

Click the Connect button under GitLab.

, log in with a user account which has the required permissions for the repositories or projects to protect. If your GitLab login session is active in a different tab, the login will complete automatically.

Grant Xopero ONE access to the specified resources (when prompted).

Your GitLab organization has now been successfully added to Xopero ONE. Click Custom policy to adjust your backup policy settings, or click Run backup to execute the backup immediately using the current policy configuration.

Click the advanced mode link under GitLab and GitLab Self-managed tiles.

When adding an organization, you may be prompted to grant additional permissions to the Xopero ONE application— make sure your browser allows Xopero to open pop-up windows.

Depending on your browser, you can either adjust the settings to allow pop-ups or permit the authorization window to open once.

Adding GitLab (self-managed) organization to Xopero ONE

This article explains how to add a GitLab (self-managed) organization to Xopero ONE.

Using Personal Access Token (PAT)

Click the Connect button under GitLab Self-managed.

Set your authentication method.

In Authentication, select GitLab Self-Managed.
In Settings, enter your GitLab service IP address.
Add or select PAT from the Password Manager.
Choose whether Xopero should automatically add new repositories to your backup and whether it should include GitLab groups in the backup.

Configure your repository sync and default worker. Specify hours for synchronization, or set a time interval for automatic updates.

Click Proceed to complete adding your GitLab (self-managed) organization and grant Xopero ONE access to the specified resources.

Backup

Protected resources

This article provides information about protected resources, elements, and metadata in GitLab cloud and GitLab self-managed.

Creating a backup plan

This article contains information on how to set up a GitLab repository backup plan.

Backup plan setup

Select GitLab from the list, and then click Repos and metadata in the next aside.

Select (or add) the GitLab environment you want to include in the backup process, and choose the repositories to back up.

Specify a name for the backup plan.

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.

Select one of the locations assigned to your Xopero ONE instance as storage.

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

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

Double-check your data and click Save to create the backup plan.

Creating a backup plan for a group

In this article, you will find information about GitLab group backup in Xopero ONE.

Backup plan setup

Select GitLab from the list, and then click Groups in the next aside.

Add or select the GitLab groups you want to add to your plan.

Specify a name for the backup plan.

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.

Select one of the locations assigned to your Xopero ONE instance as storage.

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

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

Double-check your data and click Save to create the backup plan.

Recovery

Single repository recovery

In this article, you will find information on how to restore a single repository to a Git service or localhost.

Recovery process

Get into the restore view using one of the following methods:

Method 1:

Open the GitLab tab (DevOps > GitLab), then click the Manage & Restore button next to the organization whose backup you want to restore.
Search for the repository you want to restore, and click the Restore button in the action menu of that repository.

Open the Storages tab, and click the browse storage button in the storage action menu.

Click the Device section — you will then see all repositories that have been backed up and sent to the selected storage. Select one of the available repositories to proceed.

Next, select the backup plan from which you want to restore data. Click View available plans and choose one of the plans from the list.

Choose the backup version from all the backups that have already been performed — select the desired date and click the Restore button.

Select the destination for the restore process. You can choose one of the assigned organizations from any Git service or any device. After selecting the repository and the metadata you want to include, click the Restore selected or Restore all button to proceed.

In the next aside, click Edit next to Data to restore if you need to adjust it.

Next, select the destination where you want to restore the data.

In Map organizations section, select the target organization to which the repository will be restored.

In Restore settings you can set a custom name for the repository that will be created during the restore process and limit the internet bandwidth.

You can enter a new repository name in one of the following formats:

In Device used to restore the data section, choose the device that will be responsible for performing the restoration.

After defining all parameters, click the Start now button to begin the restore process. When the process is complete, a new repository will be created in your organization account.

Recovering multiple repositories

In this article, you will learn how to restore multiple repositories to a Git service or localhost.

Recovery process

Get into the restore view using the following method:

Open the GitLab tab (DevOps > GitLab), then click the Manage & Restore button next to the organization whose backup you want to restore.
Select the repositories you want to restore and click the Restore selected button in the top menu.

By clicking an individual repository, an aside will appear where you can select a backup plan and a backup version to restore. Click Select under your chosen backup copies to continue.

Select the destination for the restore process. You can choose one of the assigned organizations from any Git service or any device.

Choose whether to include metadata in the backup.

Next, select the destination where you want to restore the data.

In Map organizations section, select the target organizations where the repositories will be restored.

In the Restore settings, you can configure the following options:

When you toggle Restoring repos with custom name switch, a window will appear allowing you to rename one or more repositories.

In Device used to restore the data section, choose the device that will be responsible for performing the restoration.

After defining all parameters, click the Start now button to begin the restore process. When the process is complete, new repositories will be created in your organization account.

Recovering groups

In this article, you will learn how to restore data from a GitLab group backup.

Recovery process

Get into the restore view using the following method:

Open the GitLab tab (DevOps > GitLab), then click the Groups button next to the organization whose backup you want to restore.

Search for the repository you want to restore, and click the Restore button in the action menu of that repository.

Next, select the backup plan from which you want to restore data. Click AVAILABLE PLANS and choose one of the plans from the list.

Choose the backup version from all the backups that have already been performed — select the desired date and click the Restore button.

Choose the data you want to restore, or use the default settings.

In the next aside, click Edit next to Data to restore if you need to adjust it.

Next, select the destination where you want to restore the data.

In Restore settings you can set a custom name for the repository that will be created during the restore process and limit the internet bandwidth.

In Device used to restore the data section, choose the device that will be responsible for performing the restoration.

After defining all parameters, click the Start now button to begin the restore process. When the process is complete, a new repository will be created in your organization account.

GitLab

Integration

Required permissions

Account

Rate limits

Adding GitLab (cloud) organization to Xopero ONE

Using OAuth

Adding GitLab (self-managed) organization to Xopero ONE

Using Personal Access Token (PAT)

Backup

Protected resources

Creating a backup plan

Backup plan setup

Creating a backup plan for a group

Backup plan setup

Recovery

Single repository recovery

Recovery process

Method 1:

Recovering multiple repositories

Recovery process

Recovering groups

Recovery process

Adding GitLab (self-managed) organization to Xopero ONE

Using Personal Access Token (PAT)

Required permissions

Account

Protected resources

Personal Access Token (PAT)

GitLab Protected Data

GitLab Groups Protected Data

Recovering multiple repositories

Recovery process

A. Restore to a Git organization

B. Restore to a device

Useful links and items

Rate limits

Creating a backup plan

Backup plan setup

Useful links and items

Recovering groups

Recovery process

Single repository recovery

Recovery process

Method 1:

Method 2:

A. Restore to a Git organization

Useful links and items

B. Restore to a device

Recovery

Integration

Adding GitLab (cloud) organization to Xopero ONE

Using OAuth

Using OAuth (Advanced Mode)

Using Personal Access Token (PAT)

Additional browser permissions

Creating a backup plan for a group

Backup plan setup

Useful links and items

Backup

GitLab