Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Learn about recovering GitHub Enterprise teams in Xopero ONE.
When restoring repositories, one type of metadata that can be restored is teams. Xopero ONE ensures that teams and their associated users are reinstated.
Before starting the restoration process, a prompt will inform you of this action—accepting the prompt will restore teams and send invitations as needed. Canceling the prompt will exclude teams from the restoration process.
This process may include sending invitations for users to rejoin the organization.
In this article, you will learn how to restore multiple repositories to a Git service or localhost.
Get into the restore view using the following method:
Open the GitHub tab (DevOps > GitHub), then click the Restore button next to the organization whose backup you want to restore.
You can also use the Explore button to restore your data.
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.
In the Data to restore section, you can use the switch to include or exclude 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.
Select the destination device.
Make sure the device where you want to restore data has the Xopero ONE agent installed and the Git client added to the PATH environment variable. The PATH variable is usually configured automatically after Git installation (a system restart may be required). If it isn’t, set it manually to the path of the git.exe file: C:\Program Files\Git\bin\git.exe
Select the directory where you want the data to be restored.
Additionally, in the Restore settings, you can limit bandwidth usage during the recovery process.
Support for backing up projects (classic) has been removed. It is now available only for restoring previously backed-up projects (classic) — when restored, projects (classic) are automatically converted into projects v2.
During restoration to GitHub, the Use existing projects instead of creating new ones option becomes available. When restoring projects v2, this option restores the data into the existing projects rather than creating new ones.
If the recovery destination is Azure DevOps, the Map organizations section will be replaced by Target organization and Target project settings.
Restoring never overwrites existing repositories in the organization — if you do not choose a repository name, or if you enter the name of a repository that already exists in your organization, the restore will fail. To complete the restoration successfully, you must choose a unique repository name or select the Add suffix to repo name option so the restored repository keeps its original name with an automatically generated suffix.
To restore a repository to a local device, you must have a Git client installed on that device.
You can restore only the repository (without metadata) when restoring data to local resources.
To configure the PATH variable, open the environment variables, select the PATH variable, and click the Edit button. Copy the path to the git.exe file and add it to the PATH variable.
If a repository already exists in the selected folder, you can choose to overwrite the existing data.
This article describes how to create a backup plan to back up your GitHub Enterprise repositories.
Login to XMS, open the Plans > Backup tab and click the Add plan button in the top bar.
Select GitHub from the list.
Select (or add) the GitHub Enterprise 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.
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.
Optionally, Xopero ONE allows you to protect the entire GitHub Enterprise environment.
You can have multiple workers and assign different workers to each backup plan.
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.
Xopero ONE supports backup and restore for GitHub Enterprise Cloud deployments that are separated from the main GitHub environment (for example, your-org.ghe.com). You can integrate isolated GitHub Enterprise Cloud instances as GitHub Enterprise Cloud with Data Residency.
The application requires the following permissions to log into your account:
The minimum authorization permission required for the token to register the Xopero ONE application and perform repository backup or restore is repo.
You can generate a personal access token in the Tokens tab of your GitHub Enterprise account.
With minimal privileges, certain metadata may not be included in the backup process. Select the necessary permissions based on the specific data you need to protect.
In this article, you will learn how to restore a single repository to a Git service or localhost.
Get into the restore view using the following method:
Open the GitHub tab (DevOps > GitHub), then click the Restore button next to the organization whose backup you want to restore.
You can also use the Explore button to restore your data.
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 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.
If you enter organization/name (e.g., xsupport/test), the repository will be restored with the chosen name in the specified organization. If the entered organization does not exist, the repository will be restored to the source organization.
If you enter only the repository name (e.g., test) and the source organization is registered in Xopero ONE, the repository will be restored there. If the organization is not registered, the repository will be restored to your account.
Select the destination device.
Make sure the device where you want to restore data has the Xopero ONE agent installed and the Git client added to the PATH environment variable. The PATH variable is usually configured automatically after Git installation (a system restart may be required). If it isn’t, set it manually to the path of the git.exe file: C:\Program Files\Git\bin\git.exe
Select the directory where you want the data to be restored.
Xopero ONE allows you to select specific metadata to restore — each element can be included or excluded by toggling the switch next to it. Additionally, there is a Wiki recovery option below these settings. If your repository already exists in GitHub Enterprise, you can choose to restore only the Wiki.
Support for backing up projects (classic) has been removed. It is now available only for restoring previously backed-up projects (classic) — when restored, projects (classic) are automatically converted into projects v2.
During restoration to GitHub, the Use existing projects instead of creating new ones option becomes available. When restoring projects v2, this option restores the data into the existing projects rather than creating new ones.
If the recovery destination is Azure DevOps, the Map organizations section will be replaced by Target organization and Target project settings.
Restoring never overwrites existing repositories in the organization — if you do not choose a repository name, or if you enter the name of a repository that already exists in your organization, the restore will fail. To complete the restoration successfully, you must choose a unique repository name or select the Add suffix to repo name option so the restored repository keeps its original name with an automatically generated suffix.
To restore a repository to a local device, you must have a Git client installed on that device.
You can restore only the repository (without metadata) when restoring data to local resources.
To configure the PATH variable, open the environment variables, select the PATH variable, and click the Edit button. Copy the path to the git.exe file and add it to the PATH variable.
If a repository already exists in the selected folder, you can choose to overwrite the existing data.
In this article, you will get information about all protected resources, elements and metadata in GitHub Enterprise.
Support for backing up projects (classic) has been removed. It is now available only for restoring previously backed-up projects (classic) — when restored, projects (classic) are automatically converted into projects v2.
Protected metadata for projects (classic) include cards, issues assigned to cards, pull requests assigned to cards, columns, and notes.
Learn how to integrate your GitHub Enterprise organization with Xopero ONE using a personal access token (PAT).
Integrating a GitHub Enterprise organization with Xopero ONE allows centralized backup and management of all repositories within the selected GitHub environment. Once the organization is connected, administrators can set backup schedules, apply retention policies, organize repositories into groups, and monitor synchronization status and backup times directly from the dashboard to ensure consistent protection and compliance with data security policies.
Integration with GitHub Enterprise Cloud and GitHub Enterprise Server in Xopero ONE is only possible through a personal access token (PAT).
Additionally, if a GitHub Enterprise Cloud organization with data residency includes managed users with SSO enabled, the token must be authorized. Although authorizing the token in a single organization allows Xopero ONE to retrieve all organizations, we recommend authorizing each one you intend to protect. Token authorization is also required in any organization to which you plan to restore data.
You can find more information about token authorization in the section.
The below steps demonstrate how to quickly integrate a GitHub Enterprise organization with Xopero ONE using Xopero ONE Management Service.
Open the DevOps tab on the left side of the window and select GitHub from the list.
Click Connect under the appropriate GitHub Enterprise instance type (GitHub Enterprise Server or GitHub Enterprise Cloud with Data Residency).
In Settings, enter the GitHub Enterprise service address and add or select a personal access token (PAT) from the Password Manager.
Choose whether Xopero ONE should automatically add new repositories to your backup.
Configure the repository synchronization and the default worker. Specify the synchronization start time or set a time interval for automatic updates.
Click Proceed to complete the process of adding your GitHub Enterprise organization and grant Xopero ONE access to the specified resources.
Your GitHub Enterprise organization has been successfully added to Xopero ONE. Click Custom policy to modify the backup policy settings, or click Run backup to start the backup immediately using the current policy configuration.
Xopero ONE supports backup and restore for GitHub Enterprise Cloud deployments that are separated from the main GitHub environment (for example, your-org.ghe.com). You can integrate isolated GitHub Enterprise Cloud instances as GitHub Enterprise Cloud with Data Residency.
If you already have a GitHub Enterprise organization added, click the + Add new button in the top-left corner first.
