目的

Qiita上に和訳記事が見つからないため、Qt Installer Framework Manualを自分用に和訳します。

参照するバージョンは

Qt Installer Framework: Version 4.5.1
Qt 6.2.4

またデプロイ先は主にWindowsを想定しています。

Qt Installer Frameworkとは

Qt Installer FrameworkはQt Companyが提供している、Qtアプリケーション向けのカスタムインストーラー作成ツールです。
Qtアプリケーション以外のプロジェクトでも使用できます。一方でQtアプリケーションのインストーラを別のインストーラ作成ツールで作成することも可能です。
Qt本体と同様、コミュニティ版は無償で使用できますが、ライセンスが使用用途に合っているかは確認が必要です。

Overview of Qt Installer Framework

Qt Installer Frameworkは、インストーラーをデプロイするための一連のツールとユーティリティを提供します。
ソースコードを書き直す必要なく、サポートされているすべてのデスクトップQtプラットフォームに対して、１度にインストーラを作成、デプロイすることができます。
インストーラーは、実行されるプラットフォーム (Linux、Microsoft Windows、および macOS) ネイティブなルックアンドフィールを備えています。

インストーラーは、インストール、更新、またはアンインストール中にユーザーをガイドするページを含む他、インストール可能なコンテンツのリストを提供し、それに関する情報 (製品名、インストーラー、使用許諾契約のテキストなど) を提示します。

事前定義されたページにウィジェットを追加するか、ページ全体を追加してユーザーに追加のオプションを提供することにより、インストーラーをカスタマイズできます。またインストーラーに操作を追加するスクリプトを作成できます。

Choosing Installer Type

ユースケースに応じ、offlineまたはonlineのインストーラー、あるいはその両方を提供できます。
どちらのインストーラーも、後でコンポーネントの追加、更新、および削除に使用できるメンテナンスツールをインストールします。

onlineインストーラーは、Web サーバー上のオンラインリポジトリからコンポーネントをダウンロードしてインストールするメンテナンスツールのみをインストールします。したがって、onlineインストーラーのバイナリサイズは小さく、ダウンロード時間はofflineインストーラーよりも短くなります。
エンドユーザーが利用可能なすべてのコンポーネントをインストールしない場合、オンラインインストーラーのダウンロードと実行にかかる合計時間は、オフラインインストーラーのダウンロードと実行よりも短くなる可能性があります。
オンラインインストーラーを作成して、ユーザーが常に最新バージョンのコンテンツバイナリをインストールできるようにします。

offlineインストーラーには、インストール可能なすべてのコンポーネントが含まれており、インストール中にネットワーク接続を必要としません。
オフラインインストーラーを作成して、後でコンピューターにインストールするためにユーザーがインストールパッケージをメディアに直接ダウンロードできるようにします。たとえば、CD-ROMや USB スティックでインストールパッケージを配布することもできま

エンドユーザーは、メンテナンスツールを使用して、最初のインストール後にサーバーから追加のコンポーネントをインストールしたり、更新がサーバーに公開されるとすぐにコンテンツの自動更新を受信したりできます。
ただし、これがオフラインインストールで機能するのは、オフラインインストーラーの構成でリポジトリアドレスを指定した場合、またはエンドユーザーが保守ツールの設定でリポジトリアドレスを指定した場合のみです。

Promoting Updates

製品をインストールしたエンドユーザーにアップデートを促進するためには、オンラインリポジトリが利用できます。
アップデートを提供する最も簡単な方法は、リポジトリを再作成し、Web サーバーにアップロードすることです。大規模なリポジトリの場合、変更されたコンポーネントのみを更新することができます。

Providing Content for Installers

他のコンテンツプロバイダがアドオンコンポーネントとしてインストーラにコンポーネントを追加できるようにすることができます。コンポーネントプロバイダは、インストール可能なコンポーネントを含むリポジトリを設定し、リポジトリを指す URL をエンドユーザに配信する必要があります。エンドユーザーは、インストーラーでそのURLを設定する必要があります。アドオンコンポーネントは、パッケージマネージャで表示されます。

Getting Started

