1、Git LFS 介紹
Git 大檔案存儲(Large File Storage,簡稱LFS)目的是更好地把大型二進制檔案,比如音頻檔案、資料集、圖像和視訊等內建到 Git 的工作流中。我們知道,Git 存儲二進制效率不高,因為它會壓縮并存儲二進制檔案的所有完整版本,随着版本的不斷增長以及二進制檔案越來越多,這種存儲方案并不是最優方案。而 LFS 處理大型二進制檔案的方式是用文本指針替換它們,這些文本指針實際上是包含二進制檔案資訊的文本檔案。文本指針存儲在 Git 中,而大檔案本身通過HTTPS托管在Git LFS伺服器上。
2、環境、軟體準備
本次示範環境,我是在虛拟機Linux Centos7上操作,以下是安裝的軟體及版本:
- Docker:version 1.12.6
- Git:version 2.10.1
- GitLab: GitLab Community Edition 9.1.4
- Git-lfs: version 2.2.1
注意:GitLab 這裡我使用基于 Docker 安裝,是以需要先安裝一下 Docker,後邊示範 Git-lfs 操作,需要本地先安裝 Git,這裡 Git、GitLab、Docker 的安裝忽略,着重講一下 Git lfs。
3、Git LFS 安裝
用戶端 Git LFS 安裝步驟很簡單,有好幾種安裝方式:
1、去 Git LFS 官網下載下傳最新版安裝包安裝
$ wget https://github.com/git-lfs/git-lfs/releases/download/v2.2.1/git-lfs-darwin-amd64-2.2.1.tar.gz
$ tar -zxvf git-lfs-darwin-amd64-2.2.1.tar.gz
$ cd git-lfs-2.2.1
$ ./install.sh
2、 brew 安裝方式
$ brew install git-lfs
3、直接 git 指令安裝
$ git lfs install
注意:Git LFS用戶端版本必須 >= 1.0.1,這裡我們安裝的版本是2.2.1。
4、GitLab LFS 的配置
為了更好的服務社群,滿足版本大型檔案的需求,GitLab 宣布支援 Git LFS,現在已經包括在 GitLab.com,GitLab 社群版本和 GitLab 企業版本。但是 GitLab 對 Git LFS 支援需要滿足:
- Git LFS is supported in GitLab starting with version 8.2. (gitlab版本需要 >= 8.2)
- Git LFS must be enabled under project settings (必須在項目設定中開啟LFS)
- Users need to install Git LFS client version 1.0.1 and up (本地git lfs用戶端版本 >= 1.0.1)
4.1 配置 GitLab 是否開啟 Git LFS 以及修改預設 LFS 存儲路徑。
新版 GitLab 預設是開啟 Git LFS 支援,預設存儲路徑為:{gitlab_rails['shared_path']}/lfs-objects。若我們想關閉 Git LFS 或者修改存儲路徑的話,可以通過下邊方法修改:
1、GitLab 以 Omnibus packages 混合包安裝
修改/etc/gitlab/gitlab.rb
gitlab_rails['lfs_enabled'] = true | false
#預設位置:`/var/opt/gitlab/gitlab-rails/shared/lfs-objects`
gitlab_rails['lfs_storage_path'] = "/mnt/storage/lfs-objects"
2、GitLab 以 source 源碼安裝
修改config/gitlab.yml:
lfs:
enabled: false | true
storage_path: /mnt/storage/lfs-objects
4.2 GitLab 的 Project 設定開啟 LFS
在 GitLab 中設定項目的 LFS 開啟|關閉:project -> setting -> general -> project settings -> LFS enabled/disabled。具體設定看4.3.1中的圖。
4.3 示例操作
為了更好的示範操作,我們建立兩個項目,分别為 demo1 和 demo2 ,demo1 不開啟 LFS 支援,demo2 開啟 LFS 支援,然後我們分别進行一下操作,看看他們差別:
1、先設定項目 LFS 開啟|關閉

2、Git操作
我們先分别送出稍大一些的檔案到各個項目中
$ git clone http://[email protected]/scm/demo1.git
$ cd demo1
$ cp ~/Downloads/soft/apache-tomcat-8.0.36.zip ./
$ git add .
$ git commit -m "test no lfs"
$ git push origin master
$ git clone http://[email protected]/scm/demo2.git
$ cd demo2
$ cp ~/Downloads/soft/apache-tomcat-8.0.36.zip ./
$ git lfs track "*.zip" #設定存儲到 LFS 的檔案擴充名,這裡我設定 .zip 字尾格式的檔案
$ cat .gitattributes #自動生成的檔案,需一并送出到 Git,否則 Clone 項目的時候 Git LFS 不起作用
* .zip filter=lfs diff=lfs merge=lfs -text
$ git add .
$ git commit -m "test with lfs"
$ git push origin master
注意:我們對比下使用 LFS 和不使用 LFS 的項目操作,隻需要在想加入的大檔案時,增加檔案字尾,執行git lfs track "*.zip"·一條語句即可,并未産生額外的 Git 指令,還是很容易上手的。
然後,我們在分别 Clone 各個項目
$ git clone http://[email protected]/scm/demo1.git
Cloning into 'demo1'...
remote: Counting objects: 6, done.
remote: Compressing objects: 100% (4/4), done.
remote: Total 6 (delta 0), reused 0 (delta 0)
Unpacking objects: 100% (6/6), done.
$ git clone http://[email protected]/scm/demo2.git
Cloning into 'demo2'...
remote: Counting objects: 7, done.
remote: Compressing objects: 100% (4/4), done.
remote: Total 7 (delta 0), reused 0 (delta 0)
Unpacking objects: 100% (7/7), done.
Downloading apache-tomcat-8.0.36.zip (9.9 MB)
或者
$ git lfs clone http://[email protected]/scm/demo2.git
Cloning into 'demo2'...
remote: Counting objects: 7, done.
remote: Compressing objects: 100% (4/4), done.
remote: Total 7 (delta 0), reused 0 (delta 0)
Unpacking objects: 100% (7/7), done.
Git LFS: (1 of 1 files) 9.40 MB / 9.40 MB
- 這裡我們可以看出,使用 LFS 的項目,Clone 時會提示 Downloading … 或者 Git LFS … ,當 Push 的檔案更大一些的時候,我們會發現使用 LFS 的項目複制和提取檔案會更快一些。
- 這裡可使用git clone ...或者使用git lfs clone ...即指定該項目使用 lfs 均可,具體 git lfs 其他指令,可參考git lfs help指令。
- 開啟 LFS 的項目,當 Push 大檔案之後,在 GitLab Web 頁面上是删除不了的,需要通過接口删除該檔案。
- GitLab Git LFS Administration
- Git LFS
- Git Large File Storage