Installation

Installation

This page covers installing GitBack and verifying that your environment is ready for backups.

Requirements

GitBack relies on standard system tools.

Required:

• Git
• tar
• zstd

Verify that all required tools are available:

gitback doctor

Example:

[OK]   config.yaml
[OK]   github.token
[OK]   git
[OK]   tar
[OK]   zstd
[OK]   mirror directory
[OK]   snapshot directory
[OK]   state directory
[OK]   log file writable
[OK]   github authentication

Install Using Go

Install the latest release:

go install github.com/flarexes/gitback/cmd/gitback@latest

Verify installation:

gitback --help

Build From Source

Clone the repository:

git clone https://github.com/FlareXes/gitback.git

Enter the project directory:

cd gitback

Build:

go build -o gitback ./cmd/gitback

Optional:

sudo mv gitback /usr/local/bin/

Verify installation:

gitback --help

GitHub Authentication

GitBack requires a GitHub Personal Access Token to discover repositories and Gists.

Both token types are supported:

• Classic Personal Access Token (PAT)
• Fine-Grained Personal Access Token (FGPAT)

Classic PAT

Required scope:

repo

Fine-Grained PAT

Repository access:

All repositories

Permissions:

Contents: Read-only
Metadata: Read-only

Initialize GitBack

Create the initial configuration and validate authentication:

gitback init

The initialization process:

• Creates configuration files
• Stores the GitHub token
• Verifies GitHub API access
• Creates required directories

Verify Environment

Run:

gitback doctor

before your first backup.

Next Step

Continue with:

Getting Started

This guide walks through creating your first backup and snapshot.