YouTrack サーバー 2024.2 ヘルプ

Docker のインストール

Docker コンテナーを使用して YouTrack をインストールするために必要な手順の概要を次に示します。

  1. 環境を準備する

  2. ディレクトリの作成と設定

  3. YouTrack イメージをプルする

  4. Docker コンテナーを実行する

  5. YouTrack の設定

各ステップについては、以下で詳しく説明します。

環境を準備する

YouTrack をインストールするサーバーまたは仮想マシンに Docker がインストールされていることを確認します。Docker は公式 Web サイトからダウンロードしてインストールする(英語)か、サーバーのオペレーティングシステムに固有のパッケージマネージャーを使用できます。

また、インストールのターゲット環境が、YouTrack をインストールするための最小要件を満たしているか、それを超えていることを確認する必要もあります。詳細については、「サポートされる環境」を参照してください。

サーバーにソフトウェアをインストールする場合は、通常、管理者またはスーパーユーザー権限を持つユーザーアカウントを使用することをお勧めします。Unix 系オペレーティングシステムでは、このユーザーは「root」と呼ばれることがよくあります。Windows では、通常、管理者権限を持つアカウントです。サーバーへのアクセスに使用するアカウントに、この環境でフォルダーとファイルを作成する権限があることを確認してください。

ディレクトリの作成と設定

YouTrack イメージはステートフルコンテナーです。これにより、コンテナーが再起動されたり、別のホストに移動された場合でも、データベース、ログファイル、構成ファイル、アプリケーションデータを保存および維持できます。

コンテナーを開始する前に、これらのファイルを保存するディレクトリをホストマシン上にプロビジョニングする必要があります。これらのディレクトリは、起動時にボリュームとして YouTrack コンテナーにマップされます。

YouTrack アプリケーションは次のディレクトリを使用します。

ディレクトリ

説明

データ

YouTrack がデータベースを保存するディレクトリ。新規インストールの場合、このディレクトリは空である必要があります。

会議

YouTrack が環境設定、JVM オプション、YouTrack 統合設定などを含む構成ファイルを保存するディレクトリ。

ログ

YouTrack がログファイルを保存するディレクトリ。

バックアップ

YouTrack がバックアップを保存するディレクトリ。バックアップの詳細については、「データベースのバックアップ」を参照してください。

これらのディレクトリは、コンテナー内で YouTrack サービスを実行するユーザーアカウントがアクセスできる必要があります。Hub は、非 root アカウント 13001:13001 (それぞれ group:id) を使用します。

ストレージリソースをプロビジョニングするための具体的な手順は、オペレーティングシステムによって異なります。インストールに関連する情報が確実に表示されるようにするには、ホスト環境で使用されているオペレーティングシステムに対応するタブを選択します。

ホストマシンが Linux 上で実行されている場合は、次のコマンドを実行して、ホストマシン上に必要な Hub ディレクトリを作成し、必要なアクセス許可を適用できます。

mkdir -p -m 750 <path to data directory> \ <path to logs directory> \ <path to conf directory> \ <path to backups directory> chown -R 13001:13001 <path to data directory> \ <path to logs directory> \ <path to conf directory> \ <path to backups directory>
  • mkdir — これは Linux でディレクトリを作成するコマンドです。

  • -p — 必要に応じて親ディレクトリを作成するようにオペレーティングシステムに指示します。指定したパスにディレクトリが存在しない場合は、指定したディレクトリとともにディレクトリが作成されます。

  • -m 750 — ディレクトリの権限 (ファイルモード) を 750 に設定します。Unix 系システムでは、ファイルモードのアクセス許可は 3 つの 8 進数で表され、各桁は所有者、グループ、その他のアクセス許可を (この順序で) 表します。750 では、所有者には読み取り、書き込み、実行のアクセス許可 (7) があり、グループには読み取りおよび実行のアクセス許可 (5) があり、その他のユーザーにはアクセス許可がありません (0)。

  • <path to <name> directory> — これらは、作成するディレクトリへの実際のパスのプレースホルダーです。これらを、YouTrack アプリケーションデータおよびその他のファイルを保存する予定の実際のパスに置き換えます。

  • chown — 作成されたディレクトリの所有権を変更します。

  • -R — このアクションを再帰的に実行し、指定されたディレクトリとそのすべてのコンテンツの所有権を変更するようにオペレーティングシステムに指示します。

  • 13001:13001 — 所有権を変更するユーザーとグループを指定します。この場合、所有権はユーザー ID 13001 およびグループ ID 13001 に変更されます。

  • <path to <name> directory> — これらは、所有権が更新されるディレクトリへの実際のパスのプレースホルダーです。mkdir コマンドと同様に、これらを、YouTrack アプリケーションデータおよびその他のファイルを保存する予定の実際のパスに置き換える必要があります。

