diff options
Diffstat (limited to 'doc/topics/git')
| -rw-r--r-- | doc/topics/git/how_to_install_git/index.md | 111 | ||||
| -rw-r--r-- | doc/topics/git/lfs/index.md | 12 | ||||
| -rw-r--r-- | doc/topics/git/troubleshooting_git.md | 9 |
3 files changed, 61 insertions, 71 deletions
diff --git a/doc/topics/git/how_to_install_git/index.md b/doc/topics/git/how_to_install_git/index.md index fc9c0e0ec63..422919ea46c 100644 --- a/doc/topics/git/how_to_install_git/index.md +++ b/doc/topics/git/how_to_install_git/index.md @@ -3,96 +3,83 @@ stage: Create group: Source Code info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments description: 'This article describes how to install Git on macOS, Ubuntu Linux and Windows.' -type: howto --- # Installing Git **(FREE)** -To begin contributing to GitLab projects, -you must install the Git client on your computer. - -This article shows you how to install Git on macOS, Ubuntu Linux and Windows. - -Information on [installing Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) +To begin contributing to GitLab projects, you must install the appropriate Git client +on your computer. Information about [installing Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) is also available at the official Git website. -## Install Git on macOS using the Homebrew package manager - -Although you can use the version of Git shipped with macOS or install the latest -version of Git on macOS by downloading it from the project website, we recommend -installing Git with Homebrew to get access to an extensive selection of -dependency-managed libraries and applications. - -If you don't need access to any additional development libraries or don't have -approximately 15 GB of available disk space for Xcode and Homebrew, use one of -the previously mentioned methods. - -### Installing Xcode - -To build dependencies, Homebrew needs the XCode Command Line Tools. Install -it by running in your terminal: +## Supported operating systems -```shell -xcode-select --install -``` +Git is available for the following operating systems: -Click **Install** to download and install it. Alternatively, you can install -the entire [XCode](https://developer.apple.com/xcode/) package through the -macOS App Store. +- [macOS](#macos) +- [Ubuntu Linux](#ubuntu-linux) +- [Microsoft Windows](#windows) -### Installing Homebrew +### macOS -With Xcode installed, browse to the [Homebrew website](https://brew.sh/index.html) -for the official Homebrew installation instructions. +A version of Git is supplied by macOS. You can use this version, or install the latest +version of Git on macOS by downloading it from the project website. We recommend +installing Git with [Homebrew](https://brew.sh/index.html). With Homebrew, you can +access an extensive selection of libraries and applications, with their dependencies +managed for you. -### Installing Git via Homebrew +Prerequisites: -With Homebrew installed, you are now ready to install Git. -Open a terminal and enter the following command: +- 15 GB of available disk space for Homebrew and Xcode. +- Extra disk space for any additional development libraries. -```shell -brew install git -``` +To install Git on macOS: -Congratulations! You should now have Git installed via Homebrew. +1. Open a terminal and install the XCode Command Line Tools: -To verify that Git works on your system, run: + ```shell + xcode-select --install + ``` -```shell -git --version -``` + Alternatively, you can install the entire [XCode](https://developer.apple.com/xcode/) + package through the macOS App Store. -Next, read our article on [adding an SSH key to GitLab](../../../ssh/index.md). +1. Select **Install** to download and install XCode Command Line Tools. +1. Install Homebrew according to the [official Homebrew installation instructions](https://brew.sh/index.html). +1. Install Git by running `brew install git` from your terminal. +1. In a terminal, verify that Git works on your computer: -## Install Git on Ubuntu Linux + ```shell + git --version + ``` -On Ubuntu and other Linux operating systems -it is recommended to use the built-in package manager to install Git. +### Ubuntu Linux -Open a terminal and enter the following commands -to install the latest Git from the official Git maintained package archives: +On Ubuntu and other Linux operating systems, use the built-in package manager +to install Git: -```shell -sudo apt-add-repository ppa:git-core/ppa -sudo apt-get update -sudo apt-get install git -``` +1. Open a terminal and run these commands to install the latest Git +from the officially + maintained package archives: -Congratulations! You should now have Git installed via the Ubuntu package manager. + ```shell + sudo apt-add-repository ppa:git-core/ppa + sudo apt-get update + sudo apt-get install git + ``` -To verify that Git works on your system, run: +1. To verify that Git works on your computer, run: -```shell -git --version -``` + ```shell + git --version + ``` -Next, read our article on [adding an SSH key to GitLab](../../../ssh/index.md). +### Windows -## Installing Git on Windows from the Git website +Go to the [Git website](https://git-scm.com/), and then download and install Git for Windows. -Open the [Git website](https://git-scm.com/) and download and install Git for Windows. +## After you install Git -Next, read our article on [adding an SSH key to GitLab](../../../ssh/index.md). +After you successfully install Git on your computer, read about [adding an SSH key to GitLab](../../../ssh/index.md). <!-- ## Troubleshooting diff --git a/doc/topics/git/lfs/index.md b/doc/topics/git/lfs/index.md index 0fe38e25df5..a94caf2bf33 100644 --- a/doc/topics/git/lfs/index.md +++ b/doc/topics/git/lfs/index.md @@ -99,7 +99,7 @@ and are not pushed to the remote repository. ### Migrate an existing repository to Git LFS -Read the documentation on how to [migrate an existing Git repository with Git LFS](migrate_to_git_lfs.md). +Read the documentation on how to [migrate an existing Git repository with Git LFS](https://github.com/git-lfs/git-lfs/blob/main/docs/man/git-lfs-migrate.1.ronn). ### Removing objects from LFS @@ -114,13 +114,9 @@ See the documentation on [File Locking](../../../user/project/file_lock.md). ## LFS objects in project archives -> - Support for including Git LFS blobs inside [project source downloads](../../../user/project/repository/index.md) was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15079) in GitLab 13.5. -> - [Enabled by default](https://gitlab.com/gitlab-org/gitlab/-/issues/268409) in GitLab 13.6. -> - Enabled on GitLab.com. -> - Recommended for production use. - -WARNING: -This feature might not be available to you. Check the **version history** note above for details. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15079) support for including Git LFS blobs inside [project source downloads](../../../user/project/repository/index.md) in GitLab 13.5 [with a flag](../../../administration/feature_flags.md) named `include_lfs_blobs_in_archive`. Disabled by default. +> - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/46572) in GitLab 13.6. +> - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62539) in GitLab 14.0. Feature flag `include_lfs_blobs_in_archive` removed. Prior to GitLab 13.5, [project source downloads](../../../user/project/repository/index.md) would include Git diff --git a/doc/topics/git/troubleshooting_git.md b/doc/topics/git/troubleshooting_git.md index ae1667376b0..f881826e74a 100644 --- a/doc/topics/git/troubleshooting_git.md +++ b/doc/topics/git/troubleshooting_git.md @@ -45,7 +45,7 @@ set to 50MB. The default is 1MB. **If pushing over SSH**, first check your SSH configuration as 'Broken pipe' errors can sometimes be caused by underlying issues with SSH (such as authentication). Make sure that SSH is correctly configured by following the -instructions in the [SSH troubleshooting](../../ssh/index.md#troubleshooting-ssh-connections) documentation. +instructions in the [SSH troubleshooting](../../ssh/index.md#password-prompt-with-git-clone) documentation. If you're a GitLab administrator with server access, you can also prevent session timeouts by configuring SSH `keep-alive` on the client or the server. @@ -110,6 +110,13 @@ ssh_exchange_identification: Connection closed by remote host fatal: The remote end hung up unexpectedly ``` +or + +```plaintext +kex_exchange_identification: Connection closed by remote host +Connection closed by x.x.x.x port 22 +``` + This error usually indicates that SSH daemon's `MaxStartups` value is throttling SSH connections. This setting specifies the maximum number of concurrent, unauthenticated connections to the SSH daemon. This affects users with proper authentication |