Qt Installer Framework は、Qt プロジェクトの一部として開発されています。フレームワーク自体は Qt を使用しています。ただし、Qt で構築されたアプリケーションを含む (ただしこれに限定されません) あらゆる種類のアプリケーションのインストールに使用できます。

Supported Platforms

デスクトップ Qt がサポートするすべてのプラットフォーム用のインストーラーを作成できます。
インストーラーは、次のプラットフォームでテストされています。

Microsoft Windows 7, and later
Ubuntu Linux 18.04, and later
macOS 10.13, and later

Building from Sources

次の手順では、Qt Installer Frameworkを自分でビルドする方法について説明します。フレームワークのビルド済みバージョンをダウンロードした場合は、これをスキップできます。

（訳注）Qt Installer Frameworkのinstallerは以下からダウンロードできる。

TBD

End User Workflows

エンドユーザーの使用感は、オフラインインストーラーとオンラインインストーラーで似ています。
インストーラは、アプリケーションと一緒に、パッケージマネージャ、アップデータ、およびアンインストーラで構成されるメンテナンスツールをインストールします。エンドユーザーは、メンテナンスツールを使用して、コンポーネントを追加、更新、および削除することができます。メンテナンスツールは、追加または更新するコンポーネントを取得するために、外部リポジトリに接続します。リポジトリは、設定ファイルで指定するか、エンドユーザーがメンテナンスツールの設定で指定することができます。

このセクションでは、初期インストール後にエンドユーザーがコンポーネントを追加する方法の実装例として、macOSで、Qt5インストーラーによりインストールされるメンテナンスツールを使用します。
インストーラーは、サポートされる各デスクトッププラットフォームのネイティブなルックアンドフィールを持つため、LinuxとWindowsで実行すると、見た目も使い勝手も違ってきます。

Initial Installation

次の図は、アプリケーションをインストールするためのデフォルトのワークフローを示しています。

サンプルプロジェクトは、Qt Installer Framework リポジトリの examples\tutorial ディレクトリに格納されています。アプリケーションインストーラーを作成するには、binarycreator ツールを使用できます。

Starting Installer
インストーラを起動すると、まず introductionページが開きます。
設定ファイルである config.xml で、インストーラー名とインストールする製品を指定します。
Continue を選択すると、次のページに進みます。
Selecting Target Directory
エンドユーザーは、インストール先のディレクトリを指定する必要があります。構成ファイル config.xml でデフォルト値を指定できます。
ディレクトリが既に存在する場合は、警告ダイアログを表示します。
Continue を選択すると、次のページに進みます。
Selecting Components
コンポーネント選択ページには、インストール可能なコンポーネントと各コンポーネントの簡単な説明が表示されます。エンドユーザーは、インストールするコンポーネントを選択します。
すべてのコンポーネントを選択する場合は Select All、コンポーネントの選択を解除する場合はDeselect All、デフォルトの選択状態に戻す場合はDefaultを選択します。

インストール可能なコンポーネントをパッケージディレクトリのデータディレクトリに追加します。コンポーネントに関する情報は、metaディレクトリの package.xml ファイルに指定します。

ブール演算子またはスクリプトを使用して、コンポーネントをデフォルトで選択するかどうかを指定できます。
Continue を選択すると、次のページに進みます。

Accepting License Agreements
ライセンスチェックページでは、エンドユーザーが使用許諾契約の条項に同意する必要があります。
package.xmlファイルでライセンスファイルを指定し、ファイルをメタディレクトリにコピーすると、ライセンスチェックページが表示されます。
Selecting Windows Program Group
Windowsでは、[スタートメニューディレクトリ選択ページ] により、エンドユーザーは Windowsスタートメニューで製品のプログラムグループを選択できます。
プログラムグループのデフォルト値は、config.xml構成ファイルで指定します。
Next を選択すると、次のページに進みます。
Installing Components
[インストールの準備完了] ページでは、ユーザーがinstallを選択するとインストールを開始できることがエンドユーザーに通知されます。
インストール中、インストールの実行ページに、インストールの進行状況に関する情報が表示されます。エンドユーザーは、Show Details を選択して詳細情報を表示できます。
インストールが完了すると、[インストール完了ページ]が開きます。

