GitHub Backup

Professional Repository Backup Tool

Documentation
Back to Dashboard

Documentation

Complete guide to using the GitHub Backup Tool for secure repository backups

Quick Start Guide
Get started with GitHub Backup Tool in minutes
1

Create GitHub Token

Generate a Personal Access Token at GitHub Settings with repo permissions

2

Connect to GitHub

Enter your token in the authentication section to connect your GitHub account

3

Select Repositories

Browse your repositories and select which ones to backup

4

Download Backups

Choose your preferred format and download complete repository backups

Features Overview
Comprehensive backup capabilities for your GitHub repositories

Repository Management

  • Browse all public and private repositories
  • Advanced search and filtering
  • Bulk selection and operations
  • Grid and list view modes

Backup Engine

  • Complete repository content and source code
  • Git history, branches, and file contents
  • Issues, pull requests, and releases
  • Git objects, trees, and complete metadata

Download Options

  • Multiple formats (JSON, ZIP, CSV, All Formats)
  • Customizable content selection
  • Bulk download with all formats included
  • Organized file structures with README

Security & Privacy

  • Secure token-based authentication
  • No data stored on servers
  • Private repository support
  • Local token storage only
Authentication Setup
How to create and configure your GitHub token

Creating a Personal Access Token

  1. 1
  2. 2
    Click "Generate new token" and select "Tokens (classic)"
  3. 3
    Give your token a descriptive name like "GitHub Backup Tool"
  4. 4
    Select the following scopes:
repo- Full control of private repositories
read:org- Read organization membership
user:email- Access user email addresses
  1. 5
    Click "Generate token" and copy the generated token immediately
  2. 6
    Paste the token into the GitHub Backup Tool authentication form
Download Formats
Choose the best format for your backup needs

JSON Format

Complete structured data including source code, git history, and all metadata in JSON format.

Best for:

  • • Developers who need to process backup data programmatically
  • • Integration with other tools and scripts
  • • Complete data preservation with all metadata and source code

ZIP Format

Organized files and folders with source code by branch, plus separate JSON files for metadata.

Best for:

  • • Users who want organized, browsable backup structure
  • • Archival purposes with clear file organization
  • • Accessing source code files directly

CSV Format

Spreadsheet-friendly format with repository statistics and summaries.

Best for:

  • • Analysis in Excel, Google Sheets, or other spreadsheet tools
  • • Generating reports and statistics
  • • Quick overview of repository metrics

All Formats

Complete backup package containing JSON, ZIP, and CSV formats in a single download.

Best for:

  • • Complete backup coverage with all format options
  • • Users who want maximum flexibility
  • • One-click comprehensive backup solution
  • • Bulk downloads with all formats included
Troubleshooting
Common issues and their solutions

Authentication Issues

Token Invalid or Expired

Ensure your token has the correct permissions (repo, read:org, user:email) and hasn't expired. Generate a new token if needed.

Cannot Access Private Repositories

Make sure your token includes the "repo" scope for full access to private repositories.

Backup Issues

Backup Taking Too Long

Large repositories with many issues/PRs may take longer. The system processes data in batches to avoid rate limits.

Missing Collaborators or Webhooks

These require admin permissions on the repository. If you don't have admin access, these sections will be empty.

Download Issues

Download Not Starting

Check your browser's download settings and ensure pop-ups are allowed for this site.

Large File Size

Use the "compress data" option for JSON downloads or exclude unnecessary content types to reduce file size.

Frequently Asked Questions
Answers to common questions

Is my data secure?

Yes. Your GitHub token is stored locally in your browser and only used to make API calls directly to GitHub. We don't store any of your repository data on our servers.

Can I backup private repositories?

Yes, as long as your GitHub token has the "repo" scope, you can backup both public and private repositories that you have access to.

What data is included in backups?

Backups include complete repository source code, git history, file contents across all branches, repository metadata, issues, pull requests, releases, commits, collaborators (if you have admin access), webhooks (if you have admin access), programming languages, topics, and git objects.

Is the actual code included?

Yes! The tool now backs up complete repository content including all source code files, git history, and file contents across all branches, equivalent to what you would get with git clone.

Are there any rate limits?

The tool respects GitHub's API rate limits. For authenticated requests, you get 5,000 requests per hour. Large repositories may take longer to backup due to these limits.

Can I schedule automatic backups?

Currently, the tool supports manual backups only. Automatic scheduling is planned for future releases.

API Reference
Technical details for developers

Authentication Endpoint

POST /api/github/auth

Validates GitHub token and returns user information.

Repository Listing

GET /api/github/repositories

Returns list of user's repositories with metadata.

Backup Creation

POST /api/github/backup

Starts backup process for specified repository.

Download Endpoints

GET /api/github/download/[backupId]

Downloads individual backup with customizable options.

POST /api/github/download/bulk

Creates bulk download of multiple repositories.