From 8b573c94895dc0ac0e1d9d59cf3e8745e8b539ca Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Thu, 17 Dec 2020 11:59:07 +0000 Subject: Add latest changes from gitlab-org/gitlab@13-7-stable-ee --- doc/install/installation.md | 46 ++++++++++++++++++--------------------------- 1 file changed, 18 insertions(+), 28 deletions(-) (limited to 'doc/install/installation.md') diff --git a/doc/install/installation.md b/doc/install/installation.md index a6d00ad140e..983c7ed577f 100644 --- a/doc/install/installation.md +++ b/doc/install/installation.md @@ -1,7 +1,7 @@ --- stage: Enablement group: Distribution -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/#designated-technical-writers +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 type: howto --- @@ -102,16 +102,6 @@ apt-get upgrade -y apt-get install sudo -y ``` -During this installation, some files need to be edited manually. If you are familiar -with vim, set it as default editor with the commands below. If you are not familiar -with vim, skip this and keep using the default editor: - -```shell -# Install vim and set as default editor -sudo apt-get install -y vim -sudo update-alternatives --set editor /usr/bin/vim.basic -``` - ### Build dependencies Install the required packages (needed to compile Ruby and native extensions to Ruby gems): @@ -215,7 +205,7 @@ Download Ruby and compile it: ```shell mkdir /tmp/ruby && cd /tmp/ruby -curl --remote-name --progress https://cache.ruby-lang.org/pub/ruby/2.7/ruby-2.7.2.tar.gz +curl --remote-name --progress "https://cache.ruby-lang.org/pub/ruby/2.7/ruby-2.7.2.tar.gz" echo 'cb9731a17487e0ad84037490a6baf8bfa31a09e8 ruby-2.7.2.tar.gz' | shasum -c - && tar xzf ruby-2.7.2.tar.gz cd ruby-2.7.2 @@ -235,7 +225,7 @@ page](https://golang.org/dl). # Remove former Go installation folder sudo rm -rf /usr/local/go -curl --remote-name --progress https://dl.google.com/go/go1.13.5.linux-amd64.tar.gz +curl --remote-name --progress "https://dl.google.com/go/go1.13.5.linux-amd64.tar.gz" echo '512103d7ad296467814a6e3f635631bd35574cab3369a97a323c9a585ccaa569 go1.13.5.linux-amd64.tar.gz' | shasum -a256 -c - && \ sudo tar -C /usr/local -xzf go1.13.5.linux-amd64.tar.gz sudo ln -sf /usr/local/go/bin/{go,godoc,gofmt} /usr/local/bin/ @@ -257,10 +247,10 @@ we need to install through the following commands: ```shell # install node v12.x -curl --location https://deb.nodesource.com/setup_12.x | sudo bash - +curl --location "https://deb.nodesource.com/setup_12.x" | sudo bash - sudo apt-get install -y nodejs -curl --silent --show-error https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add - +curl --silent --show-error "https://dl.yarnpkg.com/debian/pubkey.gpg" | sudo apt-key add - echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list sudo apt-get update sudo apt-get install yarn @@ -278,7 +268,7 @@ sudo adduser --disabled-login --gecos 'GitLab' git ## 6. Database -NOTE: **Note:** +NOTE: In GitLab 12.1 and later, only PostgreSQL is supported. In GitLab 13.0 and later, we [require PostgreSQL 11+](requirements.md#postgresql-requirements). 1. Install the database packages: @@ -443,7 +433,7 @@ Make sure to replace `` with the stable branch that matches the version you want to install. For example, if you want to install 11.8 you would use the branch name `11-8-stable`. -CAUTION: **Caution:** +WARNING: You can change `` to `master` if you want the *bleeding edge* version, but never install `master` on a production server! ### Configure It @@ -553,7 +543,7 @@ sudo -u git -H chmod o-rwx config/database.yml ### Install Gems -NOTE: **Note:** +NOTE: As of Bundler 1.5.2, you can invoke `bundle install -jN` (where `N` is the number of your processor cores) and enjoy parallel gems installation with measurable difference in completion time (~60% faster). Check the number of your cores with `nproc`. For more information, see this [post](https://thoughtbot.com/blog/parallel-gem-installing-using-bundler). Make sure you have `bundle` (run `bundle -v`): @@ -773,14 +763,14 @@ sudo apt-get install -y nginx ### Site Configuration -Copy the example site config: +Copy the example site configuration: ```shell sudo cp lib/support/nginx/gitlab /etc/nginx/sites-available/gitlab sudo ln -s /etc/nginx/sites-available/gitlab /etc/nginx/sites-enabled/gitlab ``` -Make sure to edit the config file to match your setup. Also, ensure that you match your paths to GitLab, especially if installing for a user other than the `git` user: +Make sure to edit the configuration file to match your setup. Also, ensure that you match your paths to GitLab, especially if installing for a user other than the `git` user: ```shell # Change YOUR_SERVER_FQDN to the fully-qualified @@ -795,21 +785,21 @@ Make sure to edit the config file to match your setup. Also, ensure that you mat sudo editor /etc/nginx/sites-available/gitlab ``` -If you intend to enable GitLab Pages, there is a separate NGINX config you need +If you intend to enable GitLab Pages, there is a separate NGINX configuration you need to use. Read all about the needed configuration at the [GitLab Pages administration guide](../administration/pages/index.md). -If you want to use HTTPS, replace the `gitlab` NGINX config with `gitlab-ssl`. See [Using HTTPS](#using-https) for HTTPS configuration details. +If you want to use HTTPS, replace the `gitlab` NGINX configuration with `gitlab-ssl`. See [Using HTTPS](#using-https) for HTTPS configuration details. ### Test Configuration -Validate your `gitlab` or `gitlab-ssl` NGINX config file with the following command: +Validate your `gitlab` or `gitlab-ssl` NGINX configuration file with the following command: ```shell sudo nginx -t ``` -You should receive `syntax is okay` and `test is successful` messages. If you receive errors check your `gitlab` or `gitlab-ssl` NGINX config file for typos, etc. as indicated in the error message given. +You should receive `syntax is okay` and `test is successful` messages. If you receive errors check your `gitlab` or `gitlab-ssl` NGINX configuration file for typos, etc. as indicated in the error message given. Verify that the installed version is greater than 1.12.1: @@ -842,7 +832,7 @@ sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production If all items are green, congratulations on successfully installing GitLab! -TIP: **Tip:** +NOTE: Supply the `SANITIZE=true` environment variable to `gitlab:check` to omit project names from the output of the check command. ### Initial Login @@ -878,7 +868,7 @@ To use GitLab with HTTPS: 1. In the `config.yml` of GitLab Shell: 1. Set `gitlab_url` option to the HTTPS endpoint of GitLab (e.g. `https://git.example.com`). 1. Set the certificates using either the `ca_file` or `ca_path` option. -1. Use the `gitlab-ssl` NGINX example config instead of the `gitlab` config. +1. Use the `gitlab-ssl` NGINX example configuration instead of the `gitlab` configuration. 1. Update `YOUR_SERVER_FQDN`. 1. Update `ssl_certificate` and `ssl_certificate_key`. 1. Review the configuration file and consider applying other security and performance enhancing features. @@ -951,7 +941,7 @@ production: ### Custom SSH Connection -If you are running SSH on a non-standard port, you must change the GitLab user's SSH config. +If you are running SSH on a non-standard port, you must change the GitLab user's SSH configuration. ```plaintext # Add to /home/git/.ssh/config @@ -973,7 +963,7 @@ As of GitLab 12.9, [Puma](https://github.com/puma/puma) has replaced Unicorn as If you want to switch back to Unicorn, follow these steps: 1. Finish the GitLab setup so you have it up and running. -1. Copy the supplied example Unicorn config file into place: +1. Copy the supplied example Unicorn configuration file into place: ```shell cd /home/git/gitlab -- cgit v1.2.1