このページに、インストーラーを閉じたときにインストール済みの製品を起動するオプションを追加できます。起動する製品と表示するテキストを config.xml構成ファイルに指定します。

Adding Components

エンドユーザーが最初のインストール時にすべてのインストール可能なコンポーネントを選択しなかった場合、パッケージマネージャーを使用して、後でリポジトリから残りのコンポーネントをインストールできます。
パッケージマネージャーは、初期インストール時にアプリケーションと共にインストールされるメンテナンスツールの一部です。これは、コンポーネントを含むリポジトリがローカルまたは外部で利用できる場合にのみ機能します。

メンテナンスツールには、パッケージマネージャー、アップデーター、およびアンインストーラーが含まれています。

Starting Package Manager
Maintenance Toolを起動すると、まずintroductionページが開きます。
エンドユーザーが Package Manager を選択してから Continue を選択すると、コンポーネントの選択ページに進みます。
Selecting Additional Components
[コンポーネント選択ページ]には、インストール可能なコンポーネントと各コンポーネントのリストと簡単な説明が一覧表示されます。インストール済みのコンポーネントは選択されて表示されます。
エンドユーザーは、インストールする追加コンポーネントを選択します。また[リセット] を選択して、現在インストールされているコンポーネントを再度表示できます。

Continue を選択すると、次のページに進みます。

Installing Selected Components
[更新準備完了ページ]は、ユーザーが Update を選択すると、コンポーネントがインストールされたことをエンドユーザーに通知します。
[更新ページ]には、インストールの進行状況に関する情報が表示されます。エンドユーザーは、Show Details を選択して詳細情報を表示できます。

インストールが完了すると、[アップデート完了ページ]が開きます。

Removing Components

インストールされているコンポーネントのすべてまたは一部を削除するための既定のワークフローを示します。

Removing All Components
エンドユーザーが Maintenance Tool を起動すると、[紹介ページ]が開きます。

エンドユーザーは、[すべてのコンポーネントを削除] を選択してから [続行] を選択して、インストールされているすべてのコンポーネントを削除できます。
[アンインストールの準備完了] ページでは、ユーザーが [アンインストール] を選択するとアンインストールを開始できることがエンドユーザーに通知されます。

Removing Selected Components
エンドユーザーは、[パッケージマネージャー] を選択し、Continue を選択して、コンポーネント選択ページで削除するコンポーネントを選択できます。
エンドユーザーが削除するコンポーネントの選択を解除し、Continue を選択すると、更新の準備完了ページが開きます。ユーザーが Update を選択すると、コンポーネントの削除がエンドユーザーに通知されます。
更新ページには、削除の進行状況に関する情報が表示されます。エンドユーザーは、[詳細の表示] を選択して詳細情報を表示できます。

Tutorial: Creating an Installer

このチュートリアルでは、小さなプロジェクト用の単純なインストーラーを作成する方法について説明します。

このセクションでは、インストーラーを作成するために実行するために必要な以下のタスクについて説明します。

すべての構成ファイルとインストール可能なパッケージを含む、package directoryを作成します。
インストーラーバイナリとオンラインリポジトリのビルド方法に関する情報を含む、configuration fileを作成します。
インストール可能なコンポーネントに関する情報を含むpackage information fileを作成します。
インストーラーコンテンツを作成し、パッケージディレクトリにコピーします。
binarycreatorツールを使用してインストーラーを作成します。

インストーラーページは、構成およびパッケージ情報ファイルで指定した情報を使用して作成されます。

サンプルは、Qt Installer Frameworkリポジトリの examples\tutorial ディレクトリにあります。

Creating a Package Directory

インストーラーの設計を反映し、将来的にインストーラーを拡張できるようにするディレクトリ構造を作成します。ディレクトリには、config および packages と呼ばれるサブディレクトリが含まれている必要があります。

パッケージディレクトリに関する詳細は、Package Directoryを参照してください。

Creating a Configuration File

config ディレクトリに、次の内容の config.xml というファイルを作成します。

