diff --git a/doc-locale/ja-jp/ci/pipeline_security/_index.md b/doc-locale/ja-jp/ci/pipeline_security/_index.md new file mode 100644 index 0000000000000000000000000000000000000000..26726796d7f87dfa4d967e510a695c4ec0538038 --- /dev/null +++ b/doc-locale/ja-jp/ci/pipeline_security/_index.md @@ -0,0 +1,188 @@ +--- +stage: Software Supply Chain Security +group: Pipeline Security +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments +title: パイプラインセキュリティ +--- + +{{< details >}} + +- プラン: Free、Premium、Ultimate +- 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated + +{{< /details >}} + +## シークレット管理 + +シークレット管理は、厳格なアクセス制御を備えた安全な環境で機密データを安全に保存するためにデベロッパーが使用するシステムです。**シークレット**は、機密保持が必要な機密性の高い認証情報です。シークレットには、次のようなものがあります。 + +- パスワード +- SSH鍵 +- アクセストークン +- 公開されると組織にとって有害となる可能性のあるその他の種類の認証情報 + +## シークレットの保存 + +### シークレット管理プロバイダー + +最も機密性が高く、最も厳格なポリシーが適用されるシークレットは、シークレットマネージャーに保存する必要があります。シークレットマネージャーソリューションを使用する場合、シークレットはGitLabインスタンスの外部に保存されます。この分野には、[HashiCorpのVault](https://www.vaultproject.io)、[Azure Key Vault](https://azure.microsoft.com/en-us/products/key-vault)、[Google Cloud Secret Manager](https://cloud.google.com/security/products/secret-manager)など、多くのプロバイダーが存在します。 + +特定の[外部シークレット管理プロバイダー](../secrets/_index.md)にGitLabネイティブインテグレーションを使用すると、必要なときにCI/CDパイプラインでそれらのシークレットを取得できます。 + +### CI/CD変数 + +[CI/CD変数](../variables/_index.md)はCI/CDパイプラインでデータを保存および再利用するのに便利な方法ですが、変数はシークレット管理プロバイダーほど安全ではありません。変数の値は次のように処理されます。 + +- GitLabプロジェクト、グループ、またはインスタンスの設定に保存されます。設定へのアクセス権を持つユーザーは、[非表示](../variables/_index.md#hide-a-cicd-variable)になっていない変数の値にアクセスできます。 +- [上書き](../variables/_index.md#use-pipeline-variables)できるため、どの値が使用されたかを判断するのが困難になります。 +- 偶発的なパイプラインの設定ミスによって公開される可能性があります。 + +変数への保存に適した情報は、悪用のリスクなしに公開できるデータ（機密性の低い情報）であると考えられます。 + +機密データは、シークレット管理ソリューションに保存することをお勧めします。シークレット管理ソリューションがなく、機密データをCI/CD変数に保存する場合は、必ず次のことを行ってください。 + +- [変数をマスクする](../variables/_index.md#mask-a-cicd-variable)。 +- [変数を非表示にする](../variables/_index.md#hide-a-cicd-variable)。 +- 可能な場合は[変数を保護する](../variables/_index.md#protect-a-cicd-variable)。 + +## パイプラインの整合性 + +パイプラインの整合性を確保するために重要なセキュリティの要素には、次のものがあります。 + +- **サプライチェーンセキュリティ**: アセットは信頼できるソースから入手し、その整合性を検証する必要があります。 +- **再現性**: パイプラインは、同じインプットを使用するときに一貫した結果を生成する必要があります。 +- **可監査性**: パイプラインのすべての依存関係を追跡可能にし、その出所を検証可能にする必要があります。 +- **バージョン管理**: パイプラインの依存関係への変更は、追跡および管理する必要があります。 + +### Dockerイメージ + +クライアント側の整合性検証を確実にするために、Dockerイメージには常にSHAダイジェストを使用してください。次に例を示します。 + +- Node: + - 使用: `image: node@sha256:0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef` + - 使用しない: `image: node:latest` +- Python: + - 使用: `image: python@sha256:9876543210abcdef9876543210abcdef9876543210abcdef9876543210abcdef` + - 使用しない: `image: python:3.9` + +特定のタグが付いたイメージのSHAダイジェストは、次を使用して見つけることができます。 + +```shell +docker pull node:18.17.1 +docker images --digests node:18.17.1 +``` + +イメージの整合性を保護するコンテナレジストリからプルすることをお勧めします。 + +- [保護されたコンテナリポジトリ](../../user/packages/container_registry/container_repository_protection_rules.md)を使用して、コンテナリポジトリ内のコンテナイメージを変更できるユーザーを制限します。 +- [保護タグ](../../user/packages/container_registry/protected_container_tags.md)を使用して、コンテナタグをプッシュおよび削除できるユーザーを制御します。 + +可能な場合は、悪意のあるイメージを指すように変更される可能性があるため、コンテナ参照で変数を使用しないでください。次に例を示します。 + +- 推奨: + - `image: my-registry.example.com/node:18.17.1` +- 使用しない: + - `image: ${CUSTOM_REGISTRY}/node:latest` + - `image: node:${VERSION}` + +### パッケージの依存関係 + +ジョブでパッケージの依存関係をロックダウンする必要があります。ロックファイルで定義された正確なバージョンを使用してください。 + +- npm: + - 使用: `npm ci` + - 使用しない: `npm install` +- yarn: + - 使用: `yarn install --frozen-lockfile` + - 使用しない: `yarn install` +- Python: + - 使用: + - `pip install -r requirements.txt --require-hashes` + - `pip install -r requirements.lock` + - 使用しない: `pip install -r requirements.txt` +- Go: + - `go.sum`からの正確なバージョンを使用: + - `go mod verify` + - `go mod download` + - 使用しない: `go get ./...` + +たとえば、CI/CDジョブでは、次のようになります。 + +```yaml +javascript-job: + script: + - npm ci +``` + +### Shellコマンドとスクリプト + +ジョブにツールをインストールするときは、常に正確なバージョンを指定して確認してください。たとえば、Terraformジョブでは、次のように指定します。 + +```yaml +terraform_job: + script: + # Download specific version + - | + wget https://releases.hashicorp.com/terraform/1.5.7/terraform_1.5.7_linux_amd64.zip + # IMPORTANT: Always verify checksums + echo "c0ed7bc32ee52ae255af9982c8c88a7a4c610485cf1d55feeb037eab75fa082c terraform_1.5.7_linux_amd64.zip" | sha256sum -c + unzip terraform_1.5.7_linux_amd64.zip + mv terraform /usr/local/bin/ + # Use the installed version + - terraform init + - terraform plan +``` + +### バージョン管理ツール + +可能な場合はバージョンマネージャーを使用してください。 + +```yaml +node_build: + script: + # Use nvm to install and use a specific Node version + - | + nvm install 16.15.1 + nvm use 16.15.1 + - node --version # Verify version + - npm ci + - npm run build +``` + +### インクルード対象の設定 + +パイプラインに設定またはCI/CDコンポーネントを追加するために[`include`キーワード](../yaml/_index.md#include)を使用する場合は、可能な限り特定のrefを使用してください。次に例を示します。 + +```yaml +include: + - project: 'my-group/my-project' + ref: 8b0c8b318857c8211c15c6643b0894345a238c4e # Pin to a specific commit + file: '/templates/build.yml' + - project: 'my-group/security' + ref: v2.1.0 # Pin to a protected tag + file: '/templates/scan.yml' + - component: 'my-group/security-scans' # Pin to a specific version + version: '1.2.3' +``` + +バージョンレスのインクルードは避けてください。 + +```yaml +include: + - project: 'my-group/my-project' # Unsafe + file: '/templates/build.yml' + - component: 'my-group/security-scans' # Unsafe + - remote: 'https://example.com/security-scan.yml' # Unsafe +``` + +リモートファイルをインクルードするのではなく、ファイルをダウンロードしてリポジトリに保存します。その後、ローカルコピーをインクルードします。 + +```yaml +include: + - local: '/ci/security-scan.yml' # Verified and stored in the repository +``` + +### 関連トピック + +1. [CIS（Center for Internet Security）のDockerベンチマーク](https://www.cisecurity.org/benchmark/docker) +1. Google Cloud: [安全なデプロイパイプラインを設計する](https://cloud.google.com/architecture/design-secure-deployment-pipelines-bp) diff --git a/doc-locale/ja-jp/ci/pipelines/pipeline_security.md b/doc-locale/ja-jp/ci/pipelines/pipeline_security.md index 26726796d7f87dfa4d967e510a695c4ec0538038..45e6b4692bf0bc9ac55e0fd2d178d32fa6c229e1 100644 --- a/doc-locale/ja-jp/ci/pipelines/pipeline_security.md +++ b/doc-locale/ja-jp/ci/pipelines/pipeline_security.md @@ -1,188 +1,13 @@ --- -stage: Software Supply Chain Security -group: Pipeline Security -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments -title: パイプラインセキュリティ +redirect_to: '../pipeline_security/_index.md' +remove_date: '2025-09-24' --- -{{< details >}} + -- プラン: Free、Premium、Ultimate -- 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated +This document was moved to [another location](../pipeline_security/_index.md). -{{< /details >}} - -## シークレット管理 - -シークレット管理は、厳格なアクセス制御を備えた安全な環境で機密データを安全に保存するためにデベロッパーが使用するシステムです。**シークレット**は、機密保持が必要な機密性の高い認証情報です。シークレットには、次のようなものがあります。 - -- パスワード -- SSH鍵 -- アクセストークン -- 公開されると組織にとって有害となる可能性のあるその他の種類の認証情報 - -## シークレットの保存 - -### シークレット管理プロバイダー - -最も機密性が高く、最も厳格なポリシーが適用されるシークレットは、シークレットマネージャーに保存する必要があります。シークレットマネージャーソリューションを使用する場合、シークレットはGitLabインスタンスの外部に保存されます。この分野には、[HashiCorpのVault](https://www.vaultproject.io)、[Azure Key Vault](https://azure.microsoft.com/en-us/products/key-vault)、[Google Cloud Secret Manager](https://cloud.google.com/security/products/secret-manager)など、多くのプロバイダーが存在します。 - -特定の[外部シークレット管理プロバイダー](../secrets/_index.md)にGitLabネイティブインテグレーションを使用すると、必要なときにCI/CDパイプラインでそれらのシークレットを取得できます。 - -### CI/CD変数 - -[CI/CD変数](../variables/_index.md)はCI/CDパイプラインでデータを保存および再利用するのに便利な方法ですが、変数はシークレット管理プロバイダーほど安全ではありません。変数の値は次のように処理されます。 - -- GitLabプロジェクト、グループ、またはインスタンスの設定に保存されます。設定へのアクセス権を持つユーザーは、[非表示](../variables/_index.md#hide-a-cicd-variable)になっていない変数の値にアクセスできます。 -- [上書き](../variables/_index.md#use-pipeline-variables)できるため、どの値が使用されたかを判断するのが困難になります。 -- 偶発的なパイプラインの設定ミスによって公開される可能性があります。 - -変数への保存に適した情報は、悪用のリスクなしに公開できるデータ（機密性の低い情報）であると考えられます。 - -機密データは、シークレット管理ソリューションに保存することをお勧めします。シークレット管理ソリューションがなく、機密データをCI/CD変数に保存する場合は、必ず次のことを行ってください。 - -- [変数をマスクする](../variables/_index.md#mask-a-cicd-variable)。 -- [変数を非表示にする](../variables/_index.md#hide-a-cicd-variable)。 -- 可能な場合は[変数を保護する](../variables/_index.md#protect-a-cicd-variable)。 - -## パイプラインの整合性 - -パイプラインの整合性を確保するために重要なセキュリティの要素には、次のものがあります。 - -- **サプライチェーンセキュリティ**: アセットは信頼できるソースから入手し、その整合性を検証する必要があります。 -- **再現性**: パイプラインは、同じインプットを使用するときに一貫した結果を生成する必要があります。 -- **可監査性**: パイプラインのすべての依存関係を追跡可能にし、その出所を検証可能にする必要があります。 -- **バージョン管理**: パイプラインの依存関係への変更は、追跡および管理する必要があります。 - -### Dockerイメージ - -クライアント側の整合性検証を確実にするために、Dockerイメージには常にSHAダイジェストを使用してください。次に例を示します。 - -- Node: - - 使用: `image: node@sha256:0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef` - - 使用しない: `image: node:latest` -- Python: - - 使用: `image: python@sha256:9876543210abcdef9876543210abcdef9876543210abcdef9876543210abcdef` - - 使用しない: `image: python:3.9` - -特定のタグが付いたイメージのSHAダイジェストは、次を使用して見つけることができます。 - -```shell -docker pull node:18.17.1 -docker images --digests node:18.17.1 -``` - -イメージの整合性を保護するコンテナレジストリからプルすることをお勧めします。 - -- [保護されたコンテナリポジトリ](../../user/packages/container_registry/container_repository_protection_rules.md)を使用して、コンテナリポジトリ内のコンテナイメージを変更できるユーザーを制限します。 -- [保護タグ](../../user/packages/container_registry/protected_container_tags.md)を使用して、コンテナタグをプッシュおよび削除できるユーザーを制御します。 - -可能な場合は、悪意のあるイメージを指すように変更される可能性があるため、コンテナ参照で変数を使用しないでください。次に例を示します。 - -- 推奨: - - `image: my-registry.example.com/node:18.17.1` -- 使用しない: - - `image: ${CUSTOM_REGISTRY}/node:latest` - - `image: node:${VERSION}` - -### パッケージの依存関係 - -ジョブでパッケージの依存関係をロックダウンする必要があります。ロックファイルで定義された正確なバージョンを使用してください。 - -- npm: - - 使用: `npm ci` - - 使用しない: `npm install` -- yarn: - - 使用: `yarn install --frozen-lockfile` - - 使用しない: `yarn install` -- Python: - - 使用: - - `pip install -r requirements.txt --require-hashes` - - `pip install -r requirements.lock` - - 使用しない: `pip install -r requirements.txt` -- Go: - - `go.sum`からの正確なバージョンを使用: - - `go mod verify` - - `go mod download` - - 使用しない: `go get ./...` - -たとえば、CI/CDジョブでは、次のようになります。 - -```yaml -javascript-job: - script: - - npm ci -``` - -### Shellコマンドとスクリプト - -ジョブにツールをインストールするときは、常に正確なバージョンを指定して確認してください。たとえば、Terraformジョブでは、次のように指定します。 - -```yaml -terraform_job: - script: - # Download specific version - - | - wget https://releases.hashicorp.com/terraform/1.5.7/terraform_1.5.7_linux_amd64.zip - # IMPORTANT: Always verify checksums - echo "c0ed7bc32ee52ae255af9982c8c88a7a4c610485cf1d55feeb037eab75fa082c terraform_1.5.7_linux_amd64.zip" | sha256sum -c - unzip terraform_1.5.7_linux_amd64.zip - mv terraform /usr/local/bin/ - # Use the installed version - - terraform init - - terraform plan -``` - -### バージョン管理ツール - -可能な場合はバージョンマネージャーを使用してください。 - -```yaml -node_build: - script: - # Use nvm to install and use a specific Node version - - | - nvm install 16.15.1 - nvm use 16.15.1 - - node --version # Verify version - - npm ci - - npm run build -``` - -### インクルード対象の設定 - -パイプラインに設定またはCI/CDコンポーネントを追加するために[`include`キーワード](../yaml/_index.md#include)を使用する場合は、可能な限り特定のrefを使用してください。次に例を示します。 - -```yaml -include: - - project: 'my-group/my-project' - ref: 8b0c8b318857c8211c15c6643b0894345a238c4e # Pin to a specific commit - file: '/templates/build.yml' - - project: 'my-group/security' - ref: v2.1.0 # Pin to a protected tag - file: '/templates/scan.yml' - - component: 'my-group/security-scans' # Pin to a specific version - version: '1.2.3' -``` - -バージョンレスのインクルードは避けてください。 - -```yaml -include: - - project: 'my-group/my-project' # Unsafe - file: '/templates/build.yml' - - component: 'my-group/security-scans' # Unsafe - - remote: 'https://example.com/security-scan.yml' # Unsafe -``` - -リモートファイルをインクルードするのではなく、ファイルをダウンロードしてリポジトリに保存します。その後、ローカルコピーをインクルードします。 - -```yaml -include: - - local: '/ci/security-scan.yml' # Verified and stored in the repository -``` - -### 関連トピック - -1. [CIS（Center for Internet Security）のDockerベンチマーク](https://www.cisecurity.org/benchmark/docker) -1. Google Cloud: [安全なデプロイパイプラインを設計する](https://cloud.google.com/architecture/design-secure-deployment-pipelines-bp) + + + + diff --git a/doc-locale/ja-jp/install/docker/upgrade.md b/doc-locale/ja-jp/install/docker/upgrade.md index 780bd7965ad67ec0cf32a8242344431bfaa311df..8f0d4038d16ebdb68635adfc98dbf4fb964e3775 100644 --- a/doc-locale/ja-jp/install/docker/upgrade.md +++ b/doc-locale/ja-jp/install/docker/upgrade.md @@ -1,107 +1,13 @@ --- -stage: Systems -group: Distribution -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments -title: アップグレード +redirect_to: '../../update/docker/_index.md' +remove_date: '2025-11-08' --- -{{< details >}} + -- プラン: Free、Premium、Ultimate -- 提供形態: GitLab Self-Managed +This document was moved to [another location](../../update/docker/_index.md). -{{< /details >}} - -ほとんどの場合、GitLabのアップグレードは最新のDockerイメージタグをダウンロードするのと同じくらい簡単です。 - -## Docker Engineを使用してGitLabをアップグレードする - -[Docker Engineを使用してインストール](installation.md#install-gitlab-by-using-docker-engine)されたGitLabインスタンスをアップグレードするには: - -1. [バックアップ](backup.md)を作成します。最低限、[データベース](backup.md#create-a-database-backup)とGitLabシークレットファイルをバックアップしてください。 - -1. 実行中のコンテナを停止します。 - - ```shell - sudo docker stop gitlab - ``` - -1. 既存のコンテナを削除します。 - - ```shell - sudo docker rm gitlab - ``` - -1. 新しいイメージをプルします。 - - ```shell - sudo docker pull gitlab/gitlab-ee:-ee.0 - ``` - -1. `GITLAB_HOME`環境変数が[定義](installation.md#create-a-directory-for-the-volumes)されていることを確認してください。 - - ```shell - echo $GITLAB_HOME - ``` - -1. [以前に指定した](installation.md#install-gitlab-by-using-docker-engine)オプションを使用して、コンテナを再度作成します。 - - ```shell - sudo docker run --detach \ - --hostname gitlab.example.com \ - --publish 443:443 --publish 80:80 --publish 22:22 \ - --name gitlab \ - --restart always \ - --volume $GITLAB_HOME/config:/etc/gitlab \ - --volume $GITLAB_HOME/logs:/var/log/gitlab \ - --volume $GITLAB_HOME/data:/var/opt/gitlab \ - --shm-size 256m \ - gitlab/gitlab-ee:-ee.0 - ``` - -初回実行時に、GitLabは自身を再構成し、アップグレードします。 - -異なるバージョンにアップグレードする場合は、GitLab[アップグレードの推奨事項](../../policy/maintenance.md#upgrade-recommendations)を参照してください。 - -## Docker Composeを使用してGitLabをアップグレードする - -[Docker Composeを使用してインストール](installation.md#install-gitlab-by-using-docker-compose)されたGitLabインスタンスをアップグレードするには: - -1. [バックアップ](backup.md)を作成します。最低限、[データベース](backup.md#create-a-database-backup)とGitLabシークレットファイルをバックアップしてください。 -1. `docker-compose.yml`を編集して、プルするバージョンを変更します。 -1. 最新リリースをダウンロードして、GitLabインスタンスをアップグレードします。 - - ```shell - docker compose pull - docker compose up -d - ``` - -## CommunityエディションをEnterpriseエディションに変換する - -Docker用の既存のGitLab Communityエディション(CE)コンテナをGitLab [Enterpriseエディション](https://about.gitlab.com/pricing/)(EE)コンテナに変換するには、[バージョンをアップグレード](upgrade.md)するのと同じ方法を使用します。 - -CEの同じバージョンからEEに変換することをおすすめします(たとえば、CE 14.1からEE 14.1)。ただし、これは必須ではありません。標準的なアップグレード(たとえば、CE 14.0からEE 14.1)はすべて機能するはずです。次の手順では、同じバージョンに変換することを前提としています。 - -1. [バックアップ](backup.md)を作成します。最低限、[データベース](backup.md#create-a-database-backup)とGitLabシークレットファイルをバックアップしてください。 - -1. 現在のCEコンテナを停止し、削除または名前を変更します。 - -1. GitLab EEで新しいコンテナを作成するには、`docker run`コマンドまたは`docker-compose.yml`ファイルで`ce`を`ee`に置き換えます 。CEコンテナ名、ポートマッピング、ファイルマッピング、およびバージョンを再利用します。 - -## GitLabをダウングレードする - -復元により、新しいすべてのGitLabデータベースコンテンツを古い状態に上書きします。ダウングレードは、必要な場合にのみ推奨されます。たとえば、アップグレード後のテストで、すぐに解決できない問題が明らかになった場合などです。 - -{{< alert type="warning" >}} - -ダウングレードするバージョンおよびエディションとまったく同じバージョンで作成されたデータベースのバックアップが少なくとも1つ必要です。バックアップは、アップグレード中に行われたスキーマの変更(移行)を元に戻すために必要です。 - -{{< /alert >}} - -アップグレード直後にGitLabをダウングレードするには: - -1. インストールしたバージョンより[以前のバージョンを指定](installation.md#find-the-gitlab-version-and-edition-to-use)して、アップグレード手順に従います。 - -1. アップグレード前に[作成したデータベースバックアップ](backup.md#create-a-database-backup)を復元します。 - - - PumaとSidekiqの停止を含め、[Dockerイメージの復元手順に従います](../../administration/backup_restore/restore_gitlab.md#restore-for-docker-image-and-gitlab-helm-chart-installations)。データベースのみを復元する必要があるため、`SKIP=artifacts,repositories,registry,uploads,builds,pages,lfs,packages,terraform_state`を`gitlab-backup restore`コマンドライン引数に追加します。 + + + + diff --git a/doc-locale/ja-jp/install/installation.md b/doc-locale/ja-jp/install/installation.md index bcd351ecbc37dd29f991225e38ad714e0a8f95cf..a88c9424a81ee55be42487f2ad90ed9f08f4b234 100644 --- a/doc-locale/ja-jp/install/installation.md +++ b/doc-locale/ja-jp/install/installation.md @@ -1,1191 +1,13 @@ --- -stage: Systems -group: Distribution -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments -title: 自己コンパイルによるインストール +redirect_to: 'self_compiled/_index.md' +remove_date: '2025-10-30' --- -{{< details >}} + -- プラン: Free、Premium、Ultimate -- 製品: GitLab Self-Managed +This document was moved to [another location](self_compiled/_index.md). -{{< /details >}} - -これは、ソースファイルを使用して本番環境GitLabサーバーをセットアップするための公式インストールガイドです。**Debian/Ubuntu**オペレーティングシステム用に作成され、テストされています。ハードウェアとオペレーティングシステムの要件については、[requirements.md](requirements.md)をお読みください。RHEL/CentOSにインストールする場合は、[Linuxパッケージ](https://about.gitlab.com/install/)を使用する必要があります。その他の多くのインストールオプションについては、[インストールのメインページ](_index.md)を参照してください。 - -このガイドが長いのは、多くのケースを網羅し、必要なすべてのコマンドが含まれているためです。[これは、実際そのまま使用できる数少ないインストールスクリプトの1つ](https://twitter.com/robinvdvleuten/status/424163226532986880)です。次の手順は動作することが確認されています。このガイドから**逸脱する場合は注意してください**。その環境についてGitLabが前提としている点を破らないようにしてください。たとえば、ディレクトリの場所を変更したり、間違ったユーザーとしてサービスを実行したりすると、多くのユーザーが権限の問題に遭遇します。 - -このガイドにバグ/エラーを見つけた場合は、[コントリビュートガイド](https://gitlab.com/gitlab-org/gitlab/-/blob/master/CONTRIBUTING.md)に従って、**マージリクエストを送信**してください。 - -## Linuxパッケージインストールを検討する - -自己コンパイルによるインストールでは多くの作業とエラーが発生しやすいため、高速で信頼性の高い[Linuxパッケージインストール](https://about.gitlab.com/install/)（deb/rpm）を使用することを強くおすすめします。 - -Linuxパッケージが信頼性の高い理由の1つは、いずれかのクラッシュが発生した場合にGitLabプロセスを再起動するためにrunitを使用することです。頻繁に使用されるGitLabインスタンスでは、Sidekiqバックグラウンドワーカーのメモリ使用量が増加します。Linuxパッケージでは、メモリを使いすぎると[Sidekiqを正常に終了させる](../administration/sidekiq/sidekiq_memory_killer.md)ことでこれを解決します。終了すると、runitはSidekiqが実行されていないことを検出し、それを開始します。自己コンパイルによるインストールでは、プロセス監視にrunitを使用しないため、Sidekiqを終了できず、メモリ使用量が増加する可能性があります。 - -## インストールするバージョンを選択する - -インストールするGitLabのブランチ（バージョン、たとえば`16-0-stable`）から[このインストールガイド](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/install/installation.md)を表示していることを確認してください。GitLabの左上隅（メニューバーの下）にあるバージョンドロップダウンリストでブランチを選択できます。 - -最新の安定したブランチが不明な場合は、バージョン別のインストールガイドリンクについて[GitLabブログ](https://about.gitlab.com/blog/)を確認してください。 - -## ソフトウェア要件 - -| ソフトウェア | 最小バージョン | 注 | -|:------------------------|:----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [Ruby](#2-ruby) | `3.2.x` | GitLab 17.5以降では、Ruby 3.2が必要です。Rubyの標準MRI実装を使用する必要があります。[JRuby](https://www.jruby.org/)と[Rubinius](https://github.com/rubinius/rubinius#the-rubinius-language-platform)が好まれますが、GitLabにはネイティブ拡張機能を持ついくつかのgemが必要です。 | -| [RubyGems](#3-rubygems) | `3.5.x` | 特定のRubyGemsバージョンは必須ではありませんが、既知のパフォーマンス改善のベネフィット得るためにアップデートしてください。 | -| [Go](#4-go) | `1.22.x` | GitLab 17.1以降では、Go 1.22以降が必要です。 | -| [Git](#git) | `2.47.x` | GitLab 17.7以降では、Git 2.47.x以降が必要です。[Gitalyから提供されるGitバージョン](#git)を使用する必要があります。 | -| [Node.js](#5-node) | `20.13.x` | GitLab 17.0以降では、Node.js 20.13以降が必要です。 | -| [PostgreSQL](#7-database) | `14.x` | GitLab 17.0以降では、PostgreSQL 14以降が必要です。 | - -## GitLabディレクトリ構造 - -インストール手順を実行すると、次のディレクトリが作成されます。 - -```plaintext -|-- home -| |-- git -| |-- .ssh -| |-- gitlab -| |-- gitlab-shell -| |-- repositories -``` - -- `/home/git/.ssh` - OpenSSH設定が含まれています。具体的には、GitLab Shellによって管理される`authorized_keys`ファイルです。 -- `/home/git/gitlab` - GitLabコアソフトウェア。 -- `/home/git/gitlab-shell` - GitLabのコアアドオンコンポーネント。SSHクローンやその他の機能を維持します。 -- `/home/git/repositories` - ネームスペースで整理されたすべてのプロジェクトのベアリポジトリ。これは、プッシュ/プルされるGitリポジトリがすべてのプロジェクトで維持される場所です。**この領域には、プロジェクトの重要なデータが含まれています。[バックアップを保持します](../administration/backup_restore/_index.md)。** - -リポジトリのデフォルトの場所は、GitLabの`config/gitlab.yml`とGitLab Shellの`config.yml`で構成できます。 - -これらのディレクトリを手動で作成する必要はありません。作成すると、インストールの後半でエラーが発生する可能性があります。 - -詳細な概要については、[GitLabアーキテクチャドキュメント](../development/architecture.md)を参照してください。 - -## 概要 - -GitLabのインストールは、次のコンポーネントの設定で構成されています。 - -1. [パッケージと依存関係](#1-packages-and-dependencies)。 -1. [Ruby](#2-ruby)。 -1. [RubyGems](#3-rubygems)。 -1. [Go](#4-go)。 -1. [ノード](#5-node)。 -1. [システムユーザー](#6-system-users)。 -1. [データベース](#7-database)。 -1. [Redis](#8-redis)。 -1. [GitLab](#9-gitlab)。 -1. [NGINX](#10-nginx)。 - -## 1. パッケージと依存関係 - -### sudo - -`sudo`は、デフォルトではDebianにインストールされていません。システムが最新であることを確認し、インストールします。 - -```shell -# run as root! -apt-get update -y -apt-get upgrade -y -apt-get install sudo -y -``` - -### ビルドの依存関係 - -必要なパッケージ（Rubyおよびネイティブ拡張機能をRuby gemにコンパイルするために必要）をインストールします。 - -```shell -sudo apt-get install -y build-essential zlib1g-dev libyaml-dev libssl-dev libgdbm-dev libre2-dev \ - libreadline-dev libncurses5-dev libffi-dev curl openssh-server libxml2-dev libxslt-dev \ - libcurl4-openssl-dev libicu-dev libkrb5-dev logrotate rsync python3-docutils pkg-config cmake \ - runit-systemd -``` - -{{< alert type="note" >}} - -GitLabにはOpenSSLバージョン1.1が必要です。Linuxディストリビューションに異なるバージョンのOpenSSLが含まれている場合は、1.1を手動でインストールする必要があるかもしれません。 - -{{< /alert >}} - -### Git - -次の[Gitalyから提供されるGitバージョン](https://gitlab.com/gitlab-org/gitaly/-/issues/2729)を使用する必要があります。 - -- GitLabに必要なバージョン。 -- 適切な動作に必要なカスタムパッチが含まれている。 - -1. 必要な依存関係をインストールします。 - - ```shell - sudo apt-get install -y libcurl4-openssl-dev libexpat1-dev gettext libz-dev libssl-dev libpcre2-dev build-essential git-core - ``` - -1. Gitalyリポジトリをクローンし、Gitをコンパイルします。インストールするGitLabバージョンに一致する安定したブランチで``を置き換えます。たとえば、GitLab 16.7をインストールする場合は、ブランチ名`16-7-stable`を使用します。 - - ```shell - git clone https://gitlab.com/gitlab-org/gitaly.git -b /tmp/gitaly - cd /tmp/gitaly - sudo make git GIT_PREFIX=/usr/local - ``` - -1. オプションで、システムGitとその依存関係を削除できます。 - - ```shell - sudo apt remove -y git-core - sudo apt autoremove - ``` - -[後で`config/gitlab.yml`を編集](#configure-it)する場合は、Gitパスを変更することを忘れないでください。 - -- 変更前: - - ```yaml - git: - bin_path: /usr/bin/git - ``` - -- 変更後: - - ```yaml - git: - bin_path: /usr/local/bin/git - ``` - -### GraphicsMagick - -[カスタムファビコン](../administration/appearance.md#customize-the-favicon)を機能させるには、GraphicsMagickをインストールする必要があります。 - -```shell -sudo apt-get install -y graphicsmagick -``` - -### メールサーバー - -メール通知を受信するには、メールサーバーがインストールされていることを確認してください。デフォルトでは、Debianには`exim4`が付属していますが、これには[問題があり](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/12754)、Ubuntuには付属していません。推奨されるメールサーバーは`postfix`であり、次の方法でインストールできます。 - -```shell -sudo apt-get install -y postfix -``` - -次に、Internet Site（インターネットサイト）を選択し、Enterキーを押してホスト名を確認します。 - -### ExifTool - -[GitLab Workhorse](https://gitlab.com/gitlab-org/gitlab-workhorse#dependencies)には、アップロードされた画像からEXIFデータを削除するために`exiftool`が必要です。 - -```shell -sudo apt-get install -y libimage-exiftool-perl -``` - -## 2. Ruby - -GitLabを実行するには、Rubyインタプリタが必要です。最小Ruby要件については、[要件のセクション](#software-requirements)を参照してください。 - -本番環境のGitLabで[`RVM`](https://rvm.io/)、[`rbenv`](https://github.com/rbenv/rbenv)、[`chruby`](https://github.com/postmodern/chruby)などのRubyバージョンマネージャーを使用すると、診断が難しい問題が発生することがよくあります。バージョンマネージャーはサポートされておらず、システムRubyを使用するには、以下の指示に従うことを強くおすすめします。 - -Linuxディストリビューションには通常、以前のバージョンのRubyが用意されているため、これらの手順は公式ソースコードからRubyをインストールするように設計されています。 - -[Rubyをインストールします](https://www.ruby-lang.org/en/documentation/installation/)。 - -## 3. RubyGems - -Rubyに同梱されているよりも新しいバージョンのRubyGemsが必要になる場合があります。 - -特定のバージョンに更新するには: - -```shell -gem update --system 3.4.12 -``` - -または最新バージョンに更新するには: - -```shell -gem update --system -``` - -## 4. Go - -GitLabには、Goで記述されたいくつかのデーモンがあります。GitLabをインストールするには、Goコンパイラが必要です。以下の手順では、64ビットLinuxを使用していることを前提としています。他のプラットフォームのダウンロードは、[Goダウンロードページ](https://go.dev/dl/)にあります。 - -```shell -# Remove former Go installation folder -sudo rm -rf /usr/local/go - -curl --remote-name --location --progress-bar "https://go.dev/dl/go1.22.5.linux-amd64.tar.gz" -echo '904b924d435eaea086515bc63235b192ea441bd8c9b198c507e85009e6e4c7f0 go1.22.5.linux-amd64.tar.gz' | shasum -a256 -c - && \ - sudo tar -C /usr/local -xzf go1.22.5.linux-amd64.tar.gz -sudo ln -sf /usr/local/go/bin/{go,gofmt} /usr/local/bin/ -rm go1.22.5.linux-amd64.tar.gz -``` - -## 5. Node - -GitLabでは、JavaScriptアセットをコンパイルするためにNodeを使用し、JavaScriptの依存関係を管理するためにYarnを使用する必要があります。これらの現在の最小要件は次のとおりです。 - -- `node` 20.xリリース（v20.13.0以降）。[Node.jsのその他のLTSバージョン](https://github.com/nodejs/release#release-schedule)はアセットを構築できるかもしれませんが、Node.js 20.xのみを保証します。 -- `yarn`= v1.22.x（Yarn 2はまだサポートされていません） - -多くのディストリビューションでは、公式パッケージリポジトリによって提供されるバージョンが古くなっているため、次のコマンドを使用してインストールする必要があります。 - -```shell -# install node v20.x -curl --location "https://deb.nodesource.com/setup_20.x" | sudo bash - -sudo apt-get install -y nodejs - -npm install --global yarn -``` - -これらの手順で問題が発生した場合は、[node](https://nodejs.org/en/download)および[yarn](https://classic.yarnpkg.com/en/docs/install/)の公式ウェブサイトにアクセスしてください。 - -## 6. システムユーザー - -GitLabの`git`ユーザーを作成します。 - -```shell -sudo adduser --disabled-login --gecos 'GitLab' git -``` - -## 7. データベース - -{{< alert type="note" >}} - -PostgreSQLのみがサポートされています。GitLab 17.0以降では、[PostgreSQL 14+が必要](requirements.md#postgresql)です。 - -{{< /alert >}} - -1. データベースパッケージをインストールします。 - - Ubuntu 22.04以降の場合: - - ```shell - sudo apt install -y postgresql postgresql-client libpq-dev postgresql-contrib - ``` - - Ubuntu 20.04以前の場合、利用可能なPostgreSQLは最小バージョン要件を満たしていません。PostgreSQLリポジトリを追加する必要があります。 - - ```shell - sudo sh -c 'echo "deb https://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list' - wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add - - sudo apt-get update - sudo apt-get -y install postgresql-14 - ``` - -1. インストールしているGitLabのバージョンでサポートされているPostgreSQLバージョンを確認します。 - - ```shell - psql --version - ``` - -1. PostgreSQLサービスを開始し、サービスが実行されていることを確認します。 - - ```shell - sudo service postgresql start - sudo service postgresql status - ``` - -1. GitLabのデータベースユーザーを作成します。 - - ```shell - sudo -u postgres psql -d template1 -c "CREATE USER git CREATEDB;" - ``` - -1. `pg_trgm`拡張機能を作成します。 - - ```shell - sudo -u postgres psql -d template1 -c "CREATE EXTENSION IF NOT EXISTS pg_trgm;" - ``` - -1. `btree_gist`拡張機能を作成します。 - - ```shell - sudo -u postgres psql -d template1 -c "CREATE EXTENSION IF NOT EXISTS btree_gist;" - ``` - -1. `plpgsql`拡張機能を作成します。 - - ```shell - sudo -u postgres psql -d template1 -c "CREATE EXTENSION IF NOT EXISTS plpgsql;" - ``` - -1. GitLab本番環境のデータベースを作成し、データベースに対するすべての特権を付与します。 - - ```shell - sudo -u postgres psql -d template1 -c "CREATE DATABASE gitlabhq_production OWNER git;" - ``` - -1. 新しいユーザーで新しいデータベースへの接続を試みます。 - - ```shell - sudo -u git -H psql -d gitlabhq_production - ``` - -1. `pg_trgm`拡張機能が有効であるかを確認します。 - - ```sql - SELECT true AS enabled - FROM pg_available_extensions - WHERE name = 'pg_trgm' - AND installed_version IS NOT NULL; - ``` - - 拡張機能が有効である場合、次の出力が生成されます。 - - ```plaintext - enabled - --------- - t - (1 row) - ``` - -1. `btree_gist`拡張機能が有効であるかを確認します。 - - ```sql - SELECT true AS enabled - FROM pg_available_extensions - WHERE name = 'btree_gist' - AND installed_version IS NOT NULL; - ``` - - 拡張機能が有効である場合、次の出力が生成されます。 - - ```plaintext - enabled - --------- - t - (1 row) - ``` - -1. `plpgsql`拡張機能が有効であるかを確認します。 - - ```sql - SELECT true AS enabled - FROM pg_available_extensions - WHERE name = 'plpgsql' - AND installed_version IS NOT NULL; - ``` - - 拡張機能が有効である場合、次の出力が生成されます。 - - ```plaintext - enabled - --------- - t - (1 row) - ``` - -1. データベースセッションを終了します。 - - ```shell - gitlabhq_production> \q - ``` - -## 8. Redis - -最小Redis要件については、[要件ページ](requirements.md#redis)を参照してください。 - -次でRedisをインストールします。 - -```shell -sudo apt-get install redis-server -``` - -完了したら、Redisを設定できます。 - -```shell -# Configure redis to use sockets -sudo cp /etc/redis/redis.conf /etc/redis/redis.conf.orig - -# Disable Redis listening on TCP by setting 'port' to 0 -sudo sed 's/^port .*/port 0/' /etc/redis/redis.conf.orig | sudo tee /etc/redis/redis.conf - -# Enable Redis socket for default Debian / Ubuntu path -echo 'unixsocket /var/run/redis/redis.sock' | sudo tee -a /etc/redis/redis.conf - -# Grant permission to the socket to all members of the redis group -echo 'unixsocketperm 770' | sudo tee -a /etc/redis/redis.conf - -# Add git to the redis group -sudo usermod -aG redis git -``` - -### systemdでRedisを管理する - -ディストリビューションがsystemd initを使用し、次のコマンドの出力が`notify`の場合、変更を加えないでください。 - -```shell -systemctl show --value --property=Type redis-server.service -``` - -出力が`notify`**でない**場合は、以下を実行します。 - -```shell -# Configure Redis to not daemonize, but be supervised by systemd instead and disable the pidfile -sudo sed -i \ - -e 's/^daemonize yes$/daemonize no/' \ - -e 's/^supervised no$/supervised systemd/' \ - -e 's/^pidfile/# pidfile/' /etc/redis/redis.conf -sudo chown redis:redis /etc/redis/redis.conf - -# Make the same changes to the systemd unit file -sudo mkdir -p /etc/systemd/system/redis-server.service.d -sudo tee /etc/systemd/system/redis-server.service.d/10fix_type.conf < gitlab -``` - -Enterpriseエディションのクローンを作成する - -```shell -# Clone GitLab repository -sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab.git -b gitlab -``` - -インストールするバージョンに一致する安定したブランチで``を必ず置き換えてください。たとえば、11.8をインストールする場合は、ブランチ名`11-8-stable`を使用します。 - -{{< alert type="warning" >}} - -*最新の*バージョンが必要な場合は``を`master`に変更できますが、本番環境サーバーに`master`をインストールしないでください。 - -{{< /alert >}} - -### 設定する - -```shell -# Go to GitLab installation folder -cd /home/git/gitlab - -# Copy the example GitLab config -sudo -u git -H cp config/gitlab.yml.example config/gitlab.yml - -# Update GitLab config file, follow the directions at top of the file -sudo -u git -H editor config/gitlab.yml - -# Copy the example secrets file -sudo -u git -H cp config/secrets.yml.example config/secrets.yml -sudo -u git -H chmod 0600 config/secrets.yml - -# Make sure GitLab can write to the log/ and tmp/ directories -sudo chown -R git log/ -sudo chown -R git tmp/ -sudo chmod -R u+rwX,go-w log/ -sudo chmod -R u+rwX tmp/ - -# Make sure GitLab can write to the tmp/pids/ and tmp/sockets/ directories -sudo chmod -R u+rwX tmp/pids/ -sudo chmod -R u+rwX tmp/sockets/ - -# Create the public/uploads/ directory -sudo -u git -H mkdir -p public/uploads/ - -# Make sure only the GitLab user has access to the public/uploads/ directory -# now that files in public/uploads are served by gitlab-workhorse -sudo chmod 0700 public/uploads - -# Change the permissions of the directory where CI job logs are stored -sudo chmod -R u+rwX builds/ - -# Change the permissions of the directory where CI artifacts are stored -sudo chmod -R u+rwX shared/artifacts/ - -# Change the permissions of the directory where GitLab Pages are stored -sudo chmod -R ug+rwX shared/pages/ - -# Copy the example Puma config -sudo -u git -H cp config/puma.rb.example config/puma.rb - -# Refer to https://github.com/puma/puma#configuration for more information. -# You should scale Puma workers and threads based on the number of CPU -# cores you have available. You can get that number via the `nproc` command. -sudo -u git -H editor config/puma.rb - -# Configure Redis connection settings -sudo -u git -H cp config/resque.yml.example config/resque.yml -sudo -u git -H cp config/cable.yml.example config/cable.yml - -# Change the Redis socket path if you are not using the default Debian / Ubuntu configuration -sudo -u git -H editor config/resque.yml config/cable.yml -``` - -必ず`gitlab.yml`と`puma.rb`の両方を編集して、セットアップと一致するようにしてください。 - -HTTPSを使用する場合は、追加の手順について[HTTPSの使用](#using-https)を参照してください。 - -### GitLab DB設定を構成する - -{{< alert type="note" >}} - -[GitLab 15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/387898)以降、セクションが`main:`のみの`database.yml`は非推奨になりました。GitLab 17.0以降では、`database.yml`に`main:`セクションと`ci:`セクションの2つが必要です。 - -{{< /alert >}} - -```shell -sudo -u git cp config/database.yml.postgresql config/database.yml - -# Remove host, username, and password lines from config/database.yml. -# Once modified, the `production` settings will be as follows: -# -# production: -# main: -# 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 - -# Remote PostgreSQL only: -# Update username/password in config/database.yml. -# You only need to adapt the production settings (first part). -# If you followed the database guide then please do as follows: -# Change 'secure password' with the value you have given to $password -# You can keep the double quotes around the password -sudo -u git -H editor config/database.yml - -# Uncomment the `ci:` sections in config/database.yml. -# Ensure the `database` value in `ci:` matches the database value in `main:`. - -# Make config/database.yml readable to git only -sudo -u git -H chmod o-rwx config/database.yml -``` - -`database.yml`には、`main:`と`ci:`の2つのセクションが必要です。`ci`:接続は、[同じデータベースへの接続](../administration/postgresql/multiple_databases.md)である必要があります。 - -### Gemsをインストールする - -{{< alert type="note" >}} - -Bundler 1.5.2以降では、`bundle install -jN`（`N`はプロセッサコアの数）を実行することで、gemの並列インストールを完了するのにかかる時間をかなり短縮（約60%高速）できます。`nproc`でコア数を確認してください。詳細については、[こちらの投稿](https://thoughtbot.com/blog/parallel-gem-installing-using-bundler)を参照してください。 - -{{< /alert >}} - -`bundle`があることを確認してください（`bundle -v`を実行）。 - -- `>= 1.5.2`、一部の[イシュー](https://devcenter.heroku.com/changelog-items/411)は1.5.2で[修正](https://github.com/rubygems/bundler/pull/2817)されたためです。 -- `< 2.x`。 - -ユーザー認証にKerberosを使用する場合は、以下の`--without`オプションで`kerberos`を省略して、gemをインストールします。 - -```shell -sudo -u git -H bundle config set --local deployment 'true' -sudo -u git -H bundle config set --local without 'development test kerberos' -sudo -u git -H bundle config path /home/git/gitlab/vendor/bundle -sudo -u git -H bundle install -``` - -### GitLab Shellをインストールする - -GitLab Shellは、GitLabに特別に開発されたSSHアクセスおよびリポジトリ管理ソフトウェアです。 - -```shell -# Run the installation task for gitlab-shell: -sudo -u git -H bundle exec rake gitlab:shell:install RAILS_ENV=production - -# By default, the gitlab-shell config is generated from your main GitLab config. -# You can review (and modify) the gitlab-shell config as follows: -sudo -u git -H editor /home/git/gitlab-shell/config.yml -``` - -HTTPSを使用する場合は、追加の手順について[HTTPSの使用](#using-https)を参照してください。 - -適切なDNSレコードまたは`/etc/hosts`の追加の行（「127.0.0.1ホスト名」）のいずれかによって、ホスト名をマシン自体で解決できることを確認してください。これは、たとえば、リバースプロキシの背後にGitLabを設定する場合に必要になる場合があります。ホスト名を解決できない場合、最終的なインストールチェックは`Check GitLab API access: FAILED. code: 401`で失敗し、コミットのプッシュは`[remote rejected] master -> master (hook declined)`で拒否されます。 - -### GitLab Workhorseをインストールする - -GitLab-Workhorseは[GNU Make](https://www.gnu.org/software/make/)を使用します。次のコマンドラインを使うと、推奨される場所である`/home/git/gitlab-workhorse`にGitLab-Workhorseをインストールします。 - -```shell -sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse]" RAILS_ENV=production -``` - -追加のパラメーターとして指定することで、別のGitリポジトリを指定できます。 - -```shell -sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse,https://example.com/gitlab-workhorse.git]" RAILS_ENV=production -``` - -### EnterpriseエディションにGitLab-Elasticsearch-indexerをインストールする - -{{< details >}} - -- プラン: Premium、Ultimate -- 製品: GitLab Self-Managed - -{{< /details >}} - -GitLab-Elasticsearch-Indexerは[GNU Make](https://www.gnu.org/software/make/)を使用します。次のコマンドラインを使うと、推奨される場所である`/home/git/gitlab-elasticsearch-indexer`にGitLab-Elasticsearch-Indexerをインストールします。 - -```shell -sudo -u git -H bundle exec rake "gitlab:indexer:install[/home/git/gitlab-elasticsearch-indexer]" RAILS_ENV=production -``` - -追加のパラメーターとして指定することで、別のGitリポジトリを指定できます。 - -```shell -sudo -u git -H bundle exec rake "gitlab:indexer:install[/home/git/gitlab-elasticsearch-indexer,https://example.com/gitlab-elasticsearch-indexer.git]" RAILS_ENV=production -``` - -ソースコードはまず、最初のパラメーターで指定されたパスにフェッチされます。次に、その`bin`ディレクトリの下にバイナリが構築されます。その後、`gitlab.yml`の`production -> elasticsearch -> indexer_path`設定を更新して、そのバイナリを指すようにします。 - -### GitLab Pagesをインストールする - -GitLab Pagesは[GNU Make](https://www.gnu.org/software/make/)を使用します。この手順はオプションであり、GitLab内から静的サイトをホストする場合にのみ必要です。次のコマンドを使うと、`/home/git/gitlab-pages`にGitLab Pagesをインストールします。追加の設定手順については、GitLab Pagesデーモンはいくつかの異なる方法で実行できるため、お使いのバージョンのGitLabの[管理ガイド](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/administration/pages/source.md)を参照してください。 - -```shell -cd /home/git -sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git -cd gitlab-pages -sudo -u git -H git checkout v$(.d/override.conf`にドロップイン設定ファイルをインストールするため、後でユニットファイルを更新するときにローカル設定が上書きされることはありません。ドロップイン設定ファイルを分割するには、`/etc/systemd/system/.d/`にある`.conf`ファイルに上記のコードスニペットを追加します。 - -`systemctl edit`を使用せずに、ユニットファイルを手動で変更した場合、またはドロップイン設定ファイルを追加した場合は、次のコマンドを実行して有効にします。 - -```shell -sudo systemctl daemon-reload -``` - -ブート時にGitLabを起動させます。 - -```shell -sudo systemctl enable gitlab.target -``` - -#### SysV initスクリプトをインストールする - -SysV initスクリプトを使用する場合は、次の手順を実行します。systemdを使用する場合は、[systemdユニットの手順](#install-systemd-units)に従ってください。 - -initスクリプト(`/etc/init.d/gitlab`)をダウンロードします。 - -```shell -cd /home/git/gitlab -sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab -``` - -また、デフォルト以外のフォルダまたはユーザーでインストールする場合は、defaultsファイルをコピーして編集します。 - -```shell -sudo cp lib/support/init.d/gitlab.default.example /etc/default/gitlab -``` - -GitLabを別のディレクトリにインストールした場合、またはデフォルト以外のユーザーとしてインストールした場合は、`/etc/default/gitlab`でこれらの設定を変更する必要があります。アップグレード時に変更されるため、`/etc/init.d/gitlab`を編集しないでください。 - -ブート時にGitLabを起動させます。 - -```shell -sudo update-rc.d gitlab defaults 21 -# or if running this on a machine running systemd -sudo systemctl daemon-reload -sudo systemctl enable gitlab.service -``` - -### Logrotateを設定する - -```shell -sudo cp lib/support/logrotate/gitlab /etc/logrotate.d/gitlab -``` - -### Gitalyを起動する - -次のセクションでは、Gitalyが実行されている必要があります。 - -- systemdを使用してGitalyを起動するには: - - ```shell - sudo systemctl start gitlab-gitaly.service - ``` - -- SysV用にGitalyを手動で起動するには: - - ```shell - gitlab_path=/home/git/gitlab - gitaly_path=/home/git/gitaly - - sudo -u git -H sh -c "$gitlab_path/bin/daemon_with_pidfile $gitlab_path/tmp/pids/gitaly.pid \ - $gitaly_path/_build/bin/gitaly $gitaly_path/config.toml >> $gitlab_path/log/gitaly.log 2>&1 &" - ``` - -### データベースを初期化して高度な機能をアクティブにする - -```shell -cd /home/git/gitlab -sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production -# Type 'yes' to create the database tables. - -# or you can skip the question by adding force=yes -sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production force=yes - -# When done, you see 'Administrator account created:' -``` - -以下の例に示すように、環境変数`GITLAB_ROOT_PASSWORD`および`GITLAB_ROOT_EMAIL`で管理者/rootパスワードとメールアドレスを設定できます。パスワードを設定しない（デフォルトのパスワードに設定されている）場合は、インストールが完了し、最初にサーバーにログインするまで、GitLabをパブリックインターネットに公開しないでください。最初のログイン時に、デフォルトのパスワードの変更が強制されます。Enterpriseエディションサブスクリプションは、このとき、`GITLAB_ACTIVATION_CODE`環境変数にアクティベーションコードを指定してアクティブにすることもできます。 - -```shell -sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production GITLAB_ROOT_PASSWORD=yourpassword GITLAB_ROOT_EMAIL=youremail GITLAB_ACTIVATION_CODE=yourcode -``` - -### `secrets.yml`をセキュアにする - -`secrets.yml`ファイルには、セッションとセキュア変数の暗号化キーが格納されています。`secrets.yml`を安全な場所にバックアップしますが、データベースのバックアップと同じ場所に保存しないでください。そうしないと、バックアップのいずれかが侵害された場合に、シークレットが公開されます。 - -### アプリケーションの状態を確認する - -GitLabとその環境が正しく設定されているかどうかを確認します。 - -```shell -sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production -``` - -### アセットをコンパイルする - -```shell -sudo -u git -H yarn install --production --pure-lockfile -sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production NODE_ENV=production -``` - -`rake`が`JavaScript heap out of memory`エラーで失敗する場合は、次のように`NODE_OPTIONS`設定して実行してみてください。 - -```shell -sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production NODE_ENV=production NODE_OPTIONS="--max_old_space_size=4096" -``` - -### GitLabインスタンスを起動する - -```shell -# For systems running systemd -sudo systemctl start gitlab.target - -# For systems running SysV init -sudo service gitlab start -``` - -## 10. NGINX - -NGINXは、GitLabで公式にサポートされているウェブサーバーです。ウェブサーバーとしてNGINXを使用できない場合、または使用したくない場合は、[GitLabレシピ](https://gitlab.com/gitlab-org/gitlab-recipes/)を参照してください。 - -### インストール - -```shell -sudo apt-get install -y nginx -``` - -### サイトの設定 - -サイト設定の例をコピーします。 - -```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 -``` - -セットアップに合わせて設定ファイルを編集してください。特に `git`ユーザー以外のユーザー用にインストールする場合は、GitLabへのパスが一致していることを確認してください。 - -```shell -# Change YOUR_SERVER_FQDN to the fully-qualified -# domain name of your host serving GitLab. -# -# Remember to match your paths to GitLab, especially -# if installing for a user other than 'git'. -# -# If using Ubuntu default nginx install: -# either remove the default_server from the listen line -# or else sudo rm -f /etc/nginx/sites-enabled/default -sudo editor /etc/nginx/sites-available/gitlab -``` - -GitLab Pagesを有効にする場合は、別途NGINX設定を使用する必要があります。すべての必要な設定について、[GitLab Pages管理ガイド](../administration/pages/_index.md)をお読みください。 - -HTTPSを使用する場合は、`gitlab`NGINX設定を`gitlab-ssl`に置き換えます。HTTPS設定の詳細については、[HTTPSの使用](#using-https)を参照してください。 - -NGINXがGitLab-Workhorseソケットを読み取れるようにするには、GitLabユーザーが所有するソケットを`www-data`ユーザーが読み取れるようにする必要があります。これは、グローバルに読み取り可能である場合（たとえば、デフォルトで`0755`の権限を持っている場合）に実現できます。`www-data`は、親ディレクトリをリストできる必要もあります。 - -### 設定をテストする - -次のコマンドを使用して、`gitlab`または`gitlab-ssl`NGINX設定ファイルを検証します。　 - -```shell -sudo nginx -t -``` - -`syntax is okay`および`test is successful`メッセージが表示されるはずです。エラーメッセージが表示される場合は、そこに示されているように、`gitlab`または`gitlab-ssl`NGINX設定ファイルにタイプミスがないか確認してください。 - -インストールされているバージョンが1.12.1以降であることを確認します。 - -```shell -nginx -v -``` - -それより前の場合は、次のエラーが表示されることがあります。 - -```plaintext -nginx: [emerg] unknown "start$temp=[filtered]$rest" variable -nginx: configuration file /etc/nginx/nginx.conf test failed -``` - -### 再起動 - -```shell -# For systems running systemd -sudo systemctl restart nginx.service - -# For systems running SysV init -sudo service nginx restart -``` - -## インストール後 - -### アプリケーションの状態を再確認 - -何か見落としがないか確認するには、次のコマンドでより徹底的なチェックを実行します。 - -```shell -sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production -``` - -すべての項目が緑色の場合は、GitLabのインストールに成功しました。 - -{{< alert type="note" >}} - -チェックコマンドの出力からプロジェクト名を省略するには、`SANITIZE=true`環境変数を`gitlab:check`に指定します。 - -{{< /alert >}} - -### 最初のログイン - -GitLabに初めてログインするには、ウェブブラウザでYOUR_SERVERにアクセスします。 - -[セットアップ中にrootパスワードを指定](#initialize-database-and-activate-advanced-features)しなかった場合は、パスワードリセット画面にリダイレクトされ、最初の管理者アカウントのパスワードを指定するように求められます。希望するパスワードを入力すると、ログイン画面にリダイレクトされます。 - -デフォルトのアカウントのユーザー名は**root**です。作成したパスワードを入力してログインします。ログイン後、必要に応じてユーザー名を変更できます。 - -**ご利用可能になりました** - -以下を使用するときにGitLabを起動および停止するには: - -- systemdユニット: `sudo systemctl start gitlab.target`または`sudo systemctl stop gitlab.target`を使用します。 -- SysV initスクリプト: `sudo service gitlab start`または`sudo service gitlab stop`を使用します。 - -### 推奨される次の手順 - -インストールが完了したら、[推奨される次の手順](next_steps.md)（認証オプションやサインアップ制限など）を実行することを検討してください。 - -## 高度な設定のヒント - -### 相対URLのサポート - -相対URLでGitLabを設定する方法の詳細については、[相対URLドキュメント](relative_url.md)を参照してください。 - -### HTTPSを使用する - -HTTPSでGitLabを使用するには: - -1. `gitlab.yml`で: - 1. セクション1の`port`オプションを`443`に設定します。 - 1. セクション1の`https`オプションを`true`に設定します。 -1. GitLab Shellの`config.yml`で: - 1. `gitlab_url`オプションをGitLabのHTTPSエンドポイント（たとえば、`https://git.example.com`）に設定します。 - 1. `ca_file`または`ca_path`オプションのいずれかを使用して証明書を設定します。 -1. `gitlab`設定ではなく、`gitlab-ssl`NGINXのサンプル設定を使用します。 - 1. `YOUR_SERVER_FQDN`を更新します。 - 1. `ssl_certificate`と`ssl_certificate_key`を更新します。 - 1. 設定ファイルを確認し、他のセキュリティおよびパフォーマンス強化機能の適用を検討してください。 - -自己署名証明書を使用することはおすすめできません。どうしても使用する必要がある場合は、標準的な指示に従って自己署名SSL証明書を生成します。 - - ```shell - mkdir -p /etc/nginx/ssl/ - cd /etc/nginx/ssl/ - sudo openssl req -newkey rsa:2048 -x509 -nodes -days 3560 -out gitlab.crt -keyout gitlab.key - sudo chmod o-r gitlab.key - ``` - -### メールによる返信を有効にする - -この設定方法の詳細については、[「メールで返信」ドキュメント](../administration/reply_by_email.md)を参照してください。 - -### LDAP認証 - -`config/gitlab.yml`でLDAP認証を設定できます。このファイルを編集した後、GitLabを再起動します。 - -### カスタムOmniAuthプロバイダーを使用する - -[OmniAuthインテグレーションドキュメント](../integration/omniauth.md)を参照してください。 - -### プロジェクトをビルドする - -GitLabではプロジェクトをビルドできます。その機能を有効にするには、それを行うためのRunnerが必要です。Runnerをインストールするには、[GitLab Runnerセクション](https://docs.gitlab.com/runner/)を参照してください。 - -### 信頼できるプロキシを追加する - -別のマシンでリバースプロキシを使用している場合は、プロキシを信頼できるプロキシリストに追加することをお勧めします。そうしないと、ユーザーはプロキシのIPアドレスからサインインしたように表示されます。 - -`config/gitlab.yml`で、セクション1の`trusted_proxies`オプションをカスタマイズすることにより、信頼できるプロキシを追加できます。ファイルを保存し、変更を有効にするために[GitLabを再構成](../administration/restart_gitlab.md)します。 - -URLで不適切にエンコードされた文字に関する問題が発生した場合は、[エラー: リバースプロキシの使用時に`404 Not Found`](../api/rest/troubleshooting.md#error-404-not-found-when-using-a-reverse-proxy)を参照してください。 - -### カスタムRedis接続 - -非標準ポートまたは別のホストでRedisサーバーに接続する場合は、`config/resque.yml`ファイルを使用して接続文字列を設定できます。 - -```yaml -# example -production: - url: redis://redis.example.tld:6379 -``` - -ソケット経由でRedisサーバーに接続する場合は、`unix:`URLスキームと、`config/resque.yml`ファイル内のRedisソケットファイルへのパスを使用します。 - -```yaml -# example -production: - url: unix:/path/to/redis/socket -``` - -また、`config/resque.yml`ファイルで環境変数を使用することもできます。 - -```yaml -# example -production: - url: <%= ENV.fetch('GITLAB_REDIS_URL') %> -``` - -### カスタムSSH接続 - -非標準ポートでSSHを実行している場合は、GitLabユーザーのSSH設定を変更する必要があります。 - -```plaintext -# Add to /home/git/.ssh/config -host localhost # Give your setup a name (here: override localhost) - user git # Your remote git user - port 2222 # Your port number - hostname 127.0.0.1; # Your server name or IP -``` - -また、`config/gitlab.yml`ファイルで対応するオプション（`ssh_user`、`ssh_host`、`admin_uri` など）も変更する必要があります。 - -### 追加のマークアップスタイル - -常にサポートされているMarkdownスタイルとは別に、GitLabが表示できるリッチテキストファイルが他にもあります。ただし、これを行うには、依存関係をインストールする必要がある場合があります。詳細については、[`github-markup`gemのREADME](https://github.com/gitlabhq/markup#markups)を参照してください。 - -### Prometheusサーバーの設定 - -`config/gitlab.yml`でPrometheusサーバーを設定できます。 - -```yaml -# example -prometheus: - enabled: true - server_address: '10.1.2.3:9090' -``` - -## トラブルシューティング - -### 「空のリポジトリを複製したようです」 - -GitLabがホストするリポジトリを複製しようとしたときにこのメッセージが表示される場合、これは、NGINXまたはApacheの設定が古くなっているか、GitLab Workhorseインスタンスがないか、誤って構成されていることが原因である可能性があります。[Goをインストール](#4-go)し、[GitLab Workhorseをインストール](#install-gitlab-workhorse)し、[NGINXを正しく設定](#site-configuration)したことを再確認してください。 - -### `google-protobuf`「LoadError: /lib/x86_64-linux-gnu/libc.so.6: バージョン 'GLIBC_2.14' が見つかりません」 - -これは、一部のバージョンの`google-protobuf` gemを使うプラットフォームで発生する可能性があります。回避策は、このgemのソースのみのバージョンをインストールすることです。 - -まず、GitLabインストールに必要な`google-protobuf`の正確なバージョンを見つける必要があります。 - -```shell -cd /home/git/gitlab - -# Only one of the following two commands will print something. It -# will look like: * google-protobuf (3.2.0) -bundle list | grep google-protobuf -bundle check | grep google-protobuf -``` - -以下に、`3.2.0`を例として使用します。上記で見つけたバージョン番号に置き換えます。 - -```shell -cd /home/git/gitlab -sudo -u git -H gem install google-protobuf --version 3.2.0 --platform ruby -``` - -最後に、`google-protobuf`が正しく読み込まれるかどうかをテストできます。次は「OK」と表示されるはずです。 - -```shell -sudo -u git -H bundle exec ruby -rgoogle/protobuf -e 'puts :OK' -``` - -`gem install`コマンドが失敗する場合は、OSの開発ツールをインストールする必要があるかもしれません。 - -Debian/Ubuntuの場合: - -```shell -sudo apt-get install build-essential libgmp-dev -``` - -RedHat/CentOSの場合: - -```shell -sudo yum groupinstall 'Development Tools' -``` - -### GitLabアセットのコンパイルエラー - -アセットをコンパイル中に、次のエラーメッセージが表示されることがあります。 - -```plaintext -Killed -error Command failed with exit code 137. -``` - -これは、Yarnがメモリ不足で実行されているコンテナを強制終了した場合に発生する可能性があります。これを修正するには: - -1. システムのメモリを8 GB以上に増やします。 - -1. 次のコマンドを実行して、アセットをクリーンアップします。 - - ```shell - sudo -u git -H bundle exec rake gitlab:assets:clean RAILS_ENV=production NODE_ENV=production - ``` - -1. `yarn`コマンドを再度実行して、競合を解決します。 - - ```shell - sudo -u git -H yarn install --production --pure-lockfile - ``` - -1. アセットを再コンパイルします。 - - ```shell - sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production NODE_ENV=production - ``` + + + + diff --git a/doc-locale/ja-jp/install/self_compiled/_index.md b/doc-locale/ja-jp/install/self_compiled/_index.md new file mode 100644 index 0000000000000000000000000000000000000000..bcd351ecbc37dd29f991225e38ad714e0a8f95cf --- /dev/null +++ b/doc-locale/ja-jp/install/self_compiled/_index.md @@ -0,0 +1,1191 @@ +--- +stage: Systems +group: Distribution +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments +title: 自己コンパイルによるインストール +--- + +{{< details >}} + +- プラン: Free、Premium、Ultimate +- 製品: GitLab Self-Managed + +{{< /details >}} + +これは、ソースファイルを使用して本番環境GitLabサーバーをセットアップするための公式インストールガイドです。**Debian/Ubuntu**オペレーティングシステム用に作成され、テストされています。ハードウェアとオペレーティングシステムの要件については、[requirements.md](requirements.md)をお読みください。RHEL/CentOSにインストールする場合は、[Linuxパッケージ](https://about.gitlab.com/install/)を使用する必要があります。その他の多くのインストールオプションについては、[インストールのメインページ](_index.md)を参照してください。 + +このガイドが長いのは、多くのケースを網羅し、必要なすべてのコマンドが含まれているためです。[これは、実際そのまま使用できる数少ないインストールスクリプトの1つ](https://twitter.com/robinvdvleuten/status/424163226532986880)です。次の手順は動作することが確認されています。このガイドから**逸脱する場合は注意してください**。その環境についてGitLabが前提としている点を破らないようにしてください。たとえば、ディレクトリの場所を変更したり、間違ったユーザーとしてサービスを実行したりすると、多くのユーザーが権限の問題に遭遇します。 + +このガイドにバグ/エラーを見つけた場合は、[コントリビュートガイド](https://gitlab.com/gitlab-org/gitlab/-/blob/master/CONTRIBUTING.md)に従って、**マージリクエストを送信**してください。 + +## Linuxパッケージインストールを検討する + +自己コンパイルによるインストールでは多くの作業とエラーが発生しやすいため、高速で信頼性の高い[Linuxパッケージインストール](https://about.gitlab.com/install/)（deb/rpm）を使用することを強くおすすめします。 + +Linuxパッケージが信頼性の高い理由の1つは、いずれかのクラッシュが発生した場合にGitLabプロセスを再起動するためにrunitを使用することです。頻繁に使用されるGitLabインスタンスでは、Sidekiqバックグラウンドワーカーのメモリ使用量が増加します。Linuxパッケージでは、メモリを使いすぎると[Sidekiqを正常に終了させる](../administration/sidekiq/sidekiq_memory_killer.md)ことでこれを解決します。終了すると、runitはSidekiqが実行されていないことを検出し、それを開始します。自己コンパイルによるインストールでは、プロセス監視にrunitを使用しないため、Sidekiqを終了できず、メモリ使用量が増加する可能性があります。 + +## インストールするバージョンを選択する + +インストールするGitLabのブランチ（バージョン、たとえば`16-0-stable`）から[このインストールガイド](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/install/installation.md)を表示していることを確認してください。GitLabの左上隅（メニューバーの下）にあるバージョンドロップダウンリストでブランチを選択できます。 + +最新の安定したブランチが不明な場合は、バージョン別のインストールガイドリンクについて[GitLabブログ](https://about.gitlab.com/blog/)を確認してください。 + +## ソフトウェア要件 + +| ソフトウェア | 最小バージョン | 注 | +|:------------------------|:----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Ruby](#2-ruby) | `3.2.x` | GitLab 17.5以降では、Ruby 3.2が必要です。Rubyの標準MRI実装を使用する必要があります。[JRuby](https://www.jruby.org/)と[Rubinius](https://github.com/rubinius/rubinius#the-rubinius-language-platform)が好まれますが、GitLabにはネイティブ拡張機能を持ついくつかのgemが必要です。 | +| [RubyGems](#3-rubygems) | `3.5.x` | 特定のRubyGemsバージョンは必須ではありませんが、既知のパフォーマンス改善のベネフィット得るためにアップデートしてください。 | +| [Go](#4-go) | `1.22.x` | GitLab 17.1以降では、Go 1.22以降が必要です。 | +| [Git](#git) | `2.47.x` | GitLab 17.7以降では、Git 2.47.x以降が必要です。[Gitalyから提供されるGitバージョン](#git)を使用する必要があります。 | +| [Node.js](#5-node) | `20.13.x` | GitLab 17.0以降では、Node.js 20.13以降が必要です。 | +| [PostgreSQL](#7-database) | `14.x` | GitLab 17.0以降では、PostgreSQL 14以降が必要です。 | + +## GitLabディレクトリ構造 + +インストール手順を実行すると、次のディレクトリが作成されます。 + +```plaintext +|-- home +| |-- git +| |-- .ssh +| |-- gitlab +| |-- gitlab-shell +| |-- repositories +``` + +- `/home/git/.ssh` - OpenSSH設定が含まれています。具体的には、GitLab Shellによって管理される`authorized_keys`ファイルです。 +- `/home/git/gitlab` - GitLabコアソフトウェア。 +- `/home/git/gitlab-shell` - GitLabのコアアドオンコンポーネント。SSHクローンやその他の機能を維持します。 +- `/home/git/repositories` - ネームスペースで整理されたすべてのプロジェクトのベアリポジトリ。これは、プッシュ/プルされるGitリポジトリがすべてのプロジェクトで維持される場所です。**この領域には、プロジェクトの重要なデータが含まれています。[バックアップを保持します](../administration/backup_restore/_index.md)。** + +リポジトリのデフォルトの場所は、GitLabの`config/gitlab.yml`とGitLab Shellの`config.yml`で構成できます。 + +これらのディレクトリを手動で作成する必要はありません。作成すると、インストールの後半でエラーが発生する可能性があります。 + +詳細な概要については、[GitLabアーキテクチャドキュメント](../development/architecture.md)を参照してください。 + +## 概要 + +GitLabのインストールは、次のコンポーネントの設定で構成されています。 + +1. [パッケージと依存関係](#1-packages-and-dependencies)。 +1. [Ruby](#2-ruby)。 +1. [RubyGems](#3-rubygems)。 +1. [Go](#4-go)。 +1. [ノード](#5-node)。 +1. [システムユーザー](#6-system-users)。 +1. [データベース](#7-database)。 +1. [Redis](#8-redis)。 +1. [GitLab](#9-gitlab)。 +1. [NGINX](#10-nginx)。 + +## 1. パッケージと依存関係 + +### sudo + +`sudo`は、デフォルトではDebianにインストールされていません。システムが最新であることを確認し、インストールします。 + +```shell +# run as root! +apt-get update -y +apt-get upgrade -y +apt-get install sudo -y +``` + +### ビルドの依存関係 + +必要なパッケージ（Rubyおよびネイティブ拡張機能をRuby gemにコンパイルするために必要）をインストールします。 + +```shell +sudo apt-get install -y build-essential zlib1g-dev libyaml-dev libssl-dev libgdbm-dev libre2-dev \ + libreadline-dev libncurses5-dev libffi-dev curl openssh-server libxml2-dev libxslt-dev \ + libcurl4-openssl-dev libicu-dev libkrb5-dev logrotate rsync python3-docutils pkg-config cmake \ + runit-systemd +``` + +{{< alert type="note" >}} + +GitLabにはOpenSSLバージョン1.1が必要です。Linuxディストリビューションに異なるバージョンのOpenSSLが含まれている場合は、1.1を手動でインストールする必要があるかもしれません。 + +{{< /alert >}} + +### Git + +次の[Gitalyから提供されるGitバージョン](https://gitlab.com/gitlab-org/gitaly/-/issues/2729)を使用する必要があります。 + +- GitLabに必要なバージョン。 +- 適切な動作に必要なカスタムパッチが含まれている。 + +1. 必要な依存関係をインストールします。 + + ```shell + sudo apt-get install -y libcurl4-openssl-dev libexpat1-dev gettext libz-dev libssl-dev libpcre2-dev build-essential git-core + ``` + +1. Gitalyリポジトリをクローンし、Gitをコンパイルします。インストールするGitLabバージョンに一致する安定したブランチで``を置き換えます。たとえば、GitLab 16.7をインストールする場合は、ブランチ名`16-7-stable`を使用します。 + + ```shell + git clone https://gitlab.com/gitlab-org/gitaly.git -b /tmp/gitaly + cd /tmp/gitaly + sudo make git GIT_PREFIX=/usr/local + ``` + +1. オプションで、システムGitとその依存関係を削除できます。 + + ```shell + sudo apt remove -y git-core + sudo apt autoremove + ``` + +[後で`config/gitlab.yml`を編集](#configure-it)する場合は、Gitパスを変更することを忘れないでください。 + +- 変更前: + + ```yaml + git: + bin_path: /usr/bin/git + ``` + +- 変更後: + + ```yaml + git: + bin_path: /usr/local/bin/git + ``` + +### GraphicsMagick + +[カスタムファビコン](../administration/appearance.md#customize-the-favicon)を機能させるには、GraphicsMagickをインストールする必要があります。 + +```shell +sudo apt-get install -y graphicsmagick +``` + +### メールサーバー + +メール通知を受信するには、メールサーバーがインストールされていることを確認してください。デフォルトでは、Debianには`exim4`が付属していますが、これには[問題があり](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/12754)、Ubuntuには付属していません。推奨されるメールサーバーは`postfix`であり、次の方法でインストールできます。 + +```shell +sudo apt-get install -y postfix +``` + +次に、Internet Site（インターネットサイト）を選択し、Enterキーを押してホスト名を確認します。 + +### ExifTool + +[GitLab Workhorse](https://gitlab.com/gitlab-org/gitlab-workhorse#dependencies)には、アップロードされた画像からEXIFデータを削除するために`exiftool`が必要です。 + +```shell +sudo apt-get install -y libimage-exiftool-perl +``` + +## 2. Ruby + +GitLabを実行するには、Rubyインタプリタが必要です。最小Ruby要件については、[要件のセクション](#software-requirements)を参照してください。 + +本番環境のGitLabで[`RVM`](https://rvm.io/)、[`rbenv`](https://github.com/rbenv/rbenv)、[`chruby`](https://github.com/postmodern/chruby)などのRubyバージョンマネージャーを使用すると、診断が難しい問題が発生することがよくあります。バージョンマネージャーはサポートされておらず、システムRubyを使用するには、以下の指示に従うことを強くおすすめします。 + +Linuxディストリビューションには通常、以前のバージョンのRubyが用意されているため、これらの手順は公式ソースコードからRubyをインストールするように設計されています。 + +[Rubyをインストールします](https://www.ruby-lang.org/en/documentation/installation/)。 + +## 3. RubyGems + +Rubyに同梱されているよりも新しいバージョンのRubyGemsが必要になる場合があります。 + +特定のバージョンに更新するには: + +```shell +gem update --system 3.4.12 +``` + +または最新バージョンに更新するには: + +```shell +gem update --system +``` + +## 4. Go + +GitLabには、Goで記述されたいくつかのデーモンがあります。GitLabをインストールするには、Goコンパイラが必要です。以下の手順では、64ビットLinuxを使用していることを前提としています。他のプラットフォームのダウンロードは、[Goダウンロードページ](https://go.dev/dl/)にあります。 + +```shell +# Remove former Go installation folder +sudo rm -rf /usr/local/go + +curl --remote-name --location --progress-bar "https://go.dev/dl/go1.22.5.linux-amd64.tar.gz" +echo '904b924d435eaea086515bc63235b192ea441bd8c9b198c507e85009e6e4c7f0 go1.22.5.linux-amd64.tar.gz' | shasum -a256 -c - && \ + sudo tar -C /usr/local -xzf go1.22.5.linux-amd64.tar.gz +sudo ln -sf /usr/local/go/bin/{go,gofmt} /usr/local/bin/ +rm go1.22.5.linux-amd64.tar.gz +``` + +## 5. Node + +GitLabでは、JavaScriptアセットをコンパイルするためにNodeを使用し、JavaScriptの依存関係を管理するためにYarnを使用する必要があります。これらの現在の最小要件は次のとおりです。 + +- `node` 20.xリリース（v20.13.0以降）。[Node.jsのその他のLTSバージョン](https://github.com/nodejs/release#release-schedule)はアセットを構築できるかもしれませんが、Node.js 20.xのみを保証します。 +- `yarn`= v1.22.x（Yarn 2はまだサポートされていません） + +多くのディストリビューションでは、公式パッケージリポジトリによって提供されるバージョンが古くなっているため、次のコマンドを使用してインストールする必要があります。 + +```shell +# install node v20.x +curl --location "https://deb.nodesource.com/setup_20.x" | sudo bash - +sudo apt-get install -y nodejs + +npm install --global yarn +``` + +これらの手順で問題が発生した場合は、[node](https://nodejs.org/en/download)および[yarn](https://classic.yarnpkg.com/en/docs/install/)の公式ウェブサイトにアクセスしてください。 + +## 6. システムユーザー + +GitLabの`git`ユーザーを作成します。 + +```shell +sudo adduser --disabled-login --gecos 'GitLab' git +``` + +## 7. データベース + +{{< alert type="note" >}} + +PostgreSQLのみがサポートされています。GitLab 17.0以降では、[PostgreSQL 14+が必要](requirements.md#postgresql)です。 + +{{< /alert >}} + +1. データベースパッケージをインストールします。 + + Ubuntu 22.04以降の場合: + + ```shell + sudo apt install -y postgresql postgresql-client libpq-dev postgresql-contrib + ``` + + Ubuntu 20.04以前の場合、利用可能なPostgreSQLは最小バージョン要件を満たしていません。PostgreSQLリポジトリを追加する必要があります。 + + ```shell + sudo sh -c 'echo "deb https://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list' + wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add - + sudo apt-get update + sudo apt-get -y install postgresql-14 + ``` + +1. インストールしているGitLabのバージョンでサポートされているPostgreSQLバージョンを確認します。 + + ```shell + psql --version + ``` + +1. PostgreSQLサービスを開始し、サービスが実行されていることを確認します。 + + ```shell + sudo service postgresql start + sudo service postgresql status + ``` + +1. GitLabのデータベースユーザーを作成します。 + + ```shell + sudo -u postgres psql -d template1 -c "CREATE USER git CREATEDB;" + ``` + +1. `pg_trgm`拡張機能を作成します。 + + ```shell + sudo -u postgres psql -d template1 -c "CREATE EXTENSION IF NOT EXISTS pg_trgm;" + ``` + +1. `btree_gist`拡張機能を作成します。 + + ```shell + sudo -u postgres psql -d template1 -c "CREATE EXTENSION IF NOT EXISTS btree_gist;" + ``` + +1. `plpgsql`拡張機能を作成します。 + + ```shell + sudo -u postgres psql -d template1 -c "CREATE EXTENSION IF NOT EXISTS plpgsql;" + ``` + +1. GitLab本番環境のデータベースを作成し、データベースに対するすべての特権を付与します。 + + ```shell + sudo -u postgres psql -d template1 -c "CREATE DATABASE gitlabhq_production OWNER git;" + ``` + +1. 新しいユーザーで新しいデータベースへの接続を試みます。 + + ```shell + sudo -u git -H psql -d gitlabhq_production + ``` + +1. `pg_trgm`拡張機能が有効であるかを確認します。 + + ```sql + SELECT true AS enabled + FROM pg_available_extensions + WHERE name = 'pg_trgm' + AND installed_version IS NOT NULL; + ``` + + 拡張機能が有効である場合、次の出力が生成されます。 + + ```plaintext + enabled + --------- + t + (1 row) + ``` + +1. `btree_gist`拡張機能が有効であるかを確認します。 + + ```sql + SELECT true AS enabled + FROM pg_available_extensions + WHERE name = 'btree_gist' + AND installed_version IS NOT NULL; + ``` + + 拡張機能が有効である場合、次の出力が生成されます。 + + ```plaintext + enabled + --------- + t + (1 row) + ``` + +1. `plpgsql`拡張機能が有効であるかを確認します。 + + ```sql + SELECT true AS enabled + FROM pg_available_extensions + WHERE name = 'plpgsql' + AND installed_version IS NOT NULL; + ``` + + 拡張機能が有効である場合、次の出力が生成されます。 + + ```plaintext + enabled + --------- + t + (1 row) + ``` + +1. データベースセッションを終了します。 + + ```shell + gitlabhq_production> \q + ``` + +## 8. Redis + +最小Redis要件については、[要件ページ](requirements.md#redis)を参照してください。 + +次でRedisをインストールします。 + +```shell +sudo apt-get install redis-server +``` + +完了したら、Redisを設定できます。 + +```shell +# Configure redis to use sockets +sudo cp /etc/redis/redis.conf /etc/redis/redis.conf.orig + +# Disable Redis listening on TCP by setting 'port' to 0 +sudo sed 's/^port .*/port 0/' /etc/redis/redis.conf.orig | sudo tee /etc/redis/redis.conf + +# Enable Redis socket for default Debian / Ubuntu path +echo 'unixsocket /var/run/redis/redis.sock' | sudo tee -a /etc/redis/redis.conf + +# Grant permission to the socket to all members of the redis group +echo 'unixsocketperm 770' | sudo tee -a /etc/redis/redis.conf + +# Add git to the redis group +sudo usermod -aG redis git +``` + +### systemdでRedisを管理する + +ディストリビューションがsystemd initを使用し、次のコマンドの出力が`notify`の場合、変更を加えないでください。 + +```shell +systemctl show --value --property=Type redis-server.service +``` + +出力が`notify`**でない**場合は、以下を実行します。 + +```shell +# Configure Redis to not daemonize, but be supervised by systemd instead and disable the pidfile +sudo sed -i \ + -e 's/^daemonize yes$/daemonize no/' \ + -e 's/^supervised no$/supervised systemd/' \ + -e 's/^pidfile/# pidfile/' /etc/redis/redis.conf +sudo chown redis:redis /etc/redis/redis.conf + +# Make the same changes to the systemd unit file +sudo mkdir -p /etc/systemd/system/redis-server.service.d +sudo tee /etc/systemd/system/redis-server.service.d/10fix_type.conf < gitlab +``` + +Enterpriseエディションのクローンを作成する + +```shell +# Clone GitLab repository +sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab.git -b gitlab +``` + +インストールするバージョンに一致する安定したブランチで``を必ず置き換えてください。たとえば、11.8をインストールする場合は、ブランチ名`11-8-stable`を使用します。 + +{{< alert type="warning" >}} + +*最新の*バージョンが必要な場合は``を`master`に変更できますが、本番環境サーバーに`master`をインストールしないでください。 + +{{< /alert >}} + +### 設定する + +```shell +# Go to GitLab installation folder +cd /home/git/gitlab + +# Copy the example GitLab config +sudo -u git -H cp config/gitlab.yml.example config/gitlab.yml + +# Update GitLab config file, follow the directions at top of the file +sudo -u git -H editor config/gitlab.yml + +# Copy the example secrets file +sudo -u git -H cp config/secrets.yml.example config/secrets.yml +sudo -u git -H chmod 0600 config/secrets.yml + +# Make sure GitLab can write to the log/ and tmp/ directories +sudo chown -R git log/ +sudo chown -R git tmp/ +sudo chmod -R u+rwX,go-w log/ +sudo chmod -R u+rwX tmp/ + +# Make sure GitLab can write to the tmp/pids/ and tmp/sockets/ directories +sudo chmod -R u+rwX tmp/pids/ +sudo chmod -R u+rwX tmp/sockets/ + +# Create the public/uploads/ directory +sudo -u git -H mkdir -p public/uploads/ + +# Make sure only the GitLab user has access to the public/uploads/ directory +# now that files in public/uploads are served by gitlab-workhorse +sudo chmod 0700 public/uploads + +# Change the permissions of the directory where CI job logs are stored +sudo chmod -R u+rwX builds/ + +# Change the permissions of the directory where CI artifacts are stored +sudo chmod -R u+rwX shared/artifacts/ + +# Change the permissions of the directory where GitLab Pages are stored +sudo chmod -R ug+rwX shared/pages/ + +# Copy the example Puma config +sudo -u git -H cp config/puma.rb.example config/puma.rb + +# Refer to https://github.com/puma/puma#configuration for more information. +# You should scale Puma workers and threads based on the number of CPU +# cores you have available. You can get that number via the `nproc` command. +sudo -u git -H editor config/puma.rb + +# Configure Redis connection settings +sudo -u git -H cp config/resque.yml.example config/resque.yml +sudo -u git -H cp config/cable.yml.example config/cable.yml + +# Change the Redis socket path if you are not using the default Debian / Ubuntu configuration +sudo -u git -H editor config/resque.yml config/cable.yml +``` + +必ず`gitlab.yml`と`puma.rb`の両方を編集して、セットアップと一致するようにしてください。 + +HTTPSを使用する場合は、追加の手順について[HTTPSの使用](#using-https)を参照してください。 + +### GitLab DB設定を構成する + +{{< alert type="note" >}} + +[GitLab 15.9](https://gitlab.com/gitlab-org/gitlab/-/issues/387898)以降、セクションが`main:`のみの`database.yml`は非推奨になりました。GitLab 17.0以降では、`database.yml`に`main:`セクションと`ci:`セクションの2つが必要です。 + +{{< /alert >}} + +```shell +sudo -u git cp config/database.yml.postgresql config/database.yml + +# Remove host, username, and password lines from config/database.yml. +# Once modified, the `production` settings will be as follows: +# +# production: +# main: +# 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 + +# Remote PostgreSQL only: +# Update username/password in config/database.yml. +# You only need to adapt the production settings (first part). +# If you followed the database guide then please do as follows: +# Change 'secure password' with the value you have given to $password +# You can keep the double quotes around the password +sudo -u git -H editor config/database.yml + +# Uncomment the `ci:` sections in config/database.yml. +# Ensure the `database` value in `ci:` matches the database value in `main:`. + +# Make config/database.yml readable to git only +sudo -u git -H chmod o-rwx config/database.yml +``` + +`database.yml`には、`main:`と`ci:`の2つのセクションが必要です。`ci`:接続は、[同じデータベースへの接続](../administration/postgresql/multiple_databases.md)である必要があります。 + +### Gemsをインストールする + +{{< alert type="note" >}} + +Bundler 1.5.2以降では、`bundle install -jN`（`N`はプロセッサコアの数）を実行することで、gemの並列インストールを完了するのにかかる時間をかなり短縮（約60%高速）できます。`nproc`でコア数を確認してください。詳細については、[こちらの投稿](https://thoughtbot.com/blog/parallel-gem-installing-using-bundler)を参照してください。 + +{{< /alert >}} + +`bundle`があることを確認してください（`bundle -v`を実行）。 + +- `>= 1.5.2`、一部の[イシュー](https://devcenter.heroku.com/changelog-items/411)は1.5.2で[修正](https://github.com/rubygems/bundler/pull/2817)されたためです。 +- `< 2.x`。 + +ユーザー認証にKerberosを使用する場合は、以下の`--without`オプションで`kerberos`を省略して、gemをインストールします。 + +```shell +sudo -u git -H bundle config set --local deployment 'true' +sudo -u git -H bundle config set --local without 'development test kerberos' +sudo -u git -H bundle config path /home/git/gitlab/vendor/bundle +sudo -u git -H bundle install +``` + +### GitLab Shellをインストールする + +GitLab Shellは、GitLabに特別に開発されたSSHアクセスおよびリポジトリ管理ソフトウェアです。 + +```shell +# Run the installation task for gitlab-shell: +sudo -u git -H bundle exec rake gitlab:shell:install RAILS_ENV=production + +# By default, the gitlab-shell config is generated from your main GitLab config. +# You can review (and modify) the gitlab-shell config as follows: +sudo -u git -H editor /home/git/gitlab-shell/config.yml +``` + +HTTPSを使用する場合は、追加の手順について[HTTPSの使用](#using-https)を参照してください。 + +適切なDNSレコードまたは`/etc/hosts`の追加の行（「127.0.0.1ホスト名」）のいずれかによって、ホスト名をマシン自体で解決できることを確認してください。これは、たとえば、リバースプロキシの背後にGitLabを設定する場合に必要になる場合があります。ホスト名を解決できない場合、最終的なインストールチェックは`Check GitLab API access: FAILED. code: 401`で失敗し、コミットのプッシュは`[remote rejected] master -> master (hook declined)`で拒否されます。 + +### GitLab Workhorseをインストールする + +GitLab-Workhorseは[GNU Make](https://www.gnu.org/software/make/)を使用します。次のコマンドラインを使うと、推奨される場所である`/home/git/gitlab-workhorse`にGitLab-Workhorseをインストールします。 + +```shell +sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse]" RAILS_ENV=production +``` + +追加のパラメーターとして指定することで、別のGitリポジトリを指定できます。 + +```shell +sudo -u git -H bundle exec rake "gitlab:workhorse:install[/home/git/gitlab-workhorse,https://example.com/gitlab-workhorse.git]" RAILS_ENV=production +``` + +### EnterpriseエディションにGitLab-Elasticsearch-indexerをインストールする + +{{< details >}} + +- プラン: Premium、Ultimate +- 製品: GitLab Self-Managed + +{{< /details >}} + +GitLab-Elasticsearch-Indexerは[GNU Make](https://www.gnu.org/software/make/)を使用します。次のコマンドラインを使うと、推奨される場所である`/home/git/gitlab-elasticsearch-indexer`にGitLab-Elasticsearch-Indexerをインストールします。 + +```shell +sudo -u git -H bundle exec rake "gitlab:indexer:install[/home/git/gitlab-elasticsearch-indexer]" RAILS_ENV=production +``` + +追加のパラメーターとして指定することで、別のGitリポジトリを指定できます。 + +```shell +sudo -u git -H bundle exec rake "gitlab:indexer:install[/home/git/gitlab-elasticsearch-indexer,https://example.com/gitlab-elasticsearch-indexer.git]" RAILS_ENV=production +``` + +ソースコードはまず、最初のパラメーターで指定されたパスにフェッチされます。次に、その`bin`ディレクトリの下にバイナリが構築されます。その後、`gitlab.yml`の`production -> elasticsearch -> indexer_path`設定を更新して、そのバイナリを指すようにします。 + +### GitLab Pagesをインストールする + +GitLab Pagesは[GNU Make](https://www.gnu.org/software/make/)を使用します。この手順はオプションであり、GitLab内から静的サイトをホストする場合にのみ必要です。次のコマンドを使うと、`/home/git/gitlab-pages`にGitLab Pagesをインストールします。追加の設定手順については、GitLab Pagesデーモンはいくつかの異なる方法で実行できるため、お使いのバージョンのGitLabの[管理ガイド](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/administration/pages/source.md)を参照してください。 + +```shell +cd /home/git +sudo -u git -H git clone https://gitlab.com/gitlab-org/gitlab-pages.git +cd gitlab-pages +sudo -u git -H git checkout v$(.d/override.conf`にドロップイン設定ファイルをインストールするため、後でユニットファイルを更新するときにローカル設定が上書きされることはありません。ドロップイン設定ファイルを分割するには、`/etc/systemd/system/.d/`にある`.conf`ファイルに上記のコードスニペットを追加します。 + +`systemctl edit`を使用せずに、ユニットファイルを手動で変更した場合、またはドロップイン設定ファイルを追加した場合は、次のコマンドを実行して有効にします。 + +```shell +sudo systemctl daemon-reload +``` + +ブート時にGitLabを起動させます。 + +```shell +sudo systemctl enable gitlab.target +``` + +#### SysV initスクリプトをインストールする + +SysV initスクリプトを使用する場合は、次の手順を実行します。systemdを使用する場合は、[systemdユニットの手順](#install-systemd-units)に従ってください。 + +initスクリプト(`/etc/init.d/gitlab`)をダウンロードします。 + +```shell +cd /home/git/gitlab +sudo cp lib/support/init.d/gitlab /etc/init.d/gitlab +``` + +また、デフォルト以外のフォルダまたはユーザーでインストールする場合は、defaultsファイルをコピーして編集します。 + +```shell +sudo cp lib/support/init.d/gitlab.default.example /etc/default/gitlab +``` + +GitLabを別のディレクトリにインストールした場合、またはデフォルト以外のユーザーとしてインストールした場合は、`/etc/default/gitlab`でこれらの設定を変更する必要があります。アップグレード時に変更されるため、`/etc/init.d/gitlab`を編集しないでください。 + +ブート時にGitLabを起動させます。 + +```shell +sudo update-rc.d gitlab defaults 21 +# or if running this on a machine running systemd +sudo systemctl daemon-reload +sudo systemctl enable gitlab.service +``` + +### Logrotateを設定する + +```shell +sudo cp lib/support/logrotate/gitlab /etc/logrotate.d/gitlab +``` + +### Gitalyを起動する + +次のセクションでは、Gitalyが実行されている必要があります。 + +- systemdを使用してGitalyを起動するには: + + ```shell + sudo systemctl start gitlab-gitaly.service + ``` + +- SysV用にGitalyを手動で起動するには: + + ```shell + gitlab_path=/home/git/gitlab + gitaly_path=/home/git/gitaly + + sudo -u git -H sh -c "$gitlab_path/bin/daemon_with_pidfile $gitlab_path/tmp/pids/gitaly.pid \ + $gitaly_path/_build/bin/gitaly $gitaly_path/config.toml >> $gitlab_path/log/gitaly.log 2>&1 &" + ``` + +### データベースを初期化して高度な機能をアクティブにする + +```shell +cd /home/git/gitlab +sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production +# Type 'yes' to create the database tables. + +# or you can skip the question by adding force=yes +sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production force=yes + +# When done, you see 'Administrator account created:' +``` + +以下の例に示すように、環境変数`GITLAB_ROOT_PASSWORD`および`GITLAB_ROOT_EMAIL`で管理者/rootパスワードとメールアドレスを設定できます。パスワードを設定しない（デフォルトのパスワードに設定されている）場合は、インストールが完了し、最初にサーバーにログインするまで、GitLabをパブリックインターネットに公開しないでください。最初のログイン時に、デフォルトのパスワードの変更が強制されます。Enterpriseエディションサブスクリプションは、このとき、`GITLAB_ACTIVATION_CODE`環境変数にアクティベーションコードを指定してアクティブにすることもできます。 + +```shell +sudo -u git -H bundle exec rake gitlab:setup RAILS_ENV=production GITLAB_ROOT_PASSWORD=yourpassword GITLAB_ROOT_EMAIL=youremail GITLAB_ACTIVATION_CODE=yourcode +``` + +### `secrets.yml`をセキュアにする + +`secrets.yml`ファイルには、セッションとセキュア変数の暗号化キーが格納されています。`secrets.yml`を安全な場所にバックアップしますが、データベースのバックアップと同じ場所に保存しないでください。そうしないと、バックアップのいずれかが侵害された場合に、シークレットが公開されます。 + +### アプリケーションの状態を確認する + +GitLabとその環境が正しく設定されているかどうかを確認します。 + +```shell +sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production +``` + +### アセットをコンパイルする + +```shell +sudo -u git -H yarn install --production --pure-lockfile +sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production NODE_ENV=production +``` + +`rake`が`JavaScript heap out of memory`エラーで失敗する場合は、次のように`NODE_OPTIONS`設定して実行してみてください。 + +```shell +sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production NODE_ENV=production NODE_OPTIONS="--max_old_space_size=4096" +``` + +### GitLabインスタンスを起動する + +```shell +# For systems running systemd +sudo systemctl start gitlab.target + +# For systems running SysV init +sudo service gitlab start +``` + +## 10. NGINX + +NGINXは、GitLabで公式にサポートされているウェブサーバーです。ウェブサーバーとしてNGINXを使用できない場合、または使用したくない場合は、[GitLabレシピ](https://gitlab.com/gitlab-org/gitlab-recipes/)を参照してください。 + +### インストール + +```shell +sudo apt-get install -y nginx +``` + +### サイトの設定 + +サイト設定の例をコピーします。 + +```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 +``` + +セットアップに合わせて設定ファイルを編集してください。特に `git`ユーザー以外のユーザー用にインストールする場合は、GitLabへのパスが一致していることを確認してください。 + +```shell +# Change YOUR_SERVER_FQDN to the fully-qualified +# domain name of your host serving GitLab. +# +# Remember to match your paths to GitLab, especially +# if installing for a user other than 'git'. +# +# If using Ubuntu default nginx install: +# either remove the default_server from the listen line +# or else sudo rm -f /etc/nginx/sites-enabled/default +sudo editor /etc/nginx/sites-available/gitlab +``` + +GitLab Pagesを有効にする場合は、別途NGINX設定を使用する必要があります。すべての必要な設定について、[GitLab Pages管理ガイド](../administration/pages/_index.md)をお読みください。 + +HTTPSを使用する場合は、`gitlab`NGINX設定を`gitlab-ssl`に置き換えます。HTTPS設定の詳細については、[HTTPSの使用](#using-https)を参照してください。 + +NGINXがGitLab-Workhorseソケットを読み取れるようにするには、GitLabユーザーが所有するソケットを`www-data`ユーザーが読み取れるようにする必要があります。これは、グローバルに読み取り可能である場合（たとえば、デフォルトで`0755`の権限を持っている場合）に実現できます。`www-data`は、親ディレクトリをリストできる必要もあります。 + +### 設定をテストする + +次のコマンドを使用して、`gitlab`または`gitlab-ssl`NGINX設定ファイルを検証します。　 + +```shell +sudo nginx -t +``` + +`syntax is okay`および`test is successful`メッセージが表示されるはずです。エラーメッセージが表示される場合は、そこに示されているように、`gitlab`または`gitlab-ssl`NGINX設定ファイルにタイプミスがないか確認してください。 + +インストールされているバージョンが1.12.1以降であることを確認します。 + +```shell +nginx -v +``` + +それより前の場合は、次のエラーが表示されることがあります。 + +```plaintext +nginx: [emerg] unknown "start$temp=[filtered]$rest" variable +nginx: configuration file /etc/nginx/nginx.conf test failed +``` + +### 再起動 + +```shell +# For systems running systemd +sudo systemctl restart nginx.service + +# For systems running SysV init +sudo service nginx restart +``` + +## インストール後 + +### アプリケーションの状態を再確認 + +何か見落としがないか確認するには、次のコマンドでより徹底的なチェックを実行します。 + +```shell +sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production +``` + +すべての項目が緑色の場合は、GitLabのインストールに成功しました。 + +{{< alert type="note" >}} + +チェックコマンドの出力からプロジェクト名を省略するには、`SANITIZE=true`環境変数を`gitlab:check`に指定します。 + +{{< /alert >}} + +### 最初のログイン + +GitLabに初めてログインするには、ウェブブラウザでYOUR_SERVERにアクセスします。 + +[セットアップ中にrootパスワードを指定](#initialize-database-and-activate-advanced-features)しなかった場合は、パスワードリセット画面にリダイレクトされ、最初の管理者アカウントのパスワードを指定するように求められます。希望するパスワードを入力すると、ログイン画面にリダイレクトされます。 + +デフォルトのアカウントのユーザー名は**root**です。作成したパスワードを入力してログインします。ログイン後、必要に応じてユーザー名を変更できます。 + +**ご利用可能になりました** + +以下を使用するときにGitLabを起動および停止するには: + +- systemdユニット: `sudo systemctl start gitlab.target`または`sudo systemctl stop gitlab.target`を使用します。 +- SysV initスクリプト: `sudo service gitlab start`または`sudo service gitlab stop`を使用します。 + +### 推奨される次の手順 + +インストールが完了したら、[推奨される次の手順](next_steps.md)（認証オプションやサインアップ制限など）を実行することを検討してください。 + +## 高度な設定のヒント + +### 相対URLのサポート + +相対URLでGitLabを設定する方法の詳細については、[相対URLドキュメント](relative_url.md)を参照してください。 + +### HTTPSを使用する + +HTTPSでGitLabを使用するには: + +1. `gitlab.yml`で: + 1. セクション1の`port`オプションを`443`に設定します。 + 1. セクション1の`https`オプションを`true`に設定します。 +1. GitLab Shellの`config.yml`で: + 1. `gitlab_url`オプションをGitLabのHTTPSエンドポイント（たとえば、`https://git.example.com`）に設定します。 + 1. `ca_file`または`ca_path`オプションのいずれかを使用して証明書を設定します。 +1. `gitlab`設定ではなく、`gitlab-ssl`NGINXのサンプル設定を使用します。 + 1. `YOUR_SERVER_FQDN`を更新します。 + 1. `ssl_certificate`と`ssl_certificate_key`を更新します。 + 1. 設定ファイルを確認し、他のセキュリティおよびパフォーマンス強化機能の適用を検討してください。 + +自己署名証明書を使用することはおすすめできません。どうしても使用する必要がある場合は、標準的な指示に従って自己署名SSL証明書を生成します。 + + ```shell + mkdir -p /etc/nginx/ssl/ + cd /etc/nginx/ssl/ + sudo openssl req -newkey rsa:2048 -x509 -nodes -days 3560 -out gitlab.crt -keyout gitlab.key + sudo chmod o-r gitlab.key + ``` + +### メールによる返信を有効にする + +この設定方法の詳細については、[「メールで返信」ドキュメント](../administration/reply_by_email.md)を参照してください。 + +### LDAP認証 + +`config/gitlab.yml`でLDAP認証を設定できます。このファイルを編集した後、GitLabを再起動します。 + +### カスタムOmniAuthプロバイダーを使用する + +[OmniAuthインテグレーションドキュメント](../integration/omniauth.md)を参照してください。 + +### プロジェクトをビルドする + +GitLabではプロジェクトをビルドできます。その機能を有効にするには、それを行うためのRunnerが必要です。Runnerをインストールするには、[GitLab Runnerセクション](https://docs.gitlab.com/runner/)を参照してください。 + +### 信頼できるプロキシを追加する + +別のマシンでリバースプロキシを使用している場合は、プロキシを信頼できるプロキシリストに追加することをお勧めします。そうしないと、ユーザーはプロキシのIPアドレスからサインインしたように表示されます。 + +`config/gitlab.yml`で、セクション1の`trusted_proxies`オプションをカスタマイズすることにより、信頼できるプロキシを追加できます。ファイルを保存し、変更を有効にするために[GitLabを再構成](../administration/restart_gitlab.md)します。 + +URLで不適切にエンコードされた文字に関する問題が発生した場合は、[エラー: リバースプロキシの使用時に`404 Not Found`](../api/rest/troubleshooting.md#error-404-not-found-when-using-a-reverse-proxy)を参照してください。 + +### カスタムRedis接続 + +非標準ポートまたは別のホストでRedisサーバーに接続する場合は、`config/resque.yml`ファイルを使用して接続文字列を設定できます。 + +```yaml +# example +production: + url: redis://redis.example.tld:6379 +``` + +ソケット経由でRedisサーバーに接続する場合は、`unix:`URLスキームと、`config/resque.yml`ファイル内のRedisソケットファイルへのパスを使用します。 + +```yaml +# example +production: + url: unix:/path/to/redis/socket +``` + +また、`config/resque.yml`ファイルで環境変数を使用することもできます。 + +```yaml +# example +production: + url: <%= ENV.fetch('GITLAB_REDIS_URL') %> +``` + +### カスタムSSH接続 + +非標準ポートでSSHを実行している場合は、GitLabユーザーのSSH設定を変更する必要があります。 + +```plaintext +# Add to /home/git/.ssh/config +host localhost # Give your setup a name (here: override localhost) + user git # Your remote git user + port 2222 # Your port number + hostname 127.0.0.1; # Your server name or IP +``` + +また、`config/gitlab.yml`ファイルで対応するオプション（`ssh_user`、`ssh_host`、`admin_uri` など）も変更する必要があります。 + +### 追加のマークアップスタイル + +常にサポートされているMarkdownスタイルとは別に、GitLabが表示できるリッチテキストファイルが他にもあります。ただし、これを行うには、依存関係をインストールする必要がある場合があります。詳細については、[`github-markup`gemのREADME](https://github.com/gitlabhq/markup#markups)を参照してください。 + +### Prometheusサーバーの設定 + +`config/gitlab.yml`でPrometheusサーバーを設定できます。 + +```yaml +# example +prometheus: + enabled: true + server_address: '10.1.2.3:9090' +``` + +## トラブルシューティング + +### 「空のリポジトリを複製したようです」 + +GitLabがホストするリポジトリを複製しようとしたときにこのメッセージが表示される場合、これは、NGINXまたはApacheの設定が古くなっているか、GitLab Workhorseインスタンスがないか、誤って構成されていることが原因である可能性があります。[Goをインストール](#4-go)し、[GitLab Workhorseをインストール](#install-gitlab-workhorse)し、[NGINXを正しく設定](#site-configuration)したことを再確認してください。 + +### `google-protobuf`「LoadError: /lib/x86_64-linux-gnu/libc.so.6: バージョン 'GLIBC_2.14' が見つかりません」 + +これは、一部のバージョンの`google-protobuf` gemを使うプラットフォームで発生する可能性があります。回避策は、このgemのソースのみのバージョンをインストールすることです。 + +まず、GitLabインストールに必要な`google-protobuf`の正確なバージョンを見つける必要があります。 + +```shell +cd /home/git/gitlab + +# Only one of the following two commands will print something. It +# will look like: * google-protobuf (3.2.0) +bundle list | grep google-protobuf +bundle check | grep google-protobuf +``` + +以下に、`3.2.0`を例として使用します。上記で見つけたバージョン番号に置き換えます。 + +```shell +cd /home/git/gitlab +sudo -u git -H gem install google-protobuf --version 3.2.0 --platform ruby +``` + +最後に、`google-protobuf`が正しく読み込まれるかどうかをテストできます。次は「OK」と表示されるはずです。 + +```shell +sudo -u git -H bundle exec ruby -rgoogle/protobuf -e 'puts :OK' +``` + +`gem install`コマンドが失敗する場合は、OSの開発ツールをインストールする必要があるかもしれません。 + +Debian/Ubuntuの場合: + +```shell +sudo apt-get install build-essential libgmp-dev +``` + +RedHat/CentOSの場合: + +```shell +sudo yum groupinstall 'Development Tools' +``` + +### GitLabアセットのコンパイルエラー + +アセットをコンパイル中に、次のエラーメッセージが表示されることがあります。 + +```plaintext +Killed +error Command failed with exit code 137. +``` + +これは、Yarnがメモリ不足で実行されているコンテナを強制終了した場合に発生する可能性があります。これを修正するには: + +1. システムのメモリを8 GB以上に増やします。 + +1. 次のコマンドを実行して、アセットをクリーンアップします。 + + ```shell + sudo -u git -H bundle exec rake gitlab:assets:clean RAILS_ENV=production NODE_ENV=production + ``` + +1. `yarn`コマンドを再度実行して、競合を解決します。 + + ```shell + sudo -u git -H yarn install --production --pure-lockfile + ``` + +1. アセットを再コンパイルします。 + + ```shell + sudo -u git -H bundle exec rake gitlab:assets:compile RAILS_ENV=production NODE_ENV=production + ``` diff --git a/doc-locale/ja-jp/update/docker/_index.md b/doc-locale/ja-jp/update/docker/_index.md new file mode 100644 index 0000000000000000000000000000000000000000..780bd7965ad67ec0cf32a8242344431bfaa311df --- /dev/null +++ b/doc-locale/ja-jp/update/docker/_index.md @@ -0,0 +1,107 @@ +--- +stage: Systems +group: Distribution +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments +title: アップグレード +--- + +{{< details >}} + +- プラン: Free、Premium、Ultimate +- 提供形態: GitLab Self-Managed + +{{< /details >}} + +ほとんどの場合、GitLabのアップグレードは最新のDockerイメージタグをダウンロードするのと同じくらい簡単です。 + +## Docker Engineを使用してGitLabをアップグレードする + +[Docker Engineを使用してインストール](installation.md#install-gitlab-by-using-docker-engine)されたGitLabインスタンスをアップグレードするには: + +1. [バックアップ](backup.md)を作成します。最低限、[データベース](backup.md#create-a-database-backup)とGitLabシークレットファイルをバックアップしてください。 + +1. 実行中のコンテナを停止します。 + + ```shell + sudo docker stop gitlab + ``` + +1. 既存のコンテナを削除します。 + + ```shell + sudo docker rm gitlab + ``` + +1. 新しいイメージをプルします。 + + ```shell + sudo docker pull gitlab/gitlab-ee:-ee.0 + ``` + +1. `GITLAB_HOME`環境変数が[定義](installation.md#create-a-directory-for-the-volumes)されていることを確認してください。 + + ```shell + echo $GITLAB_HOME + ``` + +1. [以前に指定した](installation.md#install-gitlab-by-using-docker-engine)オプションを使用して、コンテナを再度作成します。 + + ```shell + sudo docker run --detach \ + --hostname gitlab.example.com \ + --publish 443:443 --publish 80:80 --publish 22:22 \ + --name gitlab \ + --restart always \ + --volume $GITLAB_HOME/config:/etc/gitlab \ + --volume $GITLAB_HOME/logs:/var/log/gitlab \ + --volume $GITLAB_HOME/data:/var/opt/gitlab \ + --shm-size 256m \ + gitlab/gitlab-ee:-ee.0 + ``` + +初回実行時に、GitLabは自身を再構成し、アップグレードします。 + +異なるバージョンにアップグレードする場合は、GitLab[アップグレードの推奨事項](../../policy/maintenance.md#upgrade-recommendations)を参照してください。 + +## Docker Composeを使用してGitLabをアップグレードする + +[Docker Composeを使用してインストール](installation.md#install-gitlab-by-using-docker-compose)されたGitLabインスタンスをアップグレードするには: + +1. [バックアップ](backup.md)を作成します。最低限、[データベース](backup.md#create-a-database-backup)とGitLabシークレットファイルをバックアップしてください。 +1. `docker-compose.yml`を編集して、プルするバージョンを変更します。 +1. 最新リリースをダウンロードして、GitLabインスタンスをアップグレードします。 + + ```shell + docker compose pull + docker compose up -d + ``` + +## CommunityエディションをEnterpriseエディションに変換する + +Docker用の既存のGitLab Communityエディション(CE)コンテナをGitLab [Enterpriseエディション](https://about.gitlab.com/pricing/)(EE)コンテナに変換するには、[バージョンをアップグレード](upgrade.md)するのと同じ方法を使用します。 + +CEの同じバージョンからEEに変換することをおすすめします(たとえば、CE 14.1からEE 14.1)。ただし、これは必須ではありません。標準的なアップグレード(たとえば、CE 14.0からEE 14.1)はすべて機能するはずです。次の手順では、同じバージョンに変換することを前提としています。 + +1. [バックアップ](backup.md)を作成します。最低限、[データベース](backup.md#create-a-database-backup)とGitLabシークレットファイルをバックアップしてください。 + +1. 現在のCEコンテナを停止し、削除または名前を変更します。 + +1. GitLab EEで新しいコンテナを作成するには、`docker run`コマンドまたは`docker-compose.yml`ファイルで`ce`を`ee`に置き換えます 。CEコンテナ名、ポートマッピング、ファイルマッピング、およびバージョンを再利用します。 + +## GitLabをダウングレードする + +復元により、新しいすべてのGitLabデータベースコンテンツを古い状態に上書きします。ダウングレードは、必要な場合にのみ推奨されます。たとえば、アップグレード後のテストで、すぐに解決できない問題が明らかになった場合などです。 + +{{< alert type="warning" >}} + +ダウングレードするバージョンおよびエディションとまったく同じバージョンで作成されたデータベースのバックアップが少なくとも1つ必要です。バックアップは、アップグレード中に行われたスキーマの変更(移行)を元に戻すために必要です。 + +{{< /alert >}} + +アップグレード直後にGitLabをダウングレードするには: + +1. インストールしたバージョンより[以前のバージョンを指定](installation.md#find-the-gitlab-version-and-edition-to-use)して、アップグレード手順に従います。 + +1. アップグレード前に[作成したデータベースバックアップ](backup.md#create-a-database-backup)を復元します。 + + - PumaとSidekiqの停止を含め、[Dockerイメージの復元手順に従います](../../administration/backup_restore/restore_gitlab.md#restore-for-docker-image-and-gitlab-helm-chart-installations)。データベースのみを復元する必要があるため、`SKIP=artifacts,repositories,registry,uploads,builds,pages,lfs,packages,terraform_state`を`gitlab-backup restore`コマンドライン引数に追加します。