Commit bff19b6a authored by GitLab Bot's avatar GitLab Bot

Automatic merge of gitlab-org/gitlab master

parents db843c62 b7c7afa9
...@@ -14,68 +14,84 @@ GitLab can be used as a dependency proxy for a variety of common package manager ...@@ -14,68 +14,84 @@ GitLab can be used as a dependency proxy for a variety of common package manager
This is the administration documentation. If you want to learn how to use the This is the administration documentation. If you want to learn how to use the
dependency proxies, see the [user guide](../../user/packages/dependency_proxy/index.md). dependency proxies, see the [user guide](../../user/packages/dependency_proxy/index.md).
## Enabling the Dependency Proxy feature The GitLab Dependency Proxy:
NOTE: - Is turned on by default.
Dependency proxy requires the Puma web server to be enabled. - Can be turned off by an administrator.
- Requires the [Puma web server](../operations/puma.md)
to be enabled. Puma is enabled by default in GitLab 13.0 and later.
To enable the dependency proxy feature: ## Turn off the Dependency Proxy
**Omnibus GitLab installations** The Dependency Proxy is enabled by default. If you are an administrator, you
can turn off the Dependency Proxy. To turn off the Dependency Proxy, follow the instructions that
correspond to your GitLab installation:
- [Omnibus GitLab installations](#omnibus-gitlab-installations)
- [Helm chart installations](#helm-chart-installations)
- [Installations from source](#installations-from-source)
### Omnibus GitLab installations
1. Edit `/etc/gitlab/gitlab.rb` and add the following line: 1. Edit `/etc/gitlab/gitlab.rb` and add the following line:
```ruby ```ruby
gitlab_rails['dependency_proxy_enabled'] = true gitlab_rails['dependency_proxy_enabled'] = false
``` ```
1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. 1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure)
1. Enable the [Puma web server](../operations/puma.md). for the changes to take effect.
**Helm chart installations** ### Helm chart installations
1. After the installation is complete, update the global `appConfig` to enable the feature: After the installation is complete, update the global `appConfig` to turn off the Dependency Proxy:
```yaml ```yaml
global: global:
appConfig: appConfig:
dependencyProxy: dependencyProxy:
enabled: true enabled: false
bucket: gitlab-dependency-proxy bucket: gitlab-dependency-proxy
connection: {} connection: {}
secret: secret:
key: key:
``` ```
For more information, see [Configure Charts using Globals](https://docs.gitlab.com/charts/charts/globals.html#configure-appconfig-settings). For more information, see [Configure Charts using Globals](https://docs.gitlab.com/charts/charts/globals.html#configure-appconfig-settings).
**Installations from source** ### Installations from source
1. After the installation is complete, configure the `dependency_proxy` 1. After the installation is complete, configure the `dependency_proxy` section in
section in `config/gitlab.yml`. Set to `true` to enable it: `config/gitlab.yml`. Set `enabled` to `false` to turn off the Dependency Proxy:
```yaml ```yaml
dependency_proxy: dependency_proxy:
enabled: true enabled: false
``` ```
1. [Restart GitLab](../restart_gitlab.md#installations-from-source "How to restart GitLab") for the changes to take effect. 1. [Restart GitLab](../restart_gitlab.md#installations-from-source "How to restart GitLab")
for the changes to take effect.
Since Puma is already the default web server for installations from source as of GitLab 12.9, ### Multi-node GitLab installations
no further changes are needed.
**Multi-node GitLab installations** Follow the steps for [Omnibus GitLab installations](#omnibus-gitlab-installations)
for each Web and Sidekiq node.
Follow the steps for **Omnibus GitLab installation** for each Web and Sidekiq nodes. ## Turn on the Dependency Proxy
The Dependency Proxy is turned on by default, but can be turned off by an
administrator. To turn on the Dependency Proxy, follow the instructions in
[Turn off the Dependency Proxy](#turn-off-the-dependency-proxy),
but set the `enabled` fields to `true`.
## Changing the storage path ## Changing the storage path
By default, the dependency proxy files are stored locally, but you can change the default By default, the Dependency Proxy files are stored locally, but you can change the default
local location or even use object storage. local location or even use object storage.
### Changing the local storage path ### Changing the local storage path
The dependency proxy files for Omnibus GitLab installations are stored under The Dependency Proxy files for Omnibus GitLab installations are stored under
`/var/opt/gitlab/gitlab-rails/shared/dependency_proxy/` and for source `/var/opt/gitlab/gitlab-rails/shared/dependency_proxy/` and for source
installations under `shared/dependency_proxy/` (relative to the Git home directory). installations under `shared/dependency_proxy/` (relative to the Git home directory).
To change the local storage path: To change the local storage path:
...@@ -105,7 +121,7 @@ To change the local storage path: ...@@ -105,7 +121,7 @@ To change the local storage path:
### Using object storage ### Using object storage
Instead of relying on the local storage, you can use an object storage to Instead of relying on the local storage, you can use an object storage to
store the blobs of the dependency proxy. store the blobs of the Dependency Proxy.
[Read more about using object storage with GitLab](../object_storage.md). [Read more about using object storage with GitLab](../object_storage.md).
...@@ -199,5 +215,3 @@ Feature.disable(:dependency_proxy_for_private_groups) ...@@ -199,5 +215,3 @@ Feature.disable(:dependency_proxy_for_private_groups)
# Re-enable the authentication # Re-enable the authentication
Feature.enable(:dependency_proxy_for_private_groups) Feature.enable(:dependency_proxy_for_private_groups)
``` ```
The ability to disable this feature will be [removed in 13.9](https://gitlab.com/gitlab-org/gitlab/-/issues/276777).
...@@ -3,96 +3,83 @@ stage: Create ...@@ -3,96 +3,83 @@ stage: Create
group: Source Code 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 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.' description: 'This article describes how to install Git on macOS, Ubuntu Linux and Windows.'
type: howto
--- ---
# Installing Git **(FREE)** # Installing Git **(FREE)**
To begin contributing to GitLab projects, To begin contributing to GitLab projects, you must install the appropriate Git client
you must install the Git client on your computer. on your computer. Information about [installing Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
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)
is also available at the official Git website. is also available at the official Git website.
## Install Git on macOS using the Homebrew package manager ## Supported operating systems
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:
```shell Git is available for the following operating systems:
xcode-select --install
```
Click **Install** to download and install it. Alternatively, you can install - [macOS](#macos)
the entire [XCode](https://developer.apple.com/xcode/) package through the - [Ubuntu Linux](#ubuntu-linux)
macOS App Store. - [Microsoft Windows](#windows)
### Installing Homebrew ### macOS
With Xcode installed, browse to the [Homebrew website](https://brew.sh/index.html) A version of Git is supplied by macOS. You can use this version, or install the latest
for the official Homebrew installation instructions. 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. - 15 GB of available disk space for Homebrew and Xcode.
Open a terminal and enter the following command: - Extra disk space for any additional development libraries.
```shell To install Git on macOS:
brew install git
```
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 Alternatively, you can install the entire [XCode](https://developer.apple.com/xcode/)
git --version 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 ### Ubuntu Linux
it is recommended to use the built-in package manager to install Git.
Open a terminal and enter the following commands On Ubuntu and other Linux operating systems, use the built-in package manager
to install the latest Git from the official Git maintained package archives: to install Git:
```shell 1. Open a terminal and run these commands to install the latest Git
sudo apt-add-repository ppa:git-core/ppa from the officially
sudo apt-get update maintained package archives:
sudo apt-get install git
```
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 ```shell
git --version 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 <!-- ## Troubleshooting
......
...@@ -19,7 +19,8 @@ upstream image from a registry, acting as a pull-through cache. ...@@ -19,7 +19,8 @@ upstream image from a registry, acting as a pull-through cache.
## Prerequisites ## Prerequisites
- The Dependency Proxy is enabled by default but can be [turned off by an administrator](../../../administration/packages/dependency_proxy.md). To use the Dependency Proxy, it must be enabled for the GitLab instance. It's enabled by default,
but [administrators can turn it off](../../../administration/packages/dependency_proxy.md).
### Supported images and packages ### Supported images and packages
...@@ -32,13 +33,17 @@ The following images and packages are supported. ...@@ -32,13 +33,17 @@ The following images and packages are supported.
For a list of planned additions, view the For a list of planned additions, view the
[direction page](https://about.gitlab.com/direction/package/#dependency-proxy). [direction page](https://about.gitlab.com/direction/package/#dependency-proxy).
## Enable or disable the Dependency Proxy for a group ## Enable or turn off the Dependency Proxy for a group
To enable or disable the Dependency Proxy for a group: To enable or turn off the Dependency Proxy for a group:
1. Go to your group's **Settings > Packages & Registries**. 1. Go to your group's **Settings > Packages & Registries**.
1. Expand the **Dependency Proxy** section. 1. Expand the **Dependency Proxy** section.
1. To enable the proxy, turn on **Enable Proxy**. To disable it, turn the toggle off. 1. To enable the proxy, turn on **Enable Proxy**. To turn it off, turn the toggle off.
This setting only affects the Dependency Proxy for a group. Only an administrator can
[turn the Dependency Proxy on or off](../../../administration/packages/dependency_proxy.md)
for the entire GitLab instance.
## View the Dependency Proxy ## View the Dependency Proxy
......
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