ホストマシンが Windows 上で実行されている場合は、次のコマンドを実行して、ホストマシン PowerShell 上に必要な YouTrack ディレクトリを作成できます。

New-Item -Path "<path to data directory>" -ItemType Directory New-Item -Path "<path to logs directory>" -ItemType Directory New-Item -Path "<path to conf directory>" -ItemType Directory New-Item -Path "<path to backups directory>" -ItemType Directory
  • New-Item — 指定されたパスでディレクトリを作成します。

  • <path to <name> directory> — これらは、作成するディレクトリへの実際のパスのプレースホルダーです。これを、YouTrack アプリケーションデータおよびその他のファイルを保存する予定の実際の場所に置き換えます。

YouTrack イメージをプルする

  1. Docker Hub(英語) でソフトウェアの最新バージョンを見つけます。

    各バージョンとビルドはタグごとにリストされます。

  2. 最新の YouTrack バージョンに対応するイメージを見つけたら、クリックして Docker Hub リポジトリからプルコマンドを直接コピーできます。

  3. ターゲット環境で CLI ツールを開きます。

  4. コマンドを使用してリポジトリからイメージをプルし、ローカルマシンまたはホスト環境にインストールします。

    このコマンドでは次の形式が使用されます。

    docker pull jetbrains/youtrack:<version>

    Docker Hub からコマンドを直接コピーしなかった場合は、<version> 変数を YouTrack ビルドの完全なバージョン番号に置き換えます。

Docker コンテナーを実行する

前述のように、YouTrack がアプリケーションデータを保存するディレクトリを設定したら、コンテナーの実行に使用するコマンドの引数として、Docker コンテナー内のディレクトリへのマッピングを定義できます。

次のコマンドを使用して、YouTrack サービスのコンテナーを開始します。

docker run -it --name <youtrack-server-instance> \ -v <path to data directory>:/opt/youtrack/data \ -v <path to conf directory>:/opt/youtrack/conf \ -v <path to logs directory>:/opt/youtrack/logs \ -v <path to backups directory>:/opt/youtrack/backups \ -p <port on host>:8080 \ jetbrains/youtrack:<version>
docker run -it --name <youtrack-server-instance> ^ -v <path to data directory>:/opt/youtrack/data ^ -v <path to conf directory>:/opt/youtrack/conf ^ -v <path to logs directory>:/opt/youtrack/logs ^ -v <path to backups directory>:/opt/youtrack/backups ^ -p <port on host>:8080 ^ jetbrains/youtrack:<version>

このコマンドは、アプリケーションデータの保存に必要なボリュームを自動的に作成し、ホスト環境にプロビジョニングされたディレクトリにマップします。また、YouTrack サービスがサーバー上でデータを送受信するために使用するポートも指定します。

