summaryrefslogtreecommitdiff
path: root/doc/install
diff options
context:
space:
mode:
Diffstat (limited to 'doc/install')
-rw-r--r--doc/install/aws/eks_clusters_aws.md2
-rw-r--r--doc/install/aws/gitlab_hybrid_on_aws.md2
-rw-r--r--doc/install/aws/gitlab_sre_for_aws.md1
-rw-r--r--doc/install/aws/index.md3
-rw-r--r--doc/install/aws/manual_install_aws.md16
-rw-r--r--doc/install/azure/index.md2
-rw-r--r--doc/install/cloud_providers.md17
-rw-r--r--doc/install/docker.md39
-rw-r--r--doc/install/google_cloud_platform/index.md2
-rw-r--r--doc/install/index.md14
-rw-r--r--doc/install/install_methods.md16
-rw-r--r--doc/install/installation.md96
-rw-r--r--doc/install/next_steps.md2
-rw-r--r--doc/install/openshift_and_gitlab/index.md2
-rw-r--r--doc/install/requirements.md7
15 files changed, 142 insertions, 79 deletions
diff --git a/doc/install/aws/eks_clusters_aws.md b/doc/install/aws/eks_clusters_aws.md
index 191d0f93382..ccbc0752975 100644
--- a/doc/install/aws/eks_clusters_aws.md
+++ b/doc/install/aws/eks_clusters_aws.md
@@ -23,7 +23,7 @@ Using `eksctl` enables the following when building an EKS Cluster:
- You have various cluster configuration options:
- Selection of operating system: Amazon Linux 2, Windows, Bottlerocket
- Selection of Hardware Architecture: x86, ARM, GPU
- - Selection of Kubernetes version (the GitLab-managed clusters for your project's applications have [specific Kubernetes version requirements](../../user/clusters/agent/index.md#supported-cluster-versions))
+ - Selection of Kubernetes version (the GitLab-managed clusters for your project's applications have [specific Kubernetes version requirements](../../user/clusters/agent/index.md#gitlab-agent-for-kubernetes-supported-cluster-versions))
- It can deploy high value-add items to the cluster, including:
- A bastion host to keep the cluster endpoint private and possible perform performance testing.
- Prometheus and Grafana for monitoring.
diff --git a/doc/install/aws/gitlab_hybrid_on_aws.md b/doc/install/aws/gitlab_hybrid_on_aws.md
index b8c840782b1..e4eb0117410 100644
--- a/doc/install/aws/gitlab_hybrid_on_aws.md
+++ b/doc/install/aws/gitlab_hybrid_on_aws.md
@@ -48,7 +48,7 @@ The Beta version deploys Aurora PostgreSQL, but the release version will deploy
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| Overview and Vision | [AWS Quick Start](https://aws.amazon.com/solutions/implementations/amazon-eks/) | [GitLab Environment Toolkit](https://gitlab.com/gitlab-org/gitlab-environment-toolkit/-/blob/main/README.md) |
| Licensing | [Open Source (Apache 2.0)](https://github.com/aws-quickstart/quickstart-eks-gitlab/blob/main/LICENSE.txt) | [GitLab Enterprise Edition license](https://gitlab.com/gitlab-org/gitlab-environment-toolkit/-/blob/main/LICENSE) ([GitLab Premium tier](https://gitlab.com/gitlab-org/gitlab-environment-toolkit/-/blob/main/README.md)) |
-| GitLab Support | [GitLab Beta Support](../../policy/alpha-beta-support.md#beta-features) | [GitLab GA Support](../../policy/alpha-beta-support.md#generally-available-ga) |
+| GitLab Support | [GitLab Beta Support](../../policy/alpha-beta-support.md#beta) | [GitLab GA Support](../../policy/alpha-beta-support.md#generally-available-ga) |
| GitLab Reference Architecture Compliant | Yes | Yes |
| GitLab Performance Tool (GPT) Tested | Yes | Yes |
| Amazon Well Architected Compliant | Yes<br />(via Quick Start program) | Critical portions <br />reviewed by AWS |
diff --git a/doc/install/aws/gitlab_sre_for_aws.md b/doc/install/aws/gitlab_sre_for_aws.md
index e68aea00b36..f957dfa8a65 100644
--- a/doc/install/aws/gitlab_sre_for_aws.md
+++ b/doc/install/aws/gitlab_sre_for_aws.md
@@ -2,7 +2,6 @@
stage: Systems
group: Distribution
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
-comments: false
description: Doing SRE for GitLab instances and runners on AWS.
---
diff --git a/doc/install/aws/index.md b/doc/install/aws/index.md
index 99ba05925a5..4dcf2ce0927 100644
--- a/doc/install/aws/index.md
+++ b/doc/install/aws/index.md
@@ -2,7 +2,6 @@
stage: Systems
group: Distribution
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
-comments: false
description: Read through the GitLab installation methods.
type: index
---
@@ -87,7 +86,7 @@ Because any given GitLab upgrade might involve data disk updates or database sch
- [GitLab Community Edition](https://console.aws.amazon.com/ec2/v2/home?region=us-east-1#Images:visibility=public-images;ownerAlias=782774275127;search=GitLab%20CE;sort=desc:name): The open source version of GitLab.
- [GitLab Premium or Ultimate Marketplace (pre-licensed)](https://console.aws.amazon.com/ec2/v2/home?region=us-east-1#Images:visibility=public-images;source=Marketplace;search=GitLab%20EE;sort=desc:name): 5 user license built into per-minute billing.
-1. AMI IDs are unique per region, so after you've loaded one of the above, select the desired target region in the upper right of the console to see the appropriate AMIs.
+1. AMI IDs are unique per region. After you've loaded any of these editions, in the upper-right corner, select the desired target region of the console to see the appropriate AMIs.
1. After the console is loaded, you can add additional search criteria to narrow further. For instance, type `13.` to find only 13.x versions.
1. To launch an EC2 Machine with one of the listed AMIs, check the box at the start of the relevant row, and select **Launch** near the top of left of the page.
diff --git a/doc/install/aws/manual_install_aws.md b/doc/install/aws/manual_install_aws.md
index 51ae16ccd17..bd81e0583b5 100644
--- a/doc/install/aws/manual_install_aws.md
+++ b/doc/install/aws/manual_install_aws.md
@@ -237,7 +237,7 @@ Next, we must associate the **public** subnets to the route table:
We also must create two private route tables so that instances in each private subnet can reach the internet via the NAT gateway in the corresponding public subnet in the same availability zone.
-1. Follow the same steps as above to create two private route tables. Name them `gitlab-private-a` and `gitlab-private-b` respectively.
+1. Follow the same steps as above to create two private route tables. Name them `gitlab-private-a` and `gitlab-private-b`.
1. Next, add a new route to each of the private route tables where the destination is `0.0.0.0/0` and the target is one of the NAT gateways we created earlier.
1. Add the NAT gateway we created in `gitlab-public-10.0.0.0` as the target for the new route in the `gitlab-private-a` route table.
1. Similarly, add the NAT gateway in `gitlab-public-10.0.2.0` as the target for the new route in the `gitlab-private-b`.
@@ -336,7 +336,13 @@ Now, it's time to create the database:
1. Select **Standard Create** for the database creation method.
1. Select **PostgreSQL** as the database engine and select the minimum PostgreSQL version as defined for your GitLab version in our [database requirements](../../install/requirements.md#postgresql-requirements).
1. Because this is a production server, let's choose **Production** from the **Templates** section.
-1. Under **Settings**, set a DB instance identifier, a master username, and a master password. We use `gitlab-db-ha`, `gitlab`, and a very secure password respectively. Make a note of these as we need them later.
+1. Under **Settings**, use:
+ - `gitlab-db-ha` for the DB instance identifier.
+ - `gitlab` for a master username.
+ - A very secure password for the master password.
+
+ Make a note of these as we need them later.
+
1. For the DB instance size, select **Standard classes** and select an instance size that meets your requirements from the dropdown list. We use a `db.m4.large` instance.
1. Under **Storage**, configure the following:
1. Select **Provisioned IOPS (SSD)** from the storage type dropdown list. Provisioned IOPS (SSD) storage is best suited for this use (though you can choose General Purpose (SSD) to reduce the costs). Read more about it at [Storage for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html).
@@ -483,7 +489,7 @@ Connect to your GitLab instance via **Bastion Host A** using [SSH Agent Forwardi
#### Disable Let's Encrypt
-Because we're adding our SSL certificate at the load balancer, we do not need the GitLab built-in support for Let's Encrypt. Let's Encrypt [is enabled by default](https://docs.gitlab.com/omnibus/settings/ssl.html#enable-the-lets-encrypt-integration) when using an `https` domain in GitLab 10.7 and later, so we must explicitly disable it:
+Because we're adding our SSL certificate at the load balancer, we do not need the GitLab built-in support for Let's Encrypt. Let's Encrypt [is enabled by default](https://docs.gitlab.com/omnibus/settings/ssl/index.html#enable-the-lets-encrypt-integration) when using an `https` domain in GitLab 10.7 and later, so we must explicitly disable it:
1. Open `/etc/gitlab/gitlab.rb` and disable it:
@@ -605,7 +611,7 @@ Now that we have our EC2 instance ready, follow the [documentation to install Gi
#### Add Support for Proxied SSL
-As we are terminating SSL at our [load balancer](#load-balancer), follow the steps at [Supporting proxied SSL](https://docs.gitlab.com/omnibus/settings/ssl.html#configure-a-reverse-proxy-or-load-balancer-ssl-termination) to configure this in `/etc/gitlab/gitlab.rb`.
+As we are terminating SSL at our [load balancer](#load-balancer), follow the steps at [Supporting proxied SSL](https://docs.gitlab.com/omnibus/settings/ssl/index.html#configure-a-reverse-proxy-or-load-balancer-ssl-termination) to configure this in `/etc/gitlab/gitlab.rb`.
Remember to run `sudo gitlab-ctl reconfigure` after saving the changes to the `gitlab.rb` file.
@@ -845,6 +851,6 @@ If you see this page when trying to set a password via the web interface, make s
### Some job logs are not uploaded to object storage
-When the GitLab deployment is scaled up to more than one node, some job logs may not be uploaded to [object storage](../../administration/object_storage.md) properly. [Incremental logging is required](../../administration/object_storage.md#other-alternatives-to-file-system-storage) for CI to use object storage.
+When the GitLab deployment is scaled up to more than one node, some job logs may not be uploaded to [object storage](../../administration/object_storage.md) properly. [Incremental logging is required](../../administration/object_storage.md#alternatives-to-file-system-storage) for CI to use object storage.
Enable [incremental logging](../../administration/job_logs.md#enable-or-disable-incremental-logging) if it has not already been enabled.
diff --git a/doc/install/azure/index.md b/doc/install/azure/index.md
index d92859d518f..088ef50c005 100644
--- a/doc/install/azure/index.md
+++ b/doc/install/azure/index.md
@@ -191,7 +191,7 @@ To set up the GitLab external URL:
1. Find `external_url` and replace it with your own domain name. For the sake
of this example, use the default domain name Azure sets up.
Using `https` in the URL
- [automatically enables](https://docs.gitlab.com/omnibus/settings/ssl.html#lets-encrypt-integration),
+ [automatically enables](https://docs.gitlab.com/omnibus/settings/ssl/index.html#lets-encrypt-integration),
Let's Encrypt, and sets HTTPS by default:
```ruby
diff --git a/doc/install/cloud_providers.md b/doc/install/cloud_providers.md
new file mode 100644
index 00000000000..36cda77143f
--- /dev/null
+++ b/doc/install/cloud_providers.md
@@ -0,0 +1,17 @@
+---
+stage: Systems
+group: Distribution
+info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
+description: Install GitLab on a cloud provider.
+type: index
+---
+
+# Installing GitLab on a cloud provider **(FREE SELF)**
+
+You can install GitLab on several cloud providers.
+
+| Cloud provider | Description |
+|---------------------------------------------------------------|-------------|
+| [AWS](aws/index.md) | Install GitLab on AWS using the community AMIs provided by GitLab. |
+| [Google Cloud Platform (GCP)](google_cloud_platform/index.md) | Install GitLab on a VM in GCP. |
+| [Azure](azure/index.md) | Install GitLab from Azure Marketplace. |
diff --git a/doc/install/docker.md b/doc/install/docker.md
index 40eb3a9796e..d387a4d0abb 100644
--- a/doc/install/docker.md
+++ b/doc/install/docker.md
@@ -55,6 +55,12 @@ For macOS users, use the user's `$HOME/gitlab` directory:
export GITLAB_HOME=$HOME/gitlab
```
+The `GITLAB_HOME` environment variable should be appended to your shell's profile so it is
+applied on all future terminal sessions:
+
+- Bash: `~/.bash_profile`
+- ZSH: `~/.zshrc`
+
The GitLab container uses host mounted volumes to store persistent data:
| Local location | Container location | Usage |
@@ -305,7 +311,7 @@ point to a valid URL.
To receive emails from GitLab you have to configure the
[SMTP settings](https://docs.gitlab.com/omnibus/settings/smtp.html) because the GitLab Docker image doesn't
have an SMTP server installed. You may also be interested in
-[enabling HTTPS](https://docs.gitlab.com/omnibus/settings/ssl.html).
+[enabling HTTPS](https://docs.gitlab.com/omnibus/settings/ssl/index.html).
After you make all the changes you want, you will need to restart the container to reconfigure GitLab:
@@ -456,6 +462,31 @@ web browser under `<hostIP>:8929` and push using SSH under the port `2289`.
A `docker-compose.yml` example that uses different ports can be found in the
[Docker compose](#install-gitlab-using-docker-compose) section.
+### Configure multiple database connections
+
+In [GitLab 16.0](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/6850),
+GitLab defaults to using two database connections that point to the same PostgreSQL database.
+
+If, for any reason, you wish to switch back to single database connection:
+
+1. Edit `/etc/gitlab/gitlab.rb` inside the container:
+
+ ```shell
+ sudo docker exec -it gitlab editor /etc/gitlab/gitlab.rb
+ ```
+
+1. Add the following line:
+
+ ```ruby
+ gitlab_rails['databases']['ci']['enable'] = false
+ ```
+
+1. Restart the container:
+
+```shell
+sudo docker restart gitlab
+```
+
## Upgrade
In most cases, upgrading GitLab is as easy as downloading the newest Docker
@@ -486,6 +517,12 @@ To upgrade GitLab that was [installed using Docker Engine](#install-gitlab-using
sudo docker pull gitlab/gitlab-ee:latest
```
+1. Ensure that the `GITLAB_HOME` environment variable is [defined](#set-up-the-volumes-location):
+
+ ```shell
+ echo $GITLAB_HOME
+ ```
+
1. Create the container once again with the
[previously specified](#install-gitlab-using-docker-engine) options:
diff --git a/doc/install/google_cloud_platform/index.md b/doc/install/google_cloud_platform/index.md
index d16ac3e2174..e492b5d75ce 100644
--- a/doc/install/google_cloud_platform/index.md
+++ b/doc/install/google_cloud_platform/index.md
@@ -118,7 +118,7 @@ here's how you configure GitLab to be aware of the change:
### Configuring HTTPS with the domain name
Although not needed, it's strongly recommended to secure GitLab with a
-[TLS certificate](https://docs.gitlab.com/omnibus/settings/ssl.html).
+[TLS certificate](https://docs.gitlab.com/omnibus/settings/ssl/index.html).
### Configuring the email SMTP settings
diff --git a/doc/install/index.md b/doc/install/index.md
index 4aef471ad5c..15556117b51 100644
--- a/doc/install/index.md
+++ b/doc/install/index.md
@@ -2,7 +2,6 @@
stage: Systems
group: Distribution
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
-comments: false
description: Read through the GitLab installation methods.
type: index
---
@@ -11,10 +10,15 @@ type: index
You can install GitLab on most GNU/Linux distributions, on several
cloud providers, and in Kubernetes clusters.
-
To get the best experience, you should balance performance, reliability,
ease of administration (backups, upgrades, and troubleshooting) with the cost of hosting.
-To get started, [choose your installation method](install_methods.md).
-
-If you already have a running instance, learn how to [configure it](next_steps.md).
+- [Requirements](requirements.md)
+- [Installation methods](install_methods.md)
+- [Cloud provider guides](cloud_providers.md)
+- [Offline GitLab](../topics/offline/index.md)
+- [Reference architectures](../administration/reference_architectures/index.md)
+- [Steps after installing](next_steps.md)
+- [Upgrade GitLab](../update/index.md)
+- [Install GitLab Runner](https://docs.gitlab.com/runner/install/)
+- [Configure GitLab Runner](https://docs.gitlab.com/runner/configuration/)
diff --git a/doc/install/install_methods.md b/doc/install/install_methods.md
index af15dc3f085..0463c926286 100644
--- a/doc/install/install_methods.md
+++ b/doc/install/install_methods.md
@@ -2,14 +2,14 @@
stage: Systems
group: Distribution
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
-comments: false
description: Read through the GitLab installation methods.
type: index
---
-# Installation methods
+# Installation methods **(FREE SELF)**
-You can install GitLab by using any of the following methods.
+You can install GitLab on several [cloud providers](cloud_providers.md),
+or use one of the following methods.
| Installation method | Description | When to choose |
|----------------------------------------------------------------|-------------|----------------|
@@ -20,16 +20,6 @@ You can install GitLab by using any of the following methods.
| [GitLab Environment Toolkit (GET)](https://gitlab.com/gitlab-org/gitlab-environment-toolkit#documentation) | A set of automation tools. | Use to deploy a [reference architecture](../administration/reference_architectures/index.md) on most major cloud providers. Has some [limitations](https://gitlab.com/gitlab-org/gitlab-environment-toolkit#missing-features-to-be-aware-of) and manual setup for production environments. |
| [GitLab Operator](https://docs.gitlab.com/operator/) | An installation and management method that follows the [Kubernetes Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/). | Use to run GitLab in an [OpenShift](openshift_and_gitlab/index.md) environment. |
-## Cloud providers
-
-You can install GitLab on several cloud providers.
-
-| Cloud provider | Description |
-|---------------------------------------------------------------|-------------|
-| [AWS](aws/index.md) | Install GitLab on AWS using the community AMIs provided by GitLab. |
-| [Google Cloud Platform (GCP)](google_cloud_platform/index.md) | Install GitLab on a VM in GCP. |
-| [Azure](azure/index.md) | Install GitLab from Azure Marketplace. |
-
## Unsupported Linux distributions and Unix-like operating systems
- Arch Linux
diff --git a/doc/install/installation.md b/doc/install/installation.md
index eda9c503e28..28aa37f0d1b 100644
--- a/doc/install/installation.md
+++ b/doc/install/installation.md
@@ -11,8 +11,7 @@ using the source files. To set up a **development installation** or for many
other installation options, see the [main installation page](index.md).
It was created for and tested on **Debian/Ubuntu** operating systems.
Read [requirements.md](requirements.md) for hardware and operating system requirements.
-If you want to install on RHEL/CentOS, we recommend using the
-[Omnibus packages](https://about.gitlab.com/install/).
+If you want to install on RHEL/CentOS, you should use the [Omnibus packages](https://about.gitlab.com/install/).
This guide is long because it covers many cases and includes all commands you
need, this is [one of the few installation scripts that actually work out of the box](https://twitter.com/robinvdvleuten/status/424163226532986880).
@@ -46,17 +45,17 @@ If the highest number stable branch is unclear, check the [GitLab blog](https://
## Software requirements
-| Software | Minimum version | Notes |
-| ------------------ | --------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| [Ruby](#2-ruby) | `2.7` | From GitLab 13.6, Ruby 2.7 is required. Ruby 3.0 is not supported yet (see [the relevant epic](https://gitlab.com/groups/gitlab-org/-/epics/5149) for the current status). You must use the standard MRI implementation of Ruby. We love [JRuby](https://www.jruby.org/) and [Rubinius](https://github.com/rubinius/rubinius#the-rubinius-language-platform), but GitLab needs several Gems that have native extensions. |
-| [Go](#3-go) | `1.18` | From GitLab 15.6, Go 1.18 or later is required. |
-| [Git](#git) | `2.38.x` | From GitLab 15.8, Git 2.38.x and later is required. It's highly recommended that you use the [Git version provided by Gitaly](#git). |
-| [Node.js](#4-node) | `16.15.0` | From GitLab 15.7, Node.js 16.15.0 or later is required. |
+| Software | Minimum version | Notes |
+|:------------------------|:----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Ruby](#2-ruby) | `3.0.x` | From GitLab 15.10, Ruby 3.0 is required. You must use the standard MRI implementation of Ruby. We love [JRuby](https://www.jruby.org/) and [Rubinius](https://github.com/rubinius/rubinius#the-rubinius-language-platform), but GitLab needs several Gems that have native extensions. |
+| [RubyGems](#3-rubygems) | `3.4.x` | A specific RubyGems version is not fully needed, but it's recommended to update so you can enjoy some known performance improvements. |
+| [Go](#4-go) | `1.18.x` | From GitLab 15.6, Go 1.18 or later is required. |
+| [Git](#git) | `2.38.x` | From GitLab 15.8, Git 2.38.x and later is required. It's highly recommended that you use the [Git version provided by Gitaly](#git). |
+| [Node.js](#5-node) | `16.15.0` | From GitLab 15.7, Node.js 16.15.0 or later is required. |
## GitLab directory structure
-This is the main directory structure you end up with following the instructions
-of this page:
+When following the instructions on this page, you create this directory structure:
```plaintext
|-- home
@@ -88,13 +87,14 @@ The GitLab installation consists of setting up the following components:
1. [Packages and dependencies](#1-packages-and-dependencies).
1. [Ruby](#2-ruby).
-1. [Go](#3-go).
-1. [Node](#4-node).
-1. [System users](#5-system-users).
-1. [Database](#6-database).
-1. [Redis](#7-redis).
-1. [GitLab](#8-gitlab).
-1. [NGINX](#9-nginx).
+1. [RubyGems](#3-rubygems).
+1. [Go](#4-go).
+1. [Node](#5-node).
+1. [System users](#6-system-users).
+1. [Database](#7-database).
+1. [Redis](#8-redis).
+1. [GitLab](#9-gitlab).
+1. [NGINX](#10-nginx).
## 1. Packages and dependencies
@@ -220,20 +220,25 @@ below to use a system Ruby.
Linux distributions generally have older versions of Ruby available, so these
instructions are designed to install Ruby from the official source code.
-Download Ruby and compile it:
+[Install Ruby](https://www.ruby-lang.org/en/documentation/installation/).
+
+## 3. RubyGems
+
+Sometimes, a newer version of RubyGems is required than the one bundled with Ruby.
+
+To update to a specific version:
+
+```shell
+gem update --system 3.4.12
+```
+
+Or the latest version:
```shell
-mkdir /tmp/ruby && cd /tmp/ruby
-curl --remote-name --location --progress-bar "https://cache.ruby-lang.org/pub/ruby/2.7/ruby-2.7.6.tar.gz"
-echo 'e7203b0cc09442ed2c08936d483f8ac140ec1c72e37bb5c401646b7866cb5d10 ruby-2.7.6.tar.gz' | sha256sum -c - && tar xzf ruby-2.7.6.tar.gz
-cd ruby-2.7.6
-
-./configure --disable-install-rdoc --enable-shared
-make
-sudo make install
+gem update --system
```
-## 3. Go
+## 4. Go
GitLab has several daemons written in Go. To install
GitLab we need a Go compiler. The instructions below assume you use 64-bit
@@ -251,7 +256,7 @@ sudo ln -sf /usr/local/go/bin/{go,gofmt} /usr/local/bin/
rm go1.18.8.linux-amd64.tar.gz
```
-## 4. Node
+## 5. Node
GitLab requires the use of Node to compile JavaScript
assets, and Yarn to manage JavaScript dependencies. The current minimum
@@ -275,7 +280,7 @@ npm install --global yarn
Visit the official websites for [node](https://nodejs.org/en/download/package-manager/) and [yarn](https://classic.yarnpkg.com/en/docs/install/) if you have any trouble with these steps.
-## 5. System users
+## 6. System users
Create a `git` user for GitLab:
@@ -283,10 +288,10 @@ Create a `git` user for GitLab:
sudo adduser --disabled-login --gecos 'GitLab' git
```
-## 6. Database
+## 7. Database
NOTE:
-In GitLab 12.1 and later, only PostgreSQL is supported. In GitLab 14.0 and later, we [require PostgreSQL 12+](requirements.md#postgresql-requirements).
+In GitLab 12.1 and later, only PostgreSQL is supported. In GitLab 16.0 and later, we [require PostgreSQL 13+](requirements.md#postgresql-requirements).
1. Install the database packages.
@@ -416,7 +421,7 @@ In GitLab 12.1 and later, only PostgreSQL is supported. In GitLab 14.0 and later
gitlabhq_production> \q
```
-## 7. Redis
+## 8. Redis
See the [requirements page](requirements.md#redis-versions) for the minimum
Redis requirements.
@@ -499,7 +504,7 @@ fi
sudo service redis-server restart
```
-## 8. GitLab
+## 9. GitLab
```shell
# We'll install GitLab into the home directory of the user "git"
@@ -593,6 +598,10 @@ If you want to use HTTPS, see [Using HTTPS](#using-https) for the additional ste
### Configure GitLab DB Settings
+NOTE:
+From [GitLab 15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/387898), `database.yml` with only a section: `main:` is deprecated.
+In GitLab 17.0 and later, you must have the two `main:` and `ci:` sections in your `database.yml`.
+
```shell
sudo -u git cp config/database.yml.postgresql config/database.yml
@@ -604,6 +613,11 @@ sudo -u git cp config/database.yml.postgresql config/database.yml
# adapter: postgresql
# encoding: unicode
# database: gitlabhq_production
+# ci:
+# adapter: postgresql
+# encoding: unicode
+# database: gitlabhq_production
+# database_tasks: false
#
sudo -u git -H editor config/database.yml
@@ -622,10 +636,10 @@ sudo -u git -H editor config/database.yml
sudo -u git -H chmod o-rwx config/database.yml
```
-NOTE:
-From GitLab 15.9, `database.yml` with only a section: `main:` is deprecated.
-In GitLab 15.10 and later, you should have two sections in your `database.yml`, `main:` and `ci:`. The `ci`: connection [must be to the same database](../administration/postgresql/multiple_databases.md).
-In GitLab 17.0 and later, you must have the two `main:` and `ci:` sections in your `database.yml`.
+You should have two sections in your `database.yml`: `main:` and `ci:`. The `ci`:
+connection [must be to the same database](../administration/postgresql/multiple_databases.md).
+If, for any reason, you wish to remain on a single database connection, remove the `ci:`
+section from `config/database.yml`.
### Install Gems
@@ -872,10 +886,10 @@ sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production force=yes
# When done, you see 'Administrator account created:'
```
-You can set the Administrator/root password and email by supplying them in environmental variables, `GITLAB_ROOT_PASSWORD` and `GITLAB_ROOT_EMAIL` respectively, as seen below. If you don't set the password (and it is set to the default one), wait to expose GitLab to the public internet until the installation is done and you've logged into the server the first time. During the first login, you are forced to change the default password. An Enterprise Edition license may also be installed at this time by supplying a full path in the `GITLAB_LICENSE_FILE` environment variable.
+You can set the Administrator/root password and email by supplying them in environmental variables, `GITLAB_ROOT_PASSWORD` and `GITLAB_ROOT_EMAIL`, as seen below. If you don't set the password (and it is set to the default one), wait to expose GitLab to the public internet until the installation is done and you've logged into the server the first time. During the first login, you are forced to change the default password. An Enterprise Edition subscription may also be activated at this time by supplying the activation code in the `GITLAB_ACTIVATION_CODE` environment variable.
```shell
-sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production GITLAB_ROOT_PASSWORD=yourpassword GITLAB_ROOT_EMAIL=youremail GITLAB_LICENSE_FILE="/path/to/license"
+sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production GITLAB_ROOT_PASSWORD=yourpassword GITLAB_ROOT_EMAIL=youremail GITLAB_ACTIVATION_CODE=yourcode
```
### Secure `secrets.yml`
@@ -915,7 +929,7 @@ sudo systemctl start gitlab.target
sudo service gitlab start
```
-## 9. NGINX
+## 10. NGINX
NGINX is the officially supported web server for GitLab. If you cannot or do not want to use NGINX as your web server, see [GitLab recipes](https://gitlab.com/gitlab-org/gitlab-recipes/).
@@ -1160,7 +1174,7 @@ prometheus:
If you see this message when attempting to clone a repository hosted by GitLab,
this is likely due to an outdated NGINX or Apache configuration, or a missing or
misconfigured GitLab Workhorse instance. Double-check that you've
-[installed Go](#3-go), [installed GitLab Workhorse](#install-gitlab-workhorse),
+[installed Go](#4-go), [installed GitLab Workhorse](#install-gitlab-workhorse),
and correctly [configured NGINX](#site-configuration).
### `google-protobuf` "LoadError: /lib/x86_64-linux-gnu/libc.so.6: version 'GLIBC_2.14' not found"
diff --git a/doc/install/next_steps.md b/doc/install/next_steps.md
index c718d895c8a..70b6101b1eb 100644
--- a/doc/install/next_steps.md
+++ b/doc/install/next_steps.md
@@ -56,7 +56,7 @@ installation.
## Cross-repository Code Search
-- [Advanced Search](../integration/advanced_search/elasticsearch.md): Leverage [Elasticsearch](https://www.elastic.co/) or [OpenSearch](https://opensearch.org/) for
+- [Advanced search](../integration/advanced_search/elasticsearch.md): Leverage [Elasticsearch](https://www.elastic.co/) or [OpenSearch](https://opensearch.org/) for
faster, more advanced code search across your entire GitLab instance.
## Scaling and replication
diff --git a/doc/install/openshift_and_gitlab/index.md b/doc/install/openshift_and_gitlab/index.md
index 6086716be1c..4f3df3ecff8 100644
--- a/doc/install/openshift_and_gitlab/index.md
+++ b/doc/install/openshift_and_gitlab/index.md
@@ -31,7 +31,7 @@ The GitLab Operator does not include the GitLab Runner. To install and manage a
### Secure
-- [License Compliance](../../user/compliance/license_compliance/index.md)
+- [License Compliance via the `License-Scanning.gitlab-ci.yml` CI/CD template](../../user/compliance/license_compliance/index.md). [License scanning of CycloneDX files](../../user/compliance/license_scanning_of_cyclonedx_files/index.md) is supported on OpenShift.
- [Code Quality scanning](../../ci/testing/code_quality.md)
- [Operational Container Scanning](../../user/clusters/agent/vulnerabilities.md) (Note: Pipeline [Container Scanning](../../user/application_security/container_scanning/index.md) is supported)
diff --git a/doc/install/requirements.md b/doc/install/requirements.md
index 8c6f469aca2..7fdbdfc2b24 100644
--- a/doc/install/requirements.md
+++ b/doc/install/requirements.md
@@ -12,10 +12,7 @@ This page includes information about the minimum requirements you need to instal
### Redis versions
-GitLab 13.0 and later requires Redis version 5.0 or higher.
-
-Redis version 6.0 or higher is recommended, as this is what ships with
-[Omnibus GitLab](https://docs.gitlab.com/omnibus/) packages starting with GitLab 13.9.
+GitLab 16.0 and later requires Redis 6.0 or later.
## Hardware requirements
@@ -92,7 +89,7 @@ the following table) as these were used for development and testing:
| 13.0 | 11 |
| 14.0 | 12.7 |
| 15.0 | 12.10 |
-| 16.0 (planned) | 13.6 |
+| 16.0 | 13.6 |
You must also ensure the following extensions are loaded into every
GitLab database. [Read more about this requirement, and troubleshooting](postgresql_extensions.md).
View Lorry Controller Status