# gitlab-backup-script

**Repository Path**: donhui/gitlab-backup-script

## Basic Information

- **Project Name**: gitlab-backup-script
- **Description**: gitlab 仓库备份脚本（有备无患，方能安心）
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 7
- **Forks**: 4
- **Created**: 2020-03-16
- **Last Updated**: 2025-08-04

## Categories & Tags

**Categories**: vcs

**Tags**: None

## README

# 缘由（Why?）
gitlab仓库备份一般通过rsync的方式，将仓库数据同步到其他机器

但是，如果仓库损坏的，同步到备机上的也是损坏的

甚至，如果仓库被误删的话，备机上的也会被同步删掉

所以才有了这个项目，专门用来备份git仓库，无惧仓库损坏或被误删～

# gitlab-backup使用说明

通过使用python-gitlab调用gitlab API遍历repositories对其进行备份。  

如果git repository在本地存在则进行git fetch，反之则进行git clone。

1. 安装依赖
> ```
> pip install -r requirements.txt
> 注意：
> - python版本应为2.7(python-gitlab不兼容python2.6)；建议将其加入到环境变量中
> - 根据需要有可能需要安装setuptools、pip
> ```

2. 修改自定义配置
> ```
> 修改settings.py中的配置（gitlab相关配置、是否允许邮件通知、smtp相关配置）
> 注意：
> - gitlab的用户必须是管理员
> - 机器本地的`ssh key`需要添加到gitlab管理员账号下，以便可以使用ssh协议clone/fetch仓库代码
> ```

3. 运行脚本
> ```
> python gitlab-backup.py
> ```

4. 建议
> ```
> 建议将备份任务放到crontab定时任务中
> - 01 02 * * * . $HOME/.bash_profile;/usr/bin/python /data/gitlab-backup/gitlab-backup.py>/var/log/gitlab-backup.log 2>&1
> - git环境变量应追加到.bash_profile文件中的PATH中
> ```