必要に応じて、次の情報を使用してこのコマンドをカスタマイズします。

  • -it は、コンテナーの入力と出力の両方をターミナルに接続するコマンドラインフラグです。これにより、コンテナーがターミナルで直接実行しているかのように、コンテナーによって生成された出力を確認できます。

    コンテナーが起動すると、初期化プロセス中に生成されたログメッセージも表示されます。

    ターミナルがコンテナーの出力に接続されているときに Ctrl + C を押すと、コンテナーの実行中のプロセスに割り込み信号が送信されます。これは、ターミナルで通常のプロセスを停止する方法と似ています。このコマンドによりコンテナーがシャットダウンされるため、このコンテキストで Ctrl + C を使用する場合は注意してください。

    コンテナー内で実行中のプロセスを中断せずにターミナルをコンテナー出力から切り離したい場合は、Ctrl + P を押してから Ctrl + Q を押します。

    詳細については、Docker の公式ドキュメント(英語)を参照してください。

  • --name youtrack-server-instance これはコンテナーの任意の名前です。

    デフォルトでは、Docker はコンテナーに対してランダムな、場合によっては不可解な名前を生成します。--name オプションを使用すると、コンテナーに、識別と管理が容易になる、より意味があり人間が判読できる名前を付けることができます。

  • -v <path to <name> directory>:/opt/youtrack/<name> これらのオプションは、ホストマシン上にプロビジョニングされたストレージの場所を指定し、コンテナー内の対応する /opt/youtrack/<name> ディレクトリにマップします。

  • ポートマッピングを定義する -p <port on host>:8080 パラメーター。これにより、ホストマシンは <port on host> ポートでトラフィックをリッスンし、すべてのトラフィックをコンテナー内のポート 8080 に伝播するように指示されます。

    リッスンポートは、エンドユーザーまたはリバースプロキシサーバー (使用中の場合) がアクセスできる必要があります。これには、ファイアウォールを介してこのポートへのアクセスを明示的に開くことが必要になる場合があります。

YouTrack サービスは Docker コンテナー内の {0.0.0.0:8080} で開始され、ポート 8080 は指定された <port on host> にマップされます。これにより、ホストマシンの <ポート on host> にネットワークアクセスできる任意のマシンからサービスにアクセスできるようになります。たとえば、ホストマシンの完全修飾ドメイン名 (FQDN) が host.mydomain.com で、<ポート on host> が 7777 の場合、サービスは http://host.mydomain.com:7777 で利用可能になります。

YouTrack の設定

この時点で、アプリケーションはデフォルト構成でインストールされます。YouTrack がサーバー環境で動作するように適切に設定されていることを確認するには、その構成を確認して微調整する必要があります。

最初の実行では、YouTrack サービスが Web ベースの構成ウィザードで開始されます。ウィザードには、サービスがホストされている Web アドレスからアクセスできます。

構成ウィザードはワンタイムアクセストークンで保護されており、Docker からのログ出力からコピーする必要があります。例:

