Commit 3e1c7d99 authored by Amy Qualls's avatar Amy Qualls

Merge branch 'msj-lfs' into 'master'

Light style edits to LFS doc

See merge request gitlab-org/gitlab!84309
parents d135e85f db785f68
...@@ -10,7 +10,7 @@ disqus_identifier: 'https://docs.gitlab.com/ee/workflow/lfs/lfs/index.html' ...@@ -10,7 +10,7 @@ disqus_identifier: 'https://docs.gitlab.com/ee/workflow/lfs/lfs/index.html'
Managing large files such as audio, video and graphics files has always been one 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 of the shortcomings of Git. The general recommendation is to not have Git repositories
larger than 1GB to preserve performance. larger than 1 GB to preserve performance.
![Git LFS tracking status](img/lfs-icon.png) ![Git LFS tracking status](img/lfs-icon.png)
...@@ -19,7 +19,7 @@ blob or an LFS pointer. ...@@ -19,7 +19,7 @@ blob or an LFS pointer.
## How it works ## How it works
Git LFS client talks with the GitLab server over HTTPS. It uses HTTP Basic Authentication 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 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. instructions from where to fetch or where to push the large file.
...@@ -29,29 +29,23 @@ Documentation for GitLab instance administrators is under [LFS administration do ...@@ -29,29 +29,23 @@ Documentation for GitLab instance administrators is under [LFS administration do
## Requirements ## Requirements
- Git LFS is supported in GitLab starting with version 8.2 - Git LFS must be [enabled in project settings](../../../user/project/settings/index.md#sharing-and-permissions).
- Git LFS must be enabled under project settings - [Git LFS client](https://git-lfs.github.com) version 1.0.1 or higher must be installed.
- [Git LFS client](https://git-lfs.github.com) version 1.0.1 and up must be installed
## Known limitations ## Known limitations
- Git LFS v1 original API is not supported, because it was deprecated early in LFS - Git LFS v1 original API is not supported, because it was deprecated early in LFS
development. development.
- When SSH is set as a remote, Git LFS objects still go through HTTPS. - When SSH is set as a remote, Git LFS objects still go through HTTPS.
- Any Git LFS request asks for HTTPS credentials to be provided so a good Git - Any Git LFS request asks for HTTPS credentials, so we recommend a good Git
credentials store is recommended. credentials store.
- Git LFS always assumes HTTPS so if you have GitLab server on HTTP you must - Git LFS always assumes HTTPS so if you have GitLab server on HTTP you must
[add the URL to Git configuration manually](#troubleshooting). [add the URL to Git configuration manually](#troubleshooting).
- [Group wikis](../../../user/project/wiki/group.md) do not support Git LFS. - [Group wikis](../../../user/project/wiki/group.md) do not support Git LFS.
NOTE:
With 8.12 GitLab added LFS support to SSH. The Git LFS communication
still goes over HTTP, but now the SSH client passes the correct credentials
to the Git LFS client. No action is required by the user.
## Using Git LFS ## Using Git LFS
Lets take a look at the workflow when you need to check large files into your Git Let's take a look at the workflow when you need to check large files into your Git
repository with Git LFS. For example, if you want to upload a very large file and repository with Git LFS. For example, if you want to upload a very large file and
check it into your Git repository: check it into your Git repository:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment