diff options
Diffstat (limited to 'doc/topics/git/lfs/index.md')
| -rw-r--r-- | doc/topics/git/lfs/index.md | 36 |
1 files changed, 24 insertions, 12 deletions
diff --git a/doc/topics/git/lfs/index.md b/doc/topics/git/lfs/index.md index 4f0d1bfc5e6..5f3458821dd 100644 --- a/doc/topics/git/lfs/index.md +++ b/doc/topics/git/lfs/index.md @@ -11,25 +11,37 @@ Managing large files such as audio, video and graphics files has always been one of the shortcomings of Git. The general recommendation is to not have Git repositories larger than 1 GB to preserve performance. - +Your Git LFS client communicates with the GitLab server over HTTPS. It uses HTTP Basic authentication +to authorize client requests. After the request is authorized, Git LFS client receives +instructions on where to fetch or where to push the large file. -Files tracked by Git LFS display an icon to indicate if the file is stored as a -blob or an LFS pointer. +In the repository view, files tracked by Git LFS display an **LFS** badge next to the filename: -## How it works + -Git LFS client communicates with the GitLab server over HTTPS. It uses HTTP Basic Authentication -to authorize client requests. After the request is authorized, Git LFS client receives -instructions from where to fetch or where to push the large file. +## Configure your GitLab server for Git LFS **(FREE SELF)** + +To install Git LFS on your self-managed GitLab server, see +[GitLab Git Large File Storage (LFS) Administration](../../../administration/lfs/index.md). + +## Enable Git LFS for a project + +Prerequisites: + +- You must have at least the Developer role in the project. -## GitLab server configuration +To do this: -Documentation for GitLab instance administrators is under [LFS administration doc](../../../administration/lfs/index.md). +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > CI/CD**. +1. Expand the **Visibility, project features, permissions** section. +1. Turn on the **Git Large File Storage (LFS)** toggle. +1. Select **Save changes**. -## Prerequisites +## Install the Git LFS client locally -- Git LFS must be [enabled in project settings](../../../user/project/settings/index.md#configure-project-visibility-features-and-permissions). -- [Git LFS client](https://git-lfs.com/) version 1.0.1 or later must be installed. +Install the [Git LFS client](https://github.com/git-lfs/git-lfs) appropriate for +your operating system. GitLab requires version 1.0.1 or later of the Git LFS client. ## Known limitations |