JetBrains YouTrack 2023.1 Configuration Wizard will listen inside container on {0.0.0.0:8080}/ after start and can be accessed by URL [http://<put-your-docker-HOST-name-here>:<put-host-port-mapped-to-container-port-8080-here>//?wizard_token=FOT8QIzHuktzvxtiT1Ax]

前のセクションの例を使用すると、構成ウィザードは http://host.mydomain.com:7777//?wizard_token=FOT8QIzHuktzvxtiT1Ax から利用できます。

インストールを完了するには、Web ブラウザーで構成ウィザードの URL を開き、以下の手順に進みます。

新しい Docker インストールを構成するには、次の手順を実行する

  1. 構成ウィザードで、セットアップをクリックします。

    Docker installation: Configuration wizard
  2. 設定を確認ページで、基本的なシステム設定を確認または変更します。

    Docker installation: Settings basic

    ここで、組み込みの TLS を有効にするを使用してサーバーのネットワーク接続を保護することもできます。詳細な手順については、「インストール中に HTTPS を有効にする」を参照してください。

    設定

    説明

    HTTP | HTTPS

    組み込みの TLS を有効または無効にし、サーバーへの安全なネットワーク接続を構成できます。HTTPS を有効にすると、TLS 固有の設定が表示されます。

    Configuration wizard: HTTPS tab

    詳細は、TLS 設定を参照してください。

    ベース URL

    エンドユーザーが YouTrack サーバーにアクセスする URL。

    アプリケーション待機ポート

    インストール後に YouTrack サーバーサーバーがリッスンするポート。

    言語

    ユーザーインターフェースに表示されるデフォルトの言語。

  3. 詳細設定セクションを展開して、YouTrack サーバーが製品データを保存する場所を確認します。

    Docker installation: Advanced settings

    設定

    説明

    データディレクトリの場所

    YouTrack サーバーがコンテンツデータを保存するディレクトリ。

    バックアップの保存先

    YouTrack サーバーがデータベースのバックアップを保存するディレクトリ。

    ログの場所

    YouTrack サーバーがログファイルを保存するディレクトリ。

    一時ロケーション

    YouTrack サーバーが製品固有の一時ファイルを格納するディレクトリ。

    インストール中にこれらのディレクトリを作成したばかりであることを考えると、この時点で更新する必要はありません。

    これらのファイルの場所を変更する場合は、ホストされているマシン上のフォルダーとコンテナー内の YouTrack 固有のディレクトリ間のバインドを変更する必要があります。詳細については、「Change Database Location」を参照してください。

  4. 使用状況統計を JetBrains と共有するには、利用統計を匿名で送信するオプションを有効のままにしてください。この機能は、JetBrains が使用状況統計を追跡して、YouTrack サーバーを改善できます。当社は収集したデータをサードパーティーと共有することはありません。

  5. 完了したら、次へをクリックします。

  6. アクセスを構成するページで、次の設定を構成します。

    Hub settings for a ZIP installation.
    • デフォルトのシステム管理者アカウント admin のパスワードを入力して確認します。管理者アカウントに別のユーザー名を割り当てるには、管理者ユーザー名を作成する設定を編集します。

    • ゲストユーザーアカウントを禁止するには、ゲストとしてログインを有効にするオプションの選択を解除します。

  7. 完了したら、次へをクリックします。

  8. ライセンス確認ページで、ライセンス名とキーを確認します。

    Install http license
  9. 完了したら、完了をクリックします。

    • 構成は YouTrack サーバーサーバーに適用されます。

    セットアップが完了するまで、ブラウザーのページを閉じないでください。YouTrack Server サーバーの準備ができたら、次のようにします。

    • ゲストとしてログインするオプションをオフに切り替えた場合は、ログインページにリダイレクトされます。

    • ゲストとしてログインを有効にするオプションを有効にしたままにすると、ダッシュボードにリダイレクトされます。

以上です。YouTrack サーバーサービスがインストールされ、使用できるようになりました。

関連ページ:

サポートされる環境

このページでは YouTrack のハードウェアとソフトウェアの要件を説明しています。ハードウェア要件:YouTrack サーバーには、特定のハードウェア要件のセットはありません。これらの要件は、データベースのサイズと定期的に処理されるトランザクションの平均数によって異なります。次のガイドラインを使用して、サーバーの要件を見積もります。ストレージ平均して、YouTrack には約 5,000 件の課題を保存するために 1 GB のディスク容量が必要です。ただし、これは大まかな推定にすぎません。...

Web ベースの構成ウィザードで TLS を構成する

YouTrack では、組み込みの TLS を使用してネットワーク接続を保護できます。HTTPS モードは、構成ウィザードまたはコマンドラインから有効にできます。ただし、どの方法を選択しても、この手順は使用するディストリビューションタイプに依存しません。手順は基本的な手順とは別に説明されています。このページでは、構成ウィザードで HTTPS を有効にする手順について説明します。コマンドラインの詳細な手順については、コマンドラインから TLS を構成するを参照してください。構成ウィザードでビルトイ...

データベースの場所を変更する

YouTrack は、独自のインプロセスデータベースを使用します。デフォルトでは、データファイルはディレクトリに保存されます。YouTrack がデータを保存するデフォルトのディレクトリには、次のサブディレクトリが含まれます。YouTrack データベースが含まれています YouTrack インスタンスにビルトイン Hub が使用されたことがある場合、Hub サービスのデータベースが含まれます。他の内部製品データが含まれる場合があります既存のデータベースを新しい場所にコピーするときは、新しい場所が...

Docker コンテナーでアップグレードする

このページでは、Docker イメージを使用して YouTrack インストールをアップグレードするさまざまな方法について説明します。前提条件:アップグレードする前に、以下の前提条件タスクを実行してください。現在のデータベースのバックアップを作成します。YouTrack サーバーは、データベースの前方互換性を提供しません。データベースは、アップグレード手順中に最新バージョンと互換性のある形式に移行されます。これは、以前のバージョンに戻して、アップグレード中に処理されたデータベースを引き続き使用...