<?xml version="1.0" encoding="UTF-8"?>
<Installer>
    <Name>Your application</Name>
    <Version>1.0.0</Version>
    <Title>Your application Installer</Title>
    <Publisher>Your vendor</Publisher>
    <StartMenuDir>Super App</StartMenuDir>
    <TargetDir>@HomeDir@/InstallationDirectory</TargetDir>
</Installer>

構成ファイルは、[introductionページ]に表示される次の情報を指定します。

<Title> : タイトルバーに表示されるインストーラー名。
<Name> : ページ名と紹介テキストに追加されるアプリケーション名。

その他のelementはインストーラの動作をカスタマイズするために使用します。

<Version> : アプリケーションのバージョン番号
<Publisher> : ソフトウェアの発行者
- Windows Control Panelなどで表示される
<StartMenuDir> : Windows の [スタート] メニューに表示される製品の既定のプログラムグループの名前。
<TargetDir> : ユーザーに表示されるデフォルトのターゲットディレクトリが、現在のユーザーのホームディレクトリにある InstallationDirectory であることを示します (定義済みの変数 @HomeDir@ が値の一部として使用されるため)。
- 詳細については、Configuration Fileを参照してください。

Creating a Package Information File

この簡単なシナリオでは、インストーラは com.vendor.product という名前のコンポーネントを 1 つだけ扱います。
インストーラにコンポーネントに関する情報を提供するために、以下の内容でpackage.xmlというファイルを作成し、metaディレクトリに配置します。

<?xml version="1.0" encoding="UTF-8"?>
<Package>
    <DisplayName>Name of component</DisplayName>
    <Description>Component Description.</Description>
    <Version>0.1.0-1</Version>
    <ReleaseDate>2010-09-21</ReleaseDate>
    <Licenses>
        <License name="Beer Public License Agreement" file="license.txt" />
    </Licenses>
    <Default>script</Default>
    <Script>installscript.qs</Script>
    <UserInterfaces>
        <UserInterface>page.ui</UserInterface>
    </UserInterfaces>
</Package>

package.xmlの詳細については、Package Information File Syntaxを参照してください。

Specifying Component Information

コンポーネント選択ページには、次の要素からの情報が表示されます。

<DisplayName> 要素は、コンポーネントのリスト内のコンポーネントの名前を指定します (1)。
<Description> 要素は、コンポーネントが選択されたときに表示されるテキストを指定します (2)。

Specifying Installer Version

<Version> 要素を使用すると、更新プログラムが利用可能になったときに、その更新プログラムをユーザーに宣伝できます。

Adding Licenses

<License> 要素は、ライセンスチェックページに表示されるライセンス契約のテキストを含むファイルの名前を指定します。

Selecting Default Contents

<Default>要素は、デフォルトでコンポーネントが選択されているかどうかを指定します。値がtrueなら、コンポーネントはデフォルトで選択状態になります。この例では、実行時に値を解決するために、スクリプトを使用しています。
<Script>要素には、JavaScriptスクリプトファイル名installscript.qsを指定しています。

Creating Installer Content

インストールするコンテンツは、コンポーネントの data ディレクトリに格納されます。コンポーネントは1つだけなので、packages/com.vendor.product/dataディレクトリにデータを配置します。この例では、テスト用のファイルを既に置いていますが、基本的にどのようなファイルでも置くことができます。

パッケージ化のルールとオプションの詳細はData Directoryを参照してください。

Creating the Installer Binary

最初のインストーラを作成する準備ができました。
コマンドラインで examples\tutorial ディレクトリに切り替えます。com.vendor.product で識別されるパッケージを含む YourInstaller.exe というインストーラを作成するために、次のコマンドを入力します。

On Windows

..\..\bin\binarycreator.exe -c config\config.xml -p packages YourInstaller.exe

インストーラーは現在のディレクトリに作成され、エンドユーザーに配布できます。
binarycreator ツールの詳細は、binarycreatorを参照してください。

チュートリアルインストーラーの実行時にエラーメッセージが表示される場合は、静的にビルドされた Qt を使用してインストーラーを作成したことを確認してください。詳細については、「Qt の構成」を参照してください。

Qt Installer Framework Manualを和